Sequence

java.lang.Object
- org.deeplearning4j.models.sequencevectors.sequence.Sequence<T>

All Implemented Interfaces:

java.io.Serializable
```
public class Sequence<T extends SequenceElement>
extends java.lang.Object
implements java.io.Serializable
```
Sequence for SequenceVectors is defined as limited set of SequenceElements. It can also contain label, if you're going to learn Sequence features as well.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<T>`	`elements`
`protected java.util.Map<java.lang.String,T>`	`elementsMap`
`protected int`	`hash`
`protected boolean`	`hashCached`
`protected T`	`label`
`protected java.util.List<T>`	`labels`
`protected int`	`sequenceId`

Constructor Summary

Constructors
Constructor and Description

Sequence()
Creates new empty sequence

Sequence(java.util.Collection<T> set)
Creates new sequence from collection of elements

Constructors
Constructor and Description
`Sequence()` Creates new empty sequence
`Sequence(java.util.Collection<T> set)` Creates new sequence from collection of elements

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addElement(T element)` Adds single element to sequence
`void`	`addElements(java.util.Collection<T> set)` Adds collection of elements to the sequence
`void`	`addSequenceLabel(T label)` Adds sequence label.
`java.util.List<java.lang.String>`	`asLabels()` Returns this sequence as list of labels
`boolean`	`equals(java.lang.Object o)`
`T`	`getElementByIndex(int index)` This method returns sequence element by index
`T`	`getElementByLabel(java.lang.String label)` Returns single element out of this sequence by its label
`java.util.List<T>`	`getElements()` Returns an ordered unmodifiable list of elements from this sequence
`T`	`getSequenceLabel()` Returns label for this sequence
`java.util.List<T>`	`getSequenceLabels()` Returns all labels for this sequence
`int`	`hashCode()`
`boolean`	`isEmpty()` Checks, if sequence is empty
`void`	`setSequenceLabel(T label)` Set sequence label
`void`	`setSequenceLabels(java.util.List<T> labels)` Sets sequence labels
`int`	`size()` This method returns number of elements in this sequence

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

- Field Detail
  - elements
```
protected java.util.List<T extends SequenceElement> elements
```
  - elementsMap
```
protected java.util.Map<java.lang.String,T extends SequenceElement> elementsMap
```
  - labels
```
protected java.util.List<T extends SequenceElement> labels
```
  - label
```
protected T extends SequenceElement label
```
  - hash
```
protected int hash
```
  - hashCached
```
protected boolean hashCached
```
  - sequenceId
```
protected int sequenceId
```
- Constructor Detail
  - Sequence
```
public Sequence()
```
    Creates new empty sequence
  - Sequence
```
public Sequence(@NonNull
                java.util.Collection<T> set)
```
    Creates new sequence from collection of elements
    
    Parameters:
    
    set -
- Method Detail
  - addElement
```
public void addElement(@NonNull
                       T element)
```
    Adds single element to sequence
    
    Parameters:
    
    element -
  - addElements
```
public void addElements(java.util.Collection<T> set)
```
    Adds collection of elements to the sequence
    
    Parameters:
    
    set -
  - asLabels
```
public java.util.List<java.lang.String> asLabels()
```
    Returns this sequence as list of labels
    
    Returns:
  - getElementByLabel
```
public T getElementByLabel(@NonNull
                           java.lang.String label)
```
    Returns single element out of this sequence by its label
    
    Parameters:
    
    label -
    
    Returns:
  - getElements
```
public java.util.List<T> getElements()
```
    Returns an ordered unmodifiable list of elements from this sequence
    
    Returns:
  - getSequenceLabel
```
public T getSequenceLabel()
```
    Returns label for this sequence
    
    Returns:
    
    label for this sequence, null if label was not defined
  - getSequenceLabels
```
public java.util.List<T> getSequenceLabels()
```
    Returns all labels for this sequence
    
    Returns:
  - setSequenceLabels
```
public void setSequenceLabels(java.util.List<T> labels)
```
    Sets sequence labels
    
    Parameters:
    
    labels -
  - setSequenceLabel
```
public void setSequenceLabel(@NonNull
                             T label)
```
    Set sequence label
    
    Parameters:
    
    label -
  - addSequenceLabel
```
public void addSequenceLabel(@NonNull
                             T label)
```
    Adds sequence label. In this case sequence will have multiple labels
    
    Parameters:
    
    label -
  - isEmpty
```
public boolean isEmpty()
```
    Checks, if sequence is empty
    
    Returns:
    
    TRUE if empty, FALSE otherwise
  - size
```
public int size()
```
    This method returns number of elements in this sequence
    
    Returns:
  - getElementByIndex
```
public T getElementByIndex(int index)
```
    This method returns sequence element by index
    
    Parameters:
    
    index -
    
    Returns:
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Sequence<T extends SequenceElement>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elements

elementsMap

labels

label

hash

hashCached

sequenceId

Constructor Detail

Sequence

Sequence

Method Detail

addElement

addElements

asLabels

getElementByLabel

getElements

getSequenceLabel

getSequenceLabels

setSequenceLabels

setSequenceLabel

addSequenceLabel

isEmpty

size

getElementByIndex

equals

hashCode