Package com.linkedin.feathr.common.tensorbuilder

Class UniversalTensorBuilder

java.lang.Object

com.linkedin.feathr.common.ColumnUtils

com.linkedin.feathr.common.tensorbuilder.UniversalTensorBuilder

All Implemented Interfaces:

WriteableTuple<UniversalTensorBuilder>, TensorBuilder<UniversalTensorBuilder>, TypedOperator

public final class UniversalTensorBuilder
extends ColumnUtils
implements TensorBuilder<UniversalTensorBuilder>

Builds tensors with columns being a requested permutation of int, long, and float. Am instance of UniversalTensorBuilder can be reused by calling start method.

Field Summary

Fields inherited from class com.linkedin.feathr.common.ColumnUtils

_booleanArity, _bytesArity, _columnIndex, _columnTypes, _doubleArity, _floatArity, _intArity, _longArity, _stringArity

Constructor Summary

Constructors

Constructor	Description
UniversalTensorBuilder(int valueArity, Representable... columnTypes)
UniversalTensorBuilder(Representable... columnTypes)

Method Summary

Modifier and Type	Method	Description
UniversalTensorBuilder	append()	Tells this TensorBuilder that the current row is complete.
TensorData	build(boolean sort)	Build the tensor
Representable[]	getOutputTypes()
Representable[]	getTypes()
UniversalTensorBuilder	setBoolean(int index, boolean value)	Sets the specified column to a given `boolean`
UniversalTensorBuilder	setBytes(int index, byte[] value)	Sets the specified column to a given `byte array`
UniversalTensorBuilder	setDouble(int index, double value)	Sets the specified column to a given `double`
UniversalTensorBuilder	setFloat(int index, float value)	Sets the specified column to a given `float`
UniversalTensorBuilder	setInt(int index, int value)	Sets the specified column to a given `int`
UniversalTensorBuilder	setLong(int index, long value)	Sets the specified column to a given `long`
UniversalTensorBuilder	setString(int index, String value)	Sets the specified column to a given `String`
UniversalTensorBuilder	start(int estimatedRows)	Initializes this TensorBuilder.

Methods inherited from class com.linkedin.feathr.common.ColumnUtils

getBooleanArity, getBytesArity, getColumnIndex, getColumnTypes, getDimArity, getDoubleArity, getFloatArity, getIntArity, getLongArity, getStringArity

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.feathr.common.tensorbuilder.TensorBuilder

build, copyColumn, copyColumns, copyColumns, copyColumns, copyLeftColumns, start

Methods inherited from interface com.linkedin.feathr.common.tensor.WriteableTuple

setValue

Constructor Details

UniversalTensorBuilder

public UniversalTensorBuilder(Representable... columnTypes)

UniversalTensorBuilder

public UniversalTensorBuilder(int valueArity,
 Representable... columnTypes)

Method Details

start

public UniversalTensorBuilder start(int estimatedRows)

Description copied from interface: TensorBuilder

Initializes this TensorBuilder. This method (or overloaded TensorBuilder.start() MUST be called before setting values to this TensorBuilder. This method may also be used to "reset" the builder, enabling it to be reused.

Specified by:

start in interface TensorBuilder<UniversalTensorBuilder>

Parameters:

estimatedRows - The estimated number of rows in this tensor. Implementations can use this to allocate internal array sizes, for example.

Returns:

a reference to this TensorBuilder (`this`)

setInt

public UniversalTensorBuilder setInt(int index,
 int value)

Description copied from interface: WriteableTuple

Sets the specified column to a given `int`

Specified by:

setInt in interface WriteableTuple<UniversalTensorBuilder>

Parameters:

index - The column in the tuple to write to

value - The int value to be written

Returns:

A reference to this object (`this`)

setLong

public UniversalTensorBuilder setLong(int index,
 long value)

Description copied from interface: WriteableTuple

Sets the specified column to a given `long`

Specified by:

setLong in interface WriteableTuple<UniversalTensorBuilder>

Parameters:

index - The column in the tuple to write to

value - The long value to be written

Returns:

A reference to this object (`this`)

setString

public UniversalTensorBuilder setString(int index,
 String value)

Description copied from interface: WriteableTuple

Sets the specified column to a given `String`

Specified by:

setString in interface TensorBuilder<UniversalTensorBuilder>

Specified by:

setString in interface WriteableTuple<UniversalTensorBuilder>

Parameters:

index - The column in the tuple to write to

value - The String value to be written

Returns:

A reference to this object (`this`)

setFloat

public UniversalTensorBuilder setFloat(int index,
 float value)

Description copied from interface: WriteableTuple

Sets the specified column to a given `float`

Specified by:

setFloat in interface WriteableTuple<UniversalTensorBuilder>

Parameters:

index - The column in the tuple to write to

value - The float value to be written

Returns:

A reference to this object (`this`)

setDouble

public UniversalTensorBuilder setDouble(int index,
 double value)

Description copied from interface: WriteableTuple

Sets the specified column to a given `double`

Specified by:

setDouble in interface TensorBuilder<UniversalTensorBuilder>

Specified by:

setDouble in interface WriteableTuple<UniversalTensorBuilder>

Parameters:

index - The column in the tuple to write to

value - The double value to be written

Returns:

A reference to this object (`this`)

setBoolean

public UniversalTensorBuilder setBoolean(int index,
 boolean value)

Description copied from interface: WriteableTuple

Sets the specified column to a given `boolean`

Specified by:

setBoolean in interface TensorBuilder<UniversalTensorBuilder>

Specified by:

setBoolean in interface WriteableTuple<UniversalTensorBuilder>

Parameters:

index - The column in the tuple to write to

value - The double value to be written

Returns:

A reference to this object (`this`)

setBytes

public UniversalTensorBuilder setBytes(int index,
 byte[] value)

Description copied from interface: WriteableTuple

Sets the specified column to a given `byte array`

Specified by:

setBytes in interface WriteableTuple<UniversalTensorBuilder>

Parameters:

index - The column in the tuple to write to

value - The byte array value to be written

Returns:

A reference to this object (`this`)

append

public UniversalTensorBuilder append()

Description copied from interface: TensorBuilder

Tells this TensorBuilder that the current row is complete. This method MUST be called after using WriteableTuple.setInt(int, int), WriteableTuple.setFloat(int, float), etc. to set all the columns of the current row.

Specified by:

append in interface TensorBuilder<UniversalTensorBuilder>

Returns:

a reference to this TensorBuilder (`this`)

getTypes

public Representable[] getTypes()

Specified by:

getTypes in interface WriteableTuple<UniversalTensorBuilder>

Returns:

the types of all dimensions and the value as a single array.

build

public TensorData build(boolean sort)

Description copied from interface: TensorBuilder

Build the tensor

Specified by:

build in interface TensorBuilder<UniversalTensorBuilder>

Parameters:

sort - if set to true, the built tensor's rows will be sorted lexicographically

Returns:

the built tensor

getOutputTypes

public Representable[] getOutputTypes()

Specified by:

getOutputTypes in interface TypedOperator