Primitive (feathr-impl 0.10.4-rc5 API)

java.lang.Object
- java.lang.Enum<Primitive>
- - com.linkedin.feathr.common.tensor.Primitive

All Implemented Interfaces:

Representable, java.io.Serializable, java.lang.Comparable<Primitive>
```
public enum Primitive
extends java.lang.Enum<Primitive>
implements java.io.Serializable, Representable
```
Supported primitive types. They serve as basis for scalars - dimensions and values. Note: String types should only be used when the dimension is an actual text snippet.

Enum Constant Summary

Enum Constants
Enum Constant and Description

BOOLEAN

BYTES

DOUBLE

FLOAT

INT

LONG

STRING

Enum Constants
Enum Constant and Description
`BOOLEAN`
`BYTES`
`DOUBLE`
`FLOAT`
`INT`
`LONG`
`STRING`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`canBeDenseDimension()`
`abstract boolean`	`canBeValue()` This method is called to check if the column Type of the value can be of the specified Primitive.
`abstract int`	`compare(ReadableTuple leftTuple, int leftColumn, ReadableTuple rightTuple, int rightColumn)` Compares data at leftTuple[leftColumn] with data at rightTuple[rightColumn] Note: The representation of both leftColumn and rightColumn is assumed to be the same as `this` No validation on representation is performed
`abstract void`	`copy(ReadableTuple fromTuple, int fromColumn, WriteableTuple toTuple, int toColumn)` Copies data from fromTuple[fromColumn] to toTuple[toColumn] Note: The representation of both fromColumn and toColumn is assumed to be the same as `this` No validation on representation is performed
`abstract boolean`	`equals(ReadableTuple leftTuple, int leftColumn, ReadableTuple rightTuple, int rightColumn)` Matches data at leftTuple[leftColumn] with data at rightTuple[rightColumn] Note: The representation of both leftColumn and rightColumn is assumed to be the same as `this` No validation on representation is performed
`abstract void`	`from(boolean value, WriteableTuple tuple, int column)`
`abstract void`	`from(byte[] value, WriteableTuple tuple, int column)` Stores value from its byte[] serialization in the input tuple.
`abstract void`	`from(double value, WriteableTuple tuple, int column)`
`abstract void`	`from(float value, WriteableTuple tuple, int column)`
`abstract void`	`from(int value, WriteableTuple tuple, int column)`
`abstract void`	`from(long value, WriteableTuple tuple, int column)`
`abstract void`	`from(java.lang.Number value, WriteableTuple tuple, int column)`
`void`	`from(java.lang.Object value, WriteableTuple tuple, int column)`
`abstract void`	`from(java.lang.String value, WriteableTuple tuple, int column)`
`Primitive`	`getRepresentation()`
`abstract boolean`	`isInstance(java.lang.Object obj)` check whether the input object is of the primitive type without coercion.
`abstract boolean`	`toBoolean(ReadableTuple tuple, int column)`
`abstract byte[]`	`toBytes(ReadableTuple tuple, int column)` Returns value serialized into a byte[].
`abstract double`	`toDouble(ReadableTuple tuple, int column)`
`abstract float`	`toFloat(ReadableTuple tuple, int column)`
`abstract int`	`toInt(ReadableTuple tuple, int column)`
`abstract long`	`toLong(ReadableTuple tuple, int column)`
`abstract java.lang.Object`	`toObject(ReadableTuple tuple, int column)`
`abstract java.lang.String`	`toString(ReadableTuple tuple, int column)`
`static Primitive`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Primitive[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - INT
```
public static final Primitive INT
```
  - LONG
```
public static final Primitive LONG
```
  - FLOAT
```
public static final Primitive FLOAT
```
  - DOUBLE
```
public static final Primitive DOUBLE
```
  - BOOLEAN
```
public static final Primitive BOOLEAN
```
  - STRING
```
public static final Primitive STRING
```
  - BYTES
```
public static final Primitive BYTES
```
- Method Detail
  - values
```
public static Primitive[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Primitive c : Primitive.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Primitive valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getRepresentation
```
public Primitive getRepresentation()
```
    Specified by:
    
    getRepresentation in interface Representable
  - toInt
```
public abstract int toInt(ReadableTuple tuple,
                          int column)
```
  - toLong
```
public abstract long toLong(ReadableTuple tuple,
                            int column)
```
  - toFloat
```
public abstract float toFloat(ReadableTuple tuple,
                              int column)
```
  - toDouble
```
public abstract double toDouble(ReadableTuple tuple,
                                int column)
```
  - toBoolean
```
public abstract boolean toBoolean(ReadableTuple tuple,
                                  int column)
```
  - toString
```
public abstract java.lang.String toString(ReadableTuple tuple,
                                          int column)
```
  - toBytes
```
public abstract byte[] toBytes(ReadableTuple tuple,
                               int column)
```
    Returns value serialized into a byte[].
    For numeric types (int, long, float, double), BIG_ENDIAN byte order is preserved.
    For string type, a UTF-8 charset is used to get bytes.
    For booleans, a single byte is returned in the array.
    
    Parameters:
    
    tuple - Input tuple
    
    column - Column index
    
    Returns:
    
    Value in byte[]
  - toObject
```
public abstract java.lang.Object toObject(ReadableTuple tuple,
                                          int column)
```
  - from
```
public void from(java.lang.Object value,
                 WriteableTuple tuple,
                 int column)
```
  - from
```
public abstract void from(java.lang.Number value,
                          WriteableTuple tuple,
                          int column)
```
  - from
```
public abstract void from(int value,
                          WriteableTuple tuple,
                          int column)
```
  - from
```
public abstract void from(long value,
                          WriteableTuple tuple,
                          int column)
```
  - from
```
public abstract void from(float value,
                          WriteableTuple tuple,
                          int column)
```
  - from
```
public abstract void from(double value,
                          WriteableTuple tuple,
                          int column)
```
  - from
```
public abstract void from(boolean value,
                          WriteableTuple tuple,
                          int column)
```
  - from
```
public abstract void from(java.lang.String value,
                          WriteableTuple tuple,
                          int column)
```
  - from
```
public abstract void from(byte[] value,
                          WriteableTuple tuple,
                          int column)
```
    Stores value from its byte[] serialization in the input tuple.
    For numeric types (int, long, float, double), BIG_ENDIAN byte order is expected.
    For string type, a UTF-8 charset is used to construct the string.
    For booleans, only the leading byte of the array is checked.
    
    Parameters:
    
    value - Input value
    
    tuple - Input tuple to store the value
    
    column - Column index
  - copy
```
public abstract void copy(ReadableTuple fromTuple,
                          int fromColumn,
                          WriteableTuple toTuple,
                          int toColumn)
```
    Copies data from fromTuple[fromColumn] to toTuple[toColumn] Note: The representation of both fromColumn and toColumn is assumed to be the same as this No validation on representation is performed
    
    Parameters:
    
    fromTuple - ReadableTuple from which to copy
    
    fromColumn - column in fromTuple to copy
    
    toTuple - WriteableTuple where the data would be copied
    
    toColumn - column in toTuple where the data would be copied
  - equals
```
public abstract boolean equals(ReadableTuple leftTuple,
                               int leftColumn,
                               ReadableTuple rightTuple,
                               int rightColumn)
```
    Matches data at leftTuple[leftColumn] with data at rightTuple[rightColumn] Note: The representation of both leftColumn and rightColumn is assumed to be the same as this No validation on representation is performed
    
    Parameters:
    
    leftTuple - left tuple from which a column will be matched
    
    leftColumn - column in leftTuple that will be matched
    
    rightTuple - right tuple from which a column will be matched
    
    rightColumn - column in right tuple that will be matched
    
    Returns:
    
    true if data is equal, false otherwise
  - compare
```
public abstract int compare(ReadableTuple leftTuple,
                            int leftColumn,
                            ReadableTuple rightTuple,
                            int rightColumn)
```
    Compares data at leftTuple[leftColumn] with data at rightTuple[rightColumn] Note: The representation of both leftColumn and rightColumn is assumed to be the same as this No validation on representation is performed
    
    Parameters:
    
    leftTuple - left tuple from which a column will be compared
    
    leftColumn - column in leftTuple that will be compared
    
    rightTuple - right tuple from which a column will be compared
    
    rightColumn - column in right tuple that will be compared
    
    Returns:
    
    -1 if lefttuple[leftColumn] < rightTuple[rightColumn], 0 if lefttuple[leftColumn] == rightTuple[rightColumn], 1 if lefttuple[leftColumn] > rightTuple[rightColumn]
  - canBeDenseDimension
```
public abstract boolean canBeDenseDimension()
```
    Returns:
    
    if this primitive type can be used as a dimension in dense tensors. In other words, is this type integral. If true, the type MUST support toInt(com.linkedin.feathr.common.tensor.ReadableTuple, int), toLong(com.linkedin.feathr.common.tensor.ReadableTuple, int), and from(java.lang.Object, com.linkedin.feathr.common.tensor.WriteableTuple, int) with both int and long value.
  - canBeValue
```
public abstract boolean canBeValue()
```
    This method is called to check if the column Type of the value can be of the specified Primitive.
    
    Returns:
    
    the Primitive of the column type
  - isInstance
```
public abstract boolean isInstance(java.lang.Object obj)
```
    check whether the input object is of the primitive type without coercion.

Enum Primitive

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INT

LONG

FLOAT

DOUBLE

BOOLEAN

STRING

BYTES

Method Detail

values

valueOf

getRepresentation

toInt

toLong

toFloat

toDouble

toBoolean

toString

toBytes

toObject

from

from

from

from

from

from

from

from

from

copy

equals

compare

canBeDenseDimension

canBeValue

isInstance