com.linkedin.feathr.common.tensor

Class PrimitiveDimensionType

java.lang.Object

com.linkedin.feathr.common.tensor.DimensionType

com.linkedin.feathr.common.tensor.PrimitiveDimensionType

All Implemented Interfaces:

Representable, java.io.Serializable

public final class PrimitiveDimensionType
extends DimensionType

The most basic type of a dimension. Only specifies the primitive type and an optional shape ("size"), without any high-level metadata.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PrimitiveDimensionType	BOOLEAN
static PrimitiveDimensionType	BYTES
static PrimitiveDimensionType	INT
static PrimitiveDimensionType	LONG
static PrimitiveDimensionType	STRING

Fields inherited from class com.linkedin.feathr.common.tensor.DimensionType

DUMMY_NAME, OUT_OF_VOCAB, UNKNOWN_SHAPE

Constructor Summary

Constructors

Constructor and Description
PrimitiveDimensionType(Primitive primitive)
PrimitiveDimensionType(Primitive primitive, int shape)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getName() Get the name of the DimensionType
Primitive	getRepresentation()
int	getShape() Get the shape.
int	hashCode()
void	setDimensionValue(WriteableTuple target, int column, java.lang.Object dimensionValue) Sets a dimension in a particular column of a target tuple.
java.lang.String	toString()
PrimitiveDimensionType	withShape(int shape)

Methods inherited from class com.linkedin.feathr.common.tensor.DimensionType

getDimensionValue, indexToString, stringToIndex

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LONG

public static final PrimitiveDimensionType LONG

INT

public static final PrimitiveDimensionType INT

STRING

public static final PrimitiveDimensionType STRING

BOOLEAN

public static final PrimitiveDimensionType BOOLEAN

BYTES

public static final PrimitiveDimensionType BYTES

Constructor Detail

PrimitiveDimensionType

public PrimitiveDimensionType(Primitive primitive,
                              int shape)

PrimitiveDimensionType

public PrimitiveDimensionType(Primitive primitive)

Method Detail

withShape

public PrimitiveDimensionType withShape(int shape)

Parameters:

shape - the shape of the new type.

Returns:

a copy of this type with a new shape.

getShape

public int getShape()

Description copied from class: DimensionType

Get the shape.

Overrides:

getShape in class DimensionType

Returns:

the shape - the number of maximum possible unique values in this dimension. Can be UNKNOWN_SHAPE.

getRepresentation

public Primitive getRepresentation()

getName

public java.lang.String getName()

Description copied from class: DimensionType

Get the name of the DimensionType

Overrides:

getName in class DimensionType

Returns:

the name

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setDimensionValue

public void setDimensionValue(WriteableTuple target,
                              int column,
                              java.lang.Object dimensionValue)

Description copied from class: DimensionType

Sets a dimension in a particular column of a target tuple. For primitive dimensions, implementations will just copy the value over. (This is the default behavior.) For high-level semantic dimensions that maintain a different set of "outward-facing" and "internal" representations of the dimension values, implementations will apply any necessary translation on the input dimensionValue before inserting into the tuple.

Overrides:

setDimensionValue in class DimensionType

Parameters:

target - the destination where the dimension value should be set. Hint: This will often be a com.linkedin.feathr.common.TensorBuilder

column - the column number of the target tuple to be set

dimensionValue - the value of the dimension

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object