SequenceTrimToLengthTransform (deeplearning4j 1.0.0-beta6 API)

java.lang.Object
- org.datavec.api.transform.sequence.trim.SequenceTrimToLengthTransform

All Implemented Interfaces:

Serializable, ColumnOp, Transform
```
public class SequenceTrimToLengthTransform
extends Object
implements Transform
```
Trim or pad the sequence to the specified length (number of sequence steps). It supports 2 modes:
TRIM: Sequences longer than the specified maximum will be trimmed to exactly the maximum. Shorter sequences will not be modified.
TRIM_OR_PAD: Sequences longer than the specified maximum will be trimmed to exactly the maximum. Shorter sequences will be padded with as many copies of the "pad" array to make the sequence length equal the specified maximum.
Note that the 'pad' list (i.e., values to pad when using TRIM_OR_PAD mode) must be equal in length to the number of columns (values per time step)

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SequenceTrimToLengthTransform.Mode
Mode.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SequenceTrimToLengthTransform.Mode` Mode.

Constructor Summary

Constructors
Constructor and Description

SequenceTrimToLengthTransform(int maxLength, SequenceTrimToLengthTransform.Mode mode, List<Writable> pad)

Constructors
Constructor and Description
`SequenceTrimToLengthTransform(int maxLength, SequenceTrimToLengthTransform.Mode mode, List<Writable> pad)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`columnName()` Returns a singular column name this op is meant to run on
`String[]`	`columnNames()` Returns column names this op is meant to run on
`Schema`	`getInputSchema()` Getter for input schema
`List<Writable>`	`map(List<Writable> writables)` Transform a writable in to another writable
`Object`	`map(Object input)` Transform an object in to another object
`List<List<Writable>>`	`mapSequence(List<List<Writable>> sequence)` Transform a sequence
`Object`	`mapSequence(Object sequence)` Transform a sequence
`String`	`outputColumnName()` The output column name after the operation has been applied
`String[]`	`outputColumnNames()` The output column names This will often be the same as the input
`void`	`setInputSchema(Schema inputSchema)` Set the input schema.
`Schema`	`transform(Schema inputSchema)` Get the output schema for this transformation, given an input schema

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

- Constructor Detail
  - SequenceTrimToLengthTransform
```
public SequenceTrimToLengthTransform(int maxLength,
                                     SequenceTrimToLengthTransform.Mode mode,
                                     List<Writable> pad)
```
    Parameters:
    
    maxLength - maximum sequence length. Must be positive.
    
    mode - Mode - trim or trim/pad
    
    pad - Padding value. Only used with Mode.TRIM_OR_PAD. Must be equal in length to the number of columns (values per time step)
- Method Detail
  - map
```
public List<Writable> map(List<Writable> writables)
```
    Description copied from interface: Transform
    
    Transform a writable in to another writable
    
    Specified by:
    
    map in interface Transform
    
    Parameters:
    
    writables - the record to transform
    
    Returns:
    
    the transformed writable
  - mapSequence
```
public List<List<Writable>> mapSequence(List<List<Writable>> sequence)
```
    Description copied from interface: Transform
    
    Transform a sequence
    
    Specified by:
    
    mapSequence in interface Transform
  - map
```
public Object map(Object input)
```
    Description copied from interface: Transform
    
    Transform an object in to another object
    
    Specified by:
    
    map in interface Transform
    
    Parameters:
    
    input - the record to transform
    
    Returns:
    
    the transformed writable
  - mapSequence
```
public Object mapSequence(Object sequence)
```
    Description copied from interface: Transform
    
    Transform a sequence
    
    Specified by:
    
    mapSequence in interface Transform
  - transform
```
public Schema transform(Schema inputSchema)
```
    Description copied from interface: ColumnOp
    
    Get the output schema for this transformation, given an input schema
    
    Specified by:
    
    transform in interface ColumnOp
  - setInputSchema
```
public void setInputSchema(Schema inputSchema)
```
    Description copied from interface: ColumnOp
    
    Set the input schema.
    
    Specified by:
    
    setInputSchema in interface ColumnOp
  - getInputSchema
```
public Schema getInputSchema()
```
    Description copied from interface: ColumnOp
    
    Getter for input schema
    
    Specified by:
    
    getInputSchema in interface ColumnOp
    
    Returns:
  - outputColumnName
```
public String outputColumnName()
```
    Description copied from interface: ColumnOp
    
    The output column name after the operation has been applied
    
    Specified by:
    
    outputColumnName in interface ColumnOp
    
    Returns:
    
    the output column name
  - outputColumnNames
```
public String[] outputColumnNames()
```
    Description copied from interface: ColumnOp
    
    The output column names This will often be the same as the input
    
    Specified by:
    
    outputColumnNames in interface ColumnOp
    
    Returns:
    
    the output column names
  - columnNames
```
public String[] columnNames()
```
    Description copied from interface: ColumnOp
    
    Returns column names this op is meant to run on
    
    Specified by:
    
    columnNames in interface ColumnOp
    
    Returns:
  - columnName
```
public String columnName()
```
    Description copied from interface: ColumnOp
    
    Returns a singular column name this op is meant to run on
    
    Specified by:
    
    columnName in interface ColumnOp
    
    Returns:

Class SequenceTrimToLengthTransform

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SequenceTrimToLengthTransform

Method Detail

map

mapSequence

map

mapSequence

transform

setInputSchema

getInputSchema

outputColumnName

outputColumnNames

columnNames

columnName