SequenceElement (deeplearning4j-nlp 0.4-rc3.8 API)

java.lang.Object
- org.deeplearning4j.models.sequencevectors.sequence.SequenceElement

All Implemented Interfaces:

Serializable, Comparable<SequenceElement>

Direct Known Subclasses:

VocabWord
```
public abstract class SequenceElement
extends Object
implements Comparable<SequenceElement>, Serializable
```
SequenceElement is basic building block for SequenceVectors. Any data sequence can be represented as ordered set of SequenceElements, and then one can learn distributed representation of each SequenceElement in this sequence using CBOW or SkipGram.

Author:

[email protected]

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`codeLength`
`protected List<Integer>`	`codes`
`protected com.google.common.util.concurrent.AtomicDouble`	`elementFrequency`
`protected org.nd4j.linalg.api.ndarray.INDArray`	`historicalGradient`
`protected int`	`index`
`protected List<Integer>`	`points`
`protected boolean`	`special`
`protected Long`	`storageId`

Constructor Summary

Constructors
Constructor and Description

SequenceElement()

Constructors
Constructor and Description
`SequenceElement()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(SequenceElement o)`
`boolean`	`equals(Object object)` Equals method override should be properly implemented for any extended class, otherwise it will be based on label equality
`int`	`getCodeLength()` Returns Huffman code length.
`List<Integer>`	`getCodes()` Returns Huffman tree codes
`double`	`getElementFrequency()` This method returns SequenceElement's frequency in current training corpus.
`double`	`getGradient(int index, double g)`
`int`	`getIndex()` Returns index in Huffman tree
`abstract String`	`getLabel()` This method should return string representation of this SequenceElement, so it can be used for
`List<Integer>`	`getPoints()` Returns Huffman tree points
`int`	`hashCode()` hashCode method override should be properly implemented for any extended class, otherwise it will be based on label hashCode
`void`	`increaseElementFrequency(int by)` Increases element frequency counter by argument
`void`	`incrementElementFrequency()` Increases element frequency counter by 1
`void`	`setCodeLength(int codeLength)` This method fills codes and points up to codeLength
`void`	`setCodes(List<Integer> codes)` Sets Huffman tree codes
`void`	`setElementFrequency(long value)` This method sets frequency value for this element
`void`	`setIndex(int index)` Sets index in Huffman tree
`void`	`setPoints(List<Integer> points)` Sets Huffman tree points
`abstract String`	`toJSON()`
`String`	`toString()`

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

- Field Detail
  - elementFrequency
```
protected com.google.common.util.concurrent.AtomicDouble elementFrequency
```
  - index
```
protected int index
```
  - codes
```
protected List<Integer> codes
```
  - historicalGradient
```
protected org.nd4j.linalg.api.ndarray.INDArray historicalGradient
```
  - points
```
protected List<Integer> points
```
  - codeLength
```
protected int codeLength
```
  - special
```
protected boolean special
```
  - storageId
```
protected Long storageId
```
- Constructor Detail
  - SequenceElement
```
public SequenceElement()
```
- Method Detail
  - getLabel
```
public abstract String getLabel()
```
    This method should return string representation of this SequenceElement, so it can be used for
    
    Returns:
  - getElementFrequency
```
public double getElementFrequency()
```
    This method returns SequenceElement's frequency in current training corpus.
    
    Returns:
  - setElementFrequency
```
public void setElementFrequency(long value)
```
    This method sets frequency value for this element
    
    Parameters:
    
    value -
  - incrementElementFrequency
```
public void incrementElementFrequency()
```
    Increases element frequency counter by 1
  - increaseElementFrequency
```
public void increaseElementFrequency(int by)
```
    Increases element frequency counter by argument
    
    Parameters:
    
    by -
  - equals
```
public boolean equals(Object object)
```
    Equals method override should be properly implemented for any extended class, otherwise it will be based on label equality
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object -
    
    Returns:
  - getIndex
```
public int getIndex()
```
    Returns index in Huffman tree
    
    Returns:
    
    index >= 0, if tree was built, -1 otherwise
  - setIndex
```
public void setIndex(int index)
```
    Sets index in Huffman tree
    
    Parameters:
    
    index -
  - getCodes
```
public List<Integer> getCodes()
```
    Returns Huffman tree codes
    
    Returns:
  - setCodes
```
public void setCodes(List<Integer> codes)
```
    Sets Huffman tree codes
    
    Parameters:
    
    codes -
  - getPoints
```
public List<Integer> getPoints()
```
    Returns Huffman tree points
    
    Returns:
  - setPoints
```
public void setPoints(List<Integer> points)
```
    Sets Huffman tree points
    
    Parameters:
    
    points -
  - getCodeLength
```
public int getCodeLength()
```
    Returns Huffman code length. Please note: maximum vocabulary/tree size depends on code length
    
    Returns:
  - setCodeLength
```
public void setCodeLength(int codeLength)
```
    This method fills codes and points up to codeLength
    
    Parameters:
    
    codeLength -
  - getGradient
```
public double getGradient(int index,
                          double g)
```
  - hashCode
```
public int hashCode()
```
    hashCode method override should be properly implemented for any extended class, otherwise it will be based on label hashCode
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode for this SequenceElement
  - compareTo
```
public int compareTo(SequenceElement o)
```
    Specified by:
    
    compareTo in interface Comparable<SequenceElement>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toJSON
```
public abstract String toJSON()
```
    Returns:

Class SequenceElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elementFrequency

index

codes

historicalGradient

points

codeLength

special

storageId

Constructor Detail

SequenceElement

Method Detail

getLabel

getElementFrequency

setElementFrequency

incrementElementFrequency

increaseElementFrequency

equals

getIndex

setIndex

getCodes

setCodes

getPoints

setPoints

getCodeLength

setCodeLength

getGradient

hashCode

compareTo

toString

toJSON