org.datavec.api.transform.transform.integer

Class IntegerColumnsMathOpTransform

java.lang.Object

org.datavec.api.transform.transform.BaseColumnsMathOpTransform

org.datavec.api.transform.transform.integer.IntegerColumnsMathOpTransform

All Implemented Interfaces:

Serializable, ColumnOp, Transform

public class IntegerColumnsMathOpTransform
extends BaseColumnsMathOpTransform

Add a new integer column, calculated from one or more other columns. A new column (with the specified name) is added as the final column of the output. No other columns are modified.
For example, if newColumnName=="newCol", mathOp==MathOp.Add, and columns=={"col1","col2"}, then the output column with name "newCol" has value col1+col2.
NOTE: Division here is using integer division (integer output). Use DoubleColumnsMathOpTransform if a decimal output value is required.

Author:

Alex Black

See Also:

To do an in-place mathematical operation of an integer column and an integer scalar value, Serialized Form

Field Summary

Fields inherited from class org.datavec.api.transform.transform.BaseColumnsMathOpTransform

columns, mathOp, newColumnName

Constructor Summary

Constructors

Constructor and Description
IntegerColumnsMathOpTransform(String newColumnName, MathOp mathOp, String... columns)

Method Summary

Modifier and Type	Method and Description
protected ColumnMetaData	derivedColumnMetaData(String newColumnName, Schema inputSchema)
protected Writable	doOp(Writable... input)
Object	map(Object input) Transform an object in to another object
Object	mapSequence(Object sequence) Transform a sequence
String	toString()

Methods inherited from class org.datavec.api.transform.transform.BaseColumnsMathOpTransform

columnName, columnNames, getInputSchema, map, mapSequence, outputColumnName, outputColumnNames, setInputSchema, transform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegerColumnsMathOpTransform

public IntegerColumnsMathOpTransform(String newColumnName,
                                     MathOp mathOp,
                                     String... columns)

Parameters:

newColumnName - Name of the new column (output column)

mathOp - Mathematical operation. Only Add/Subtract/Multiply/Divide/Modulus is allowed here

columns - Columns to use in the mathematical operation

Method Detail

derivedColumnMetaData

protected ColumnMetaData derivedColumnMetaData(String newColumnName,
                                               Schema inputSchema)

Specified by:

derivedColumnMetaData in class BaseColumnsMathOpTransform

doOp

protected Writable doOp(Writable... input)

Specified by:

doOp in class BaseColumnsMathOpTransform

toString

public String toString()

Specified by:

toString in class BaseColumnsMathOpTransform

map

public Object map(Object input)

Transform an object in to another object

Parameters:

input - the record to transform

Returns:

the transformed writable

mapSequence

public Object mapSequence(Object sequence)

Transform a sequence

Parameters:

sequence -