ai.rapids.cudf

Class Scalar

java.lang.Object

ai.rapids.cudf.Scalar

All Implemented Interfaces:

BinaryOperable, AutoCloseable

public final class Scalar
extends Object
implements AutoCloseable, BinaryOperable

A single scalar value.

Method Summary

Modifier and Type	Method and Description
ColumnVector	binaryOp(BinaryOp op, BinaryOperable rhs, DType outType) Multiple different binary operations.
void	close() Free the memory associated with a scalar.
boolean	equals(Object o)
static Scalar	fromBool(boolean value)
static Scalar	fromBool(Boolean value)
static Scalar	fromByte(byte value)
static Scalar	fromByte(Byte value)
static Scalar	fromDouble(double value)
static Scalar	fromDouble(Double value)
static Scalar	fromFloat(float value)
static Scalar	fromFloat(Float value)
static Scalar	fromInt(int value)
static Scalar	fromInt(Integer value)
static Scalar	fromLong(long value)
static Scalar	fromLong(Long value)
static Scalar	fromNull(DType type)
static Scalar	fromShort(short value)
static Scalar	fromShort(Short value)
static Scalar	fromString(String value)
boolean	getBoolean() Returns the scalar value as a boolean.
byte	getByte() Returns the scalar value as a byte.
double	getDouble() Returns the scalar value as a double.
float	getFloat() Returns the scalar value as a float.
int	getInt() Returns the scalar value as an int.
String	getJavaString() Returns the scalar value as a Java string.
long	getLong() Returns the scalar value as a long.
short	getShort() Returns the scalar value as a short.
DType	getType() Get the type of this data.
byte[]	getUTF8() Returns the scalar value as UTF-8 data.
int	hashCode()
Scalar	incRefCount() Increment the reference count for this scalar.
boolean	isValid()
static Scalar	timestampDaysFromInt(int value)
static Scalar	timestampDaysFromInt(Integer value)
static Scalar	timestampFromLong(DType type, long value)
static Scalar	timestampFromLong(DType type, Long value)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.rapids.cudf.BinaryOperable

add, add, and, and, arctan2, arctan2, bitAnd, bitAnd, bitOr, bitOr, bitXor, bitXor, div, div, equalTo, equalTo, equalToNullAware, equalToNullAware, floorDiv, floorDiv, greaterOrEqualTo, greaterOrEqualTo, greaterThan, greaterThan, implicitConversion, lessOrEqualTo, lessOrEqualTo, lessThan, lessThan, log, log, maxNullAware, maxNullAware, minNullAware, minNullAware, mod, mod, mul, mul, notEqualTo, notEqualTo, or, or, pmod, pmod, pow, pow, shiftLeft, shiftLeft, shiftRight, shiftRight, shiftRightUnsigned, shiftRightUnsigned, sub, sub, trueDiv, trueDiv

Method Detail

fromNull

public static Scalar fromNull(DType type)

fromBool

public static Scalar fromBool(boolean value)

fromBool

public static Scalar fromBool(Boolean value)

fromByte

public static Scalar fromByte(byte value)

fromByte

public static Scalar fromByte(Byte value)

fromShort

public static Scalar fromShort(short value)

fromShort

public static Scalar fromShort(Short value)

fromInt

public static Scalar fromInt(int value)

fromInt

public static Scalar fromInt(Integer value)

fromLong

public static Scalar fromLong(long value)

fromLong

public static Scalar fromLong(Long value)

fromFloat

public static Scalar fromFloat(float value)

fromFloat

public static Scalar fromFloat(Float value)

fromDouble

public static Scalar fromDouble(double value)

fromDouble

public static Scalar fromDouble(Double value)

timestampDaysFromInt

public static Scalar timestampDaysFromInt(int value)

timestampDaysFromInt

public static Scalar timestampDaysFromInt(Integer value)

timestampFromLong

public static Scalar timestampFromLong(DType type,
                                       long value)

timestampFromLong

public static Scalar timestampFromLong(DType type,
                                       Long value)

fromString

public static Scalar fromString(String value)

incRefCount

public Scalar incRefCount()

Increment the reference count for this scalar. You need to call close on this to decrement the reference count again.

close

public void close()

Free the memory associated with a scalar.

Specified by:

close in interface AutoCloseable

getType

public DType getType()

Description copied from interface: BinaryOperable

Get the type of this data.

Specified by:

getType in interface BinaryOperable

isValid

public boolean isValid()

getBoolean

public boolean getBoolean()

Returns the scalar value as a boolean.

getByte

public byte getByte()

Returns the scalar value as a byte.

getShort

public short getShort()

Returns the scalar value as a short.

getInt

public int getInt()

Returns the scalar value as an int.

getLong

public long getLong()

Returns the scalar value as a long.

getFloat

public float getFloat()

Returns the scalar value as a float.

getDouble

public double getDouble()

Returns the scalar value as a double.

getJavaString

public String getJavaString()

Returns the scalar value as a Java string.

getUTF8

public byte[] getUTF8()

Returns the scalar value as UTF-8 data.

binaryOp

public ColumnVector binaryOp(BinaryOp op,
                             BinaryOperable rhs,
                             DType outType)

Description copied from interface: BinaryOperable

Multiple different binary operations.

Specified by:

binaryOp in interface BinaryOperable

Parameters:

op - the operation to perform

rhs - the rhs of the operation

outType - the type of output you want.

Returns:

the result

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object