VocabWord (deeplearning4j-nlp 0.0.3.2.1 API)

java.lang.Object
- org.deeplearning4j.models.word2vec.VocabWord

All Implemented Interfaces:

Serializable, Comparable<VocabWord>
```
public class VocabWord
extends Object
implements Comparable<VocabWord>, Serializable
```
Intermediate layers of the neural network

Author:

Adam Gibson

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String PARENT_NODE

Fields
Modifier and Type	Field and Description
`static String`	`PARENT_NODE`

Constructor Summary

Constructors
Constructor and Description

VocabWord()

VocabWord(double wordFrequency, String word)

Constructors
Constructor and Description
`VocabWord()`
`VocabWord(double wordFrequency, String word)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(VocabWord o)`
`boolean`	`equals(Object o)`
`int`	`getCodeLength()`
`int[]`	`getCodes()`
`int`	`getIndex()`
`double`	`getLearningRate(int index, double g)`
`VocabWord`	`getLeft()`
`int[]`	`getPoints()`
`VocabWord`	`getRight()`
`String`	`getWord()`
`double`	`getWordFrequency()`
`int`	`hashCode()`
`void`	`increment()`
`void`	`increment(int by)`
`static VocabWord`	`none()`
`VocabWord`	`read(DataInputStream dos)`
`void`	`setCodeLength(int codeLength)`
`void`	`setCodes(int[] codes)`
`void`	`setIndex(int index)`
`void`	`setLeft(VocabWord left)`
`void`	`setParent(VocabWord parent)`
`void`	`setPoints(int[] points)`
`void`	`setRight(VocabWord right)`
`void`	`setWord(String word)`
`String`	`toString()`
`void`	`write(DataOutputStream dos)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- PARENT_NODE
```
public static final String PARENT_NODE
```
  See Also:
  
  Constant Field Values

Constructor Detail

VocabWord

public VocabWord(double wordFrequency,
                 String word)

Parameters:: wordFrequency - count of the word

VocabWord
```
public VocabWord()
```

Method Detail

none
```
public static VocabWord none()
```

write

public void write(DataOutputStream dos)
           throws IOException

Throws:: IOException

read

public VocabWord read(DataInputStream dos)
               throws IOException

Throws:: IOException

getWord
```
public String getWord()
```

setWord
```
public void setWord(String word)
```

getCodes
```
public int[] getCodes()
```

setCodes
```
public void setCodes(int[] codes)
```

setParent

public void setParent(VocabWord parent)

getLeft
```
public VocabWord getLeft()
```

setLeft
```
public void setLeft(VocabWord left)
```

getRight
```
public VocabWord getRight()
```

setRight

public void setRight(VocabWord right)

increment
```
public void increment()
```

increment
```
public void increment(int by)
```

getIndex
```
public int getIndex()
```

setIndex
```
public void setIndex(int index)
```

getWordFrequency
```
public double getWordFrequency()
```

compareTo
```
public int compareTo(VocabWord o)
```
Specified by:

compareTo in interface Comparable<VocabWord>

getLearningRate

public double getLearningRate(int index,
                              double g)

getPoints
```
public int[] getPoints()
```

setPoints
```
public void setPoints(int[] points)
```

getCodeLength
```
public int getCodeLength()
```

setCodeLength

public void setCodeLength(int codeLength)

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class VocabWord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARENT_NODE

Constructor Detail

VocabWord

VocabWord

Method Detail

none

write

read

getWord

setWord

getCodes

setCodes

setParent

getLeft

setLeft

getRight

setRight

increment

increment

getIndex

setIndex

getWordFrequency

compareTo

getLearningRate

getPoints

setPoints

getCodeLength

setCodeLength

toString

equals

hashCode