org.datavec.api.transform.condition

Interface Condition

All Superinterfaces:

ColumnOp, Serializable

All Known Subinterfaces:

ColumnCondition

All Known Implementing Classes:

BaseColumnCondition, BooleanColumnCondition, BooleanCondition, CategoricalColumnCondition, DoubleColumnCondition, FloatColumnCondition, InfiniteColumnCondition, IntegerColumnCondition, InvalidValueColumnCondition, LongColumnCondition, NaNColumnCondition, NullWritableColumnCondition, SequenceLengthCondition, StringColumnCondition, StringRegexColumnCondition, TimeColumnCondition, TrivialColumnCondition

public interface Condition
extends Serializable, ColumnOp

The Condition interface defines a binary state that either holds/is satisfied for an example/sequence, or does not hold.
Example: number greater than x, String is one of {X,Y,Z}, etc.
Typical uses for conditions: filtering, conditional replacement, conditional reduction, etc

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
boolean	condition(List<Writable> list) Is the condition satisfied for the current input/example? Returns true if condition is satisfied, or false otherwise.
boolean	condition(Object input) Condition on arbitrary input
boolean	conditionSequence(List<List<Writable>> sequence) Is the condition satisfied for the current input/sequence? Returns true if condition is satisfied, or false otherwise.
boolean	conditionSequence(Object sequence) Condition on arbitrary input
Schema	getInputSchema() Getter for the input schema
void	setInputSchema(Schema schema) Setter for the input schema

Methods inherited from interface org.datavec.api.transform.ColumnOp

columnName, columnNames, outputColumnName, outputColumnNames, transform

Method Detail

condition

boolean condition(List<Writable> list)

Is the condition satisfied for the current input/example?
Returns true if condition is satisfied, or false otherwise.

Parameters:

list - Current example

Returns:

true if condition satisfied, false otherwise

condition

boolean condition(Object input)

Condition on arbitrary input

Parameters:

input - the input to return the condition for

Returns:

true if the condition is met false otherwise

conditionSequence

boolean conditionSequence(List<List<Writable>> sequence)

Is the condition satisfied for the current input/sequence?
Returns true if condition is satisfied, or false otherwise.

Parameters:

sequence - Current sequence

Returns:

true if condition satisfied, false otherwise

conditionSequence

boolean conditionSequence(Object sequence)

Condition on arbitrary input

Parameters:

sequence - the sequence to do a condition on

Returns:

true if the condition for the sequence is met false otherwise

setInputSchema

void setInputSchema(Schema schema)

Setter for the input schema

Specified by:

setInputSchema in interface ColumnOp

Parameters:

schema -

getInputSchema

Schema getInputSchema()

Getter for the input schema

Specified by:

getInputSchema in interface ColumnOp

Returns: