org.deeplearning4j.models.sequencevectors.sequence

Class Sequence<T extends SequenceElement>

java.lang.Object

org.deeplearning4j.models.sequencevectors.sequence.Sequence<T>

All Implemented Interfaces:

Serializable

public class Sequence<T extends SequenceElement>
extends Object
implements 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.

Author:

[email protected]

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<T>	elements
protected Map<String,T>	elementsMap
protected int	hash
protected boolean	hashCached
protected T	label
protected List<T>	labels
protected int	sequenceId

Constructor Summary

Constructors

Constructor and Description
Sequence() Creates new empty sequence
Sequence(Collection<T> set) Creates new sequence from collection of elements

Method Summary

Modifier and Type	Method and Description
void	addElement(T element) Adds single element to sequence
void	addElements(Collection<T> set) Adds collection of elements to the sequence
void	addSequenceLabel(T label) Adds sequence label.
List<String>	asLabels() Returns this sequence as list of labels
boolean	equals(Object o)
T	getElementByIndex(int index) This method returns sequence element by index
T	getElementByLabel(String label) Returns single element out of this sequence by its label
List<T>	getElements() Returns an ordered unmodifiable list of elements from this sequence
T	getSequenceLabel() Returns label for this sequence
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(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 List<T extends SequenceElement> elements

elementsMap

protected Map<String,T extends SequenceElement> elementsMap

labels

protected 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
                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(Collection<T> set)

Adds collection of elements to the sequence

Parameters:

set -

asLabels

public List<String> asLabels()

Returns this sequence as list of labels

Returns:

getElementByLabel

public T getElementByLabel(@NonNull
                           String label)

Returns single element out of this sequence by its label

Parameters:

label -

Returns:

getElements

public 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 List<T> getSequenceLabels()

Returns all labels for this sequence

Returns:

setSequenceLabels

public void setSequenceLabels(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(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object