VocabWord (deeplearning4j-nlp 0.0.3.3 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

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()`
`List<Integer>`	`getCodes()`
`double`	`getGradient(int index, double g)`
`int`	`getIndex()`
`List<Integer>`	`getPoints()`
`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(List<Integer> codes)`
`void`	`setIndex(int index)`
`void`	`setPoints(List<Integer> points)`
`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

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)
```

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

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

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

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

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

getCodes
```
public List<Integer> getCodes()
```

setCodes

public void setCodes(List<Integer> codes)

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

compareTo in interface Comparable<VocabWord>

getGradient

public double getGradient(int index,
                          double g)

getPoints
```
public List<Integer> getPoints()
```

setPoints

public void setPoints(List<Integer> points)

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

setCodeLength

public void setCodeLength(int codeLength)

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

equals in class Object

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

hashCode in class Object

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

toString in class Object

Class VocabWord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VocabWord

VocabWord

Method Detail

none

write

read

getWord

setWord

increment

increment

getIndex

setIndex

getWordFrequency

getCodes

setCodes

compareTo

getGradient

getPoints

setPoints

getCodeLength

setCodeLength

equals

hashCode

toString