SequenceElement

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SequenceElement>

Direct Known Subclasses:

ShallowSequenceElement, VocabWord
```
public abstract class SequenceElement
extends java.lang.Object
implements java.lang.Comparable<SequenceElement>, java.io.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.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected short`	`codeLength`
`protected java.util.List<java.lang.Byte>`	`codes`
`protected com.google.common.util.concurrent.AtomicDouble`	`elementFrequency`
`protected int`	`index`
`protected boolean`	`init`
`protected boolean`	`isLabel`
`protected java.util.List<java.lang.Integer>`	`points`
`protected java.util.concurrent.atomic.AtomicLong`	`sequencesCount`
`protected boolean`	`special`
`protected java.lang.Long`	`storageId`

Constructor Summary

Constructors
Constructor and Description

SequenceElement()

Constructors
Constructor and Description
`SequenceElement()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(SequenceElement o)`
`boolean`	`equals(java.lang.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.
`java.util.List<java.lang.Byte>`	`getCodes()` Returns Huffman tree codes
`double`	`getElementFrequency()` This method returns SequenceElement's frequency in current training corpus.
`double`	`getGradient(int index, double g, double lr)` Deprecated.
`org.nd4j.linalg.api.ndarray.INDArray`	`getHistoricalGradient()` Deprecated.
`int`	`getIndex()` Returns index in Huffman tree
`abstract java.lang.String`	`getLabel()` This method should return string representation of this SequenceElement, so it can be used for
`static long`	`getLongHash(java.lang.String string)`
`java.util.List<java.lang.Integer>`	`getPoints()` Returns Huffman tree points
`long`	`getSequencesCount()` This method returns number of documents/sequences where this element was evidenced
`java.lang.Long`	`getStorageId()`
`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`	`incrementSequencesCount()` Increments document count by one
`void`	`incrementSequencesCount(long count)` Increments document count by specified value
`boolean`	`isLabel()` Returns whether this element was defined as label, or no
`static org.nd4j.shade.jackson.databind.ObjectMapper`	`mapper()`
`void`	`markAsLabel(boolean isLabel)` This method specifies, whether this element should be treated as label for some sequence/document or not.
`void`	`setCodeLength(short codeLength)` This method fills codes and points up to codeLength
`void`	`setCodes(java.util.List<java.lang.Byte> codes)` Sets Huffman tree codes
`void`	`setElementFrequency(long value)` This method sets frequency value for this element
`void`	`setHistoricalGradient(org.nd4j.linalg.api.ndarray.INDArray gradient)` Deprecated.
`void`	`setIndex(int index)` Sets index in Huffman tree
`void`	`setPoints(int[] points)` Sets Huffman tree points
`void`	`setPoints(java.util.List<java.lang.Integer> points)` Sets Huffman tree points
`void`	`setSequencesCount(long count)` This method sets documents count to specified value
`abstract java.lang.String`	`toJSON()`
`java.lang.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 java.util.List<java.lang.Byte> codes
```
  - points
```
protected java.util.List<java.lang.Integer> points
```
  - codeLength
```
protected short codeLength
```
  - special
```
protected boolean special
```
  - isLabel
```
protected boolean isLabel
```
  - sequencesCount
```
protected java.util.concurrent.atomic.AtomicLong sequencesCount
```
  - init
```
protected boolean init
```
  - storageId
```
protected java.lang.Long storageId
```
- Constructor Detail
  - SequenceElement
```
public SequenceElement()
```
- Method Detail
  - getLabel
```
public abstract java.lang.String getLabel()
```
    This method should return string representation of this SequenceElement, so it can be used for
    
    Returns:
  - getSequencesCount
```
public long getSequencesCount()
```
    This method returns number of documents/sequences where this element was evidenced
    
    Returns:
  - setSequencesCount
```
public void setSequencesCount(long count)
```
    This method sets documents count to specified value
    
    Parameters:
    
    count -
  - incrementSequencesCount
```
public void incrementSequencesCount()
```
    Increments document count by one
  - incrementSequencesCount
```
public void incrementSequencesCount(long count)
```
    Increments document count by specified value
    
    Parameters:
    
    count -
  - isLabel
```
public boolean isLabel()
```
    Returns whether this element was defined as label, or no
    
    Returns:
  - markAsLabel
```
public void markAsLabel(boolean isLabel)
```
    This method specifies, whether this element should be treated as label for some sequence/document or not.
    
    Parameters:
    
    isLabel -
  - 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(java.lang.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 java.lang.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 java.util.List<java.lang.Byte> getCodes()
```
    Returns Huffman tree codes
    
    Returns:
  - setCodes
```
public void setCodes(java.util.List<java.lang.Byte> codes)
```
    Sets Huffman tree codes
    
    Parameters:
    
    codes -
  - getPoints
```
public java.util.List<java.lang.Integer> getPoints()
```
    Returns Huffman tree points
    
    Returns:
  - setPoints
```
public void setPoints(java.util.List<java.lang.Integer> points)
```
    Sets Huffman tree points
    
    Parameters:
    
    points -
  - setPoints
```
public void setPoints(int[] 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(short codeLength)
```
    This method fills codes and points up to codeLength
    
    Parameters:
    
    codeLength -
  - getLongHash
```
public static final long getLongHash(@NonNull
                                     java.lang.String string)
```
  - getGradient
```
@Deprecated
public double getGradient(int index,
                                      double g,
                                      double lr)
```
    Deprecated.
    
    Returns gradient for this specific element, at specific position
    
    Parameters:
    
    index -
    
    g -
    
    lr -
    
    Returns:
  - setHistoricalGradient
```
@Deprecated
public void setHistoricalGradient(org.nd4j.linalg.api.ndarray.INDArray gradient)
```
    Deprecated.
  - getHistoricalGradient
```
@Deprecated
public org.nd4j.linalg.api.ndarray.INDArray getHistoricalGradient()
```
    Deprecated.
  - 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 java.lang.Object
    
    Returns:
    
    hashCode for this SequenceElement
  - compareTo
```
public int compareTo(SequenceElement o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<SequenceElement>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toJSON
```
public abstract java.lang.String toJSON()
```
    Returns:
  - getStorageId
```
public java.lang.Long getStorageId()
```
  - mapper
```
public static org.nd4j.shade.jackson.databind.ObjectMapper mapper()
```

Class SequenceElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elementFrequency

index

codes

points

codeLength

special

isLabel

sequencesCount

init

storageId

Constructor Detail

SequenceElement

Method Detail

getLabel

getSequencesCount

setSequencesCount

incrementSequencesCount

incrementSequencesCount

isLabel

markAsLabel

getElementFrequency

setElementFrequency

incrementElementFrequency

increaseElementFrequency

equals

getIndex

setIndex

getCodes

setCodes

getPoints

setPoints

setPoints

getCodeLength

setCodeLength

getLongHash

getGradient

setHistoricalGradient

getHistoricalGradient

hashCode

compareTo

toString

toJSON

getStorageId

mapper