org.datavec.api.transform.rank

Class CalculateSortedRank

java.lang.Object

org.datavec.api.transform.rank.CalculateSortedRank

All Implemented Interfaces:

Serializable, ColumnOp

public class CalculateSortedRank
extends Object
implements Serializable, ColumnOp

CalculateSortedRank: calculate the rank of each example, after sorting example. For example, we might have some numerical "score" column, and we want to know for the rank (sort order) for each example, according to that column.
The rank of each example (after sorting) will be added in a new Long column. Indexing is done from 0; examples will have values 0 to dataSetSize - 1.
Currently, CalculateSortedRank can only be applied on standard (i.e., non-sequence) data. Furthermore, the current implementation can only sort on one column

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CalculateSortedRank(String newColumnName, String sortOnColumn, WritableComparator comparator)
CalculateSortedRank(String newColumnName, String sortOnColumn, WritableComparator comparator, boolean ascending)

Method Summary

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
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 schema) Set the input schema.
String	toString()
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, wait, wait, wait

Constructor Detail

CalculateSortedRank

public CalculateSortedRank(String newColumnName,
                           String sortOnColumn,
                           WritableComparator comparator)

Parameters:

newColumnName - Name of the new column (will contain the rank for each example)

sortOnColumn - Name of the column to sort on

comparator - Comparator used to sort examples

CalculateSortedRank

public CalculateSortedRank(String newColumnName,
                           String sortOnColumn,
                           WritableComparator comparator,
                           boolean ascending)

Parameters:

newColumnName - Name of the new column (will contain the rank for each example)

sortOnColumn - Name of the column to sort on

comparator - Comparator used to sort examples

ascending - Whether examples should be ascending or descending, using the comparator

Method Detail

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 schema)

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()

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()

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()

Returns column names this op is meant to run on

Specified by:

columnNames in interface ColumnOp

Returns:

columnName

public String columnName()

Returns a singular column name this op is meant to run on

Specified by:

columnName in interface ColumnOp

Returns:

toString

public String toString()

Overrides:

toString in class Object