ColumnVector (cudfjni 0.9.1 API)

java.lang.Object
- ai.rapids.cudf.ColumnVector

All Implemented Interfaces:

BinaryOperable, AutoCloseable
```
public final class ColumnVector
extends Object
implements AutoCloseable, BinaryOperable
```
A Column Vector. This class represents the immutable vector of data. This class holds references to off heap memory and is reference counted to know when to release it. Call close to decrement the reference count when you are done with the column, and call inRefCount to increment the reference count.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ColumnVector.Builder` Build
`protected static class`	`ColumnVector.OffHeapState` Holds the off heap state of the column vector so we can clean it up, even if it is leaked.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColumnVector`	`abs()` Calculate the abs, output is the same type as input.
`Scalar`	`approxQuantile(double quantile)` Calculate the approximate quantile of this ColumnVector
`ColumnVector`	`arccos()` Calculate the arccos, output is the same type as input.
`ColumnVector`	`arcsin()` Calculate the arcsin, output is the same type as input.
`ColumnVector`	`arctan()` Calculate the arctan, output is the same type as input.
`ColumnVector`	`asBytes()` Cast to Byte - ColumnVector This method takes the value provided by the ColumnVector and casts to byte When casting from a Date, Timestamp, or Boolean to a byte type the underlying numerical representation of the data will be used for the cast.
`ColumnVector`	`asDate32()` Cast to Date32 - ColumnVector This method takes the value provided by the ColumnVector and casts to date32
`ColumnVector`	`asDate64()` Cast to Date64 - ColumnVector This method takes the value provided by the ColumnVector and casts to date64
`ColumnVector`	`asDoubles()` Cast to Double - ColumnVector This method takes the value provided by the ColumnVector and casts to double When casting from a Date, Timestamp, or Boolean to a double type the underlying numerical representation of the data will be used for the cast.
`ColumnVector`	`asFloats()` Cast to Float - ColumnVector This method takes the value provided by the ColumnVector and casts to float When casting from a Date, Timestamp, or Boolean to a float type the underlying numerical representatio of the data will be used for the cast.
`ColumnVector`	`asInts()` Cast to Int - ColumnVector This method takes the value provided by the ColumnVector and casts to int When casting from a Date, Timestamp, or Boolean to a int type the underlying numerical representation of the data will be used for the cast.
`ColumnVector`	`asLongs()` Cast to Long - ColumnVector This method takes the value provided by the ColumnVector and casts to long When casting from a Date, Timestamp, or Boolean to a long type the underlying numerical representation of the data will be used for the cast.
`ColumnVector`	`asShorts()` Cast to Short - ColumnVector This method takes the value provided by the ColumnVector and casts to short When casting from a Date, Timestamp, or Boolean to a short type the underlying numerical representation of the data will be used for the cast.
`ColumnVector`	`asStringCategories()` Cast to String Categories.
`ColumnVector`	`asStrings()` Cast to Strings.
`ColumnVector`	`asTimestamp(TimeUnit unit)` Cast to Timestamp - ColumnVector This method takes the value provided by the ColumnVector and casts to timestamp
`ColumnVector`	`binaryOp(BinaryOp op, BinaryOperable rhs, DType outType)` Multiple different binary operations.
`ColumnVector`	`bitInvert()` invert the bits, output is the same type as input.
`static ColumnVector`	`boolFromBytes(byte... values)` Create a new vector from the given values.
`static ColumnVector`	`build(DType type, int rows, java.util.function.Consumer<ColumnVector.Builder> init)` Create a new vector.
`static ColumnVector`	`build(DType type, int rows, long stringBufferSize, java.util.function.Consumer<ColumnVector.Builder> init)`
`static ColumnVector`	`build(DType type, TimeUnit tsTimeUnit, int rows, java.util.function.Consumer<ColumnVector.Builder> init)` Create a new vector.
`static ColumnVector.Builder`	`builder(DType type, int rows)` Create a new Builder to hold the specified number of rows.
`static ColumnVector.Builder`	`builder(DType type, int rows, long stringBufferSize)` Create a new Builder to hold the specified number of rows and with enough space to hold the given amount of string data.
`static ColumnVector.Builder`	`builder(DType type, TimeUnit tsTimeUnit, int rows)` Create a new Builder to hold the specified number of rows.
`static ColumnVector`	`buildOnHost(DType type, int rows, java.util.function.Consumer<ColumnVector.Builder> init)` Create a new vector without sending data to the device.
`static ColumnVector`	`buildOnHost(DType type, TimeUnit tsTimeUnit, int rows, java.util.function.Consumer<ColumnVector.Builder> init)` Create a new vector without sending data to the device.
`ColumnVector`	`castTo(DType type, TimeUnit unit)` Generic method to cast ColumnVector When casting from a Date, Timestamp, or Boolean to a numerical type the underlying numerical representationof the data will be used for the cast.
`static ColumnVector`	`categoryFromStrings(String... values)` Create a new category string vector from the given values.
`ColumnVector`	`ceil()` Calculate the ceil, output is the same type as input.
`void`	`close()` Close this Vector and free memory allocated for HostMemoryBuffer and DeviceMemoryBuffer
`static ColumnVector`	`concatenate(ColumnVector... columns)` Create a new vector by concatenating multiple columns together.
`ColumnVector`	`cos()` Calculate the cos, output is the same type as input.
`static ColumnVector`	`datesFromBoxedInts(Integer... values)` Create a new vector from the given values.
`static ColumnVector`	`datesFromBoxedLongs(Long... values)` Create a new vector from the given values.
`static ColumnVector`	`datesFromInts(int... values)` Create a new vector from the given values.
`static ColumnVector`	`datesFromLongs(long... values)` Create a new vector from the given values.
`ColumnVector`	`day()` Get day from DATE32, DATE64, or TIMESTAMP
`void`	`ensureOnDevice()` Be sure the data is on the device.
`void`	`ensureOnHost()` Be sure the data is on the host.
`Scalar`	`exactQuantile(QuantileMethod method, double quantile)` Calculate the quantile of this ColumnVector
`ColumnVector`	`exp()` Calculate the exp, output is the same type as input.
`ColumnVector`	`floor()` Calculate the floor, output is the same type as input.
`static ColumnVector`	`fromBoxedBooleans(Boolean... values)` Create a new vector from the given values.
`static ColumnVector`	`fromBoxedBytes(Byte... values)` Create a new vector from the given values.
`static ColumnVector`	`fromBoxedDoubles(Double... values)` Create a new vector from the given values.
`static ColumnVector`	`fromBoxedFloats(Float... values)` Create a new vector from the given values.
`static ColumnVector`	`fromBoxedInts(Integer... values)` Create a new vector from the given values.
`static ColumnVector`	`fromBoxedLongs(Long... values)` Create a new vector from the given values.
`static ColumnVector`	`fromBoxedShorts(Short... values)` Create a new vector from the given values.
`static ColumnVector`	`fromBytes(byte... values)` Create a new vector from the given values.
`static ColumnVector`	`fromDoubles(double... values)` Create a new vector from the given values.
`static ColumnVector`	`fromFloats(float... values)` Create a new vector from the given values.
`static ColumnVector`	`fromInts(int... values)` Create a new vector from the given values.
`static ColumnVector`	`fromLongs(long... values)` Create a new vector from the given values.
`static ColumnVector`	`fromScalar(Scalar scalar, int rows)` Create a new vector of length rows, where each row is filled with the Scalar's value
`static ColumnVector`	`fromShorts(short... values)` Create a new vector from the given values.
`static ColumnVector`	`fromStrings(String... values)` Create a new string vector from the given values.
`boolean`	`getBoolean(long index)` Get the boolean value at index
`byte`	`getByte(long index)` Get the value at index.
`ColumnVector`	`getByteCount()` Retrieve the number of bytes for each string.
`Scalar`	`getCategoryIndex(Scalar s)` Returns the category index of the specified string scalar.
`double`	`getDouble(long index)` Get the value at index.
`float`	`getFloat(long index)` Get the value at index.
`int`	`getInt(long index)` Get the value at index.
`String`	`getJavaString(long index)` Get the value at index.
`ColumnVector`	`getLengths()` Retrieve the number of characters in each string.
`long`	`getLong(long index)` Get the value at index.
`long`	`getNativeCudfColumnAddress()` USE WITH CAUTION: This method exposes the address of the native cudf_column.
`long`	`getNullCount()` Returns the number of nulls in the data.
`long`	`getRowCount()` Returns the number of rows in this vector.
`short`	`getShort(long index)` Get the value at index.
`TimeUnit`	`getTimeUnit()` For vector types that support a TimeUnit (TIMESTAMP), get the unit of time.
`DType`	`getType()` Returns the type of this vector.
`ColumnVector`	`hash()` Compute the 32 bit hash of a vector.
`ColumnVector`	`hash(HashFunction func)` Compute a specific hash of a vector.
`boolean`	`hasNulls()` Returns if the vector has nulls.
`boolean`	`hasValidityVector()` Returns if the vector has a validity vector allocated or not.
`ColumnVector`	`hour()` Get hour from DATE64 or TIMESTAMP
`ColumnVector`	`identityHash()` Compute the IDENTITY hash of the column.
`ColumnVector`	`incRefCount()` Increment the reference count for this column.
`ColumnVector`	`isNotNull()` Returns a Boolean vector with the same number of rows as this instance, that has TRUE for any entry that is not null, and FALSE for any null entry (as per the validity mask)
`ColumnVector`	`isNull()` Returns a Boolean vector with the same number of rows as this instance, that has FALSE for any entry that is not null, and TRUE for any null entry (as per the validity mask)
`boolean`	`isNull(long index)` Check if the value at index is null or not.
`ColumnVector`	`log()` Calculate the log, output is the same type as input.
`Scalar`	`max()` Returns the maximum of all values in the column, returning a scalar of the same type as this column.
`Scalar`	`max(DType outType)` Returns the maximum of all values in the column, returning a scalar of the specified type.
`Scalar`	`min()` Returns the minimum of all values in the column, returning a scalar of the same type as this column.
`Scalar`	`min(DType outType)` Returns the minimum of all values in the column, returning a scalar of the specified type.
`ColumnVector`	`minute()` Get minute from DATE64 or TIMESTAMP
`ColumnVector`	`month()` Get month from DATE32, DATE64, or TIMESTAMP
`ColumnVector`	`murmur3()` Compute the MURMUR3 hash of the column.
`ColumnVector`	`not()` Returns a vector of the logical `not` of each value in the input column (this)
`void`	`noWarnLeakExpected()` This is a really ugly API, but it is possible that the lifecycle of a column of data may not have a clear lifecycle thanks to java and GC.
`Scalar`	`product()` Returns the product of all values in the column, returning a scalar of the same type as this column.
`Scalar`	`product(DType outType)` Returns the product of all values in the column, returning a scalar of the specified type.
`Scalar`	`reduce(ReductionOp op)` Computes the reduction of the values in all rows of a column.
`Scalar`	`reduce(ReductionOp op, DType outType)` Computes the reduction of the values in all rows of a column.
`ColumnVector`	`replaceNulls(Scalar scalar)` Returns a ColumnVector with any null values replaced with a scalar.
`ColumnVector`	`second()` Get second from DATE64 or TIMESTAMP
`ColumnVector`	`sin()` Calculate the sin, output is the same type as input.
`ColumnVector[]`	`slice(ColumnVector indices)` Slices a column (including null values) into a set of columns according to a set of indices.
`ColumnVector[]`	`slice(int... indices)` Slices a column (including null values) into a set of columns according to a set of indices.
`ColumnVector`	`sqrt()` Calculate the sqrt, output is the same type as input.
`Scalar`	`standardDeviation()` Returns the sample standard deviation of all values in the column, returning a FLOAT64 scalar unless the column type is FLOAT32 then a FLOAT32 scalaris returned.
`Scalar`	`standardDeviation(DType outType)` Returns the sample standard deviation of all values in the column, returning a scalar of the specified type.
`Scalar`	`sum()` Computes the sum of all values in the column, returning a scalar of the same type as this column.
`Scalar`	`sum(DType outType)` Computes the sum of all values in the column, returning a scalar of the specified type.
`Scalar`	`sumOfSquares()` Returns the sum of squares of all values in the column, returning a scalar of the same type as this column.
`Scalar`	`sumOfSquares(DType outType)` Returns the sum of squares of all values in the column, returning a scalar of the specified type.
`ColumnVector`	`tan()` Calculate the tan, output is the same type as input.
`static ColumnVector`	`timestampsFromBoxedLongs(Long... values)` Create a new vector from the given values.
`static ColumnVector`	`timestampsFromBoxedLongs(TimeUnit tsTimeUnit, Long... values)` Create a new vector from the given values.
`static ColumnVector`	`timestampsFromLongs(long... values)` Create a new vector from the given values.
`static ColumnVector`	`timestampsFromLongs(TimeUnit tsTimeUnit, long... values)` Create a new vector from the given values.
`String`	`toString()`
`ColumnVector`	`unaryOp(UnaryOp op)` Multiple different unary operations.
`ColumnVector`	`year()` Get year from DATE32, DATE64, or TIMESTAMP

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ai.rapids.cudf.BinaryOperable
add, add, and, and, bitAnd, bitAnd, bitOr, bitOr, bitXor, bitXor, div, div, equalTo, equalTo, floorDiv, floorDiv, greaterOrEqualTo, greaterOrEqualTo, greaterThan, greaterThan, implicitConversion, lessOrEqualTo, lessOrEqualTo, lessThan, lessThan, mod, mod, mul, mul, notEqualTo, notEqualTo, or, or, pow, pow, sub, sub, trueDiv, trueDiv

- Method Detail
  - noWarnLeakExpected
```
public final void noWarnLeakExpected()
```
    This is a really ugly API, but it is possible that the lifecycle of a column of data may not have a clear lifecycle thanks to java and GC. This API informs the leak tracking code that this is expected for this column, and big scary warnings should not be printed when this happens.
  - close
```
public final void close()
```
    Close this Vector and free memory allocated for HostMemoryBuffer and DeviceMemoryBuffer
    
    Specified by:
    
    close in interface AutoCloseable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - incRefCount
```
public ColumnVector incRefCount()
```
    Increment the reference count for this column. You need to call close on this to decrement the reference count again.
  - getRowCount
```
public long getRowCount()
```
    Returns the number of rows in this vector.
  - getLengths
```
public ColumnVector getLengths()
```
    Retrieve the number of characters in each string. Null strings will have value of null.
    
    Returns:
    
    ColumnVector holding length of string at index 'i' in the original vector
  - hash
```
public ColumnVector hash()
```
    Compute the 32 bit hash of a vector.
    
    Returns:
    
    the 32 bit hash.
  - hash
```
public ColumnVector hash(HashFunction func)
```
    Compute a specific hash of a vector. String are not supported, if you need a hash of a string, you can use the generic hash, which does not guarantee what kind of hash is used.
    
    Parameters:
    
    func - the has function to use.
    
    Returns:
    
    the 32 bit hash.
  - murmur3
```
public ColumnVector murmur3()
```
    Compute the MURMUR3 hash of the column. Strings are not supported.
  - identityHash
```
public ColumnVector identityHash()
```
    Compute the IDENTITY hash of the column. Strings are not supported.
  - getType
```
public DType getType()
```
    Returns the type of this vector.
    
    Specified by:
    
    getType in interface BinaryOperable
  - getNullCount
```
public long getNullCount()
```
    Returns the number of nulls in the data.
  - getByteCount
```
public ColumnVector getByteCount()
```
    Retrieve the number of bytes for each string. Null strings will have value of null.
    
    Returns:
    
    ColumnVector, where each element at i = byte count of string at index 'i' in the original vector
  - hasValidityVector
```
public boolean hasValidityVector()
```
    Returns if the vector has a validity vector allocated or not.
  - hasNulls
```
public boolean hasNulls()
```
    Returns if the vector has nulls.
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
    For vector types that support a TimeUnit (TIMESTAMP), get the unit of time. Will be NONE for vectors that did not have one set. For a TIMESTAMP NONE is the default unit which should be the same as MILLISECONDS.
  - ensureOnDevice
```
public final void ensureOnDevice()
```
    Be sure the data is on the device.
  - ensureOnHost
```
public final void ensureOnHost()
```
    Be sure the data is on the host.
  - isNull
```
public boolean isNull(long index)
```
    Check if the value at index is null or not.
  - isNotNull
```
public ColumnVector isNotNull()
```
    Returns a Boolean vector with the same number of rows as this instance, that has TRUE for any entry that is not null, and FALSE for any null entry (as per the validity mask)
    
    Returns:
    
    - Boolean vector
  - isNull
```
public ColumnVector isNull()
```
    Returns a Boolean vector with the same number of rows as this instance, that has FALSE for any entry that is not null, and TRUE for any null entry (as per the validity mask)
    
    Returns:
    
    - Boolean vector
  - replaceNulls
```
public ColumnVector replaceNulls(Scalar scalar)
```
    Returns a ColumnVector with any null values replaced with a scalar.
    
    Parameters:
    
    scalar - - Scalar value to use as replacement
    
    Returns:
    
    - ColumnVector with nulls replaced by scalar
  - getByte
```
public byte getByte(long index)
```
    Get the value at index.
  - getShort
```
public final short getShort(long index)
```
    Get the value at index.
  - getInt
```
public final int getInt(long index)
```
    Get the value at index.
  - getLong
```
public final long getLong(long index)
```
    Get the value at index.
  - getFloat
```
public final float getFloat(long index)
```
    Get the value at index.
  - getDouble
```
public final double getDouble(long index)
```
    Get the value at index.
  - getBoolean
```
public final boolean getBoolean(long index)
```
    Get the boolean value at index
  - getJavaString
```
public String getJavaString(long index)
```
    Get the value at index. This API is slow as it has to translate the string representation. Please use it with caution.
  - year
```
public ColumnVector year()
```
    Get year from DATE32, DATE64, or TIMESTAMP
    Postconditions - A new vector is allocated with the result. The caller owns the vector and is responsible for its lifecycle.
    
    Returns:
    
    - A new INT16 vector allocated on the GPU.
  - month
```
public ColumnVector month()
```
    Get month from DATE32, DATE64, or TIMESTAMP
    Postconditions - A new vector is allocated with the result. The caller owns the vector and is responsible for its lifecycle.
    
    Returns:
    
    - A new INT16 vector allocated on the GPU.
  - day
```
public ColumnVector day()
```
    Get day from DATE32, DATE64, or TIMESTAMP
    Postconditions - A new vector is allocated with the result. The caller owns the vector and is responsible for its lifecycle.
    
    Returns:
    
    - A new INT16 vector allocated on the GPU.
  - hour
```
public ColumnVector hour()
```
    Get hour from DATE64 or TIMESTAMP
    Postconditions - A new vector is allocated with the result. The caller owns the vector and is responsible for its lifecycle.
    
    Returns:
    
    - A new INT16 vector allocated on the GPU.
  - minute
```
public ColumnVector minute()
```
    Get minute from DATE64 or TIMESTAMP
    Postconditions - A new vector is allocated with the result. The caller owns the vector and is responsible for its lifecycle.
    
    Returns:
    
    - A new INT16 vector allocated on the GPU.
  - second
```
public ColumnVector second()
```
    Get second from DATE64 or TIMESTAMP
    Postconditions - A new vector is allocated with the result. The caller owns the vector and is responsible for its lifecycle.
    
    Returns:
    
    - A new INT16 vector allocated on the GPU.
  - unaryOp
```
public ColumnVector unaryOp(UnaryOp op)
```
    Multiple different unary operations. The output is the same type as input.
    
    Parameters:
    
    op - the operation to perform
    
    Returns:
    
    the result
  - sin
```
public ColumnVector sin()
```
    Calculate the sin, output is the same type as input.
  - cos
```
public ColumnVector cos()
```
    Calculate the cos, output is the same type as input.
  - tan
```
public ColumnVector tan()
```
    Calculate the tan, output is the same type as input.
  - arcsin
```
public ColumnVector arcsin()
```
    Calculate the arcsin, output is the same type as input.
  - arccos
```
public ColumnVector arccos()
```
    Calculate the arccos, output is the same type as input.
  - arctan
```
public ColumnVector arctan()
```
    Calculate the arctan, output is the same type as input.
  - exp
```
public ColumnVector exp()
```
    Calculate the exp, output is the same type as input.
  - log
```
public ColumnVector log()
```
    Calculate the log, output is the same type as input.
  - sqrt
```
public ColumnVector sqrt()
```
    Calculate the sqrt, output is the same type as input.
  - ceil
```
public ColumnVector ceil()
```
    Calculate the ceil, output is the same type as input.
  - floor
```
public ColumnVector floor()
```
    Calculate the floor, output is the same type as input.
  - abs
```
public ColumnVector abs()
```
    Calculate the abs, output is the same type as input.
  - bitInvert
```
public ColumnVector bitInvert()
```
    invert the bits, output is the same type as input.
  - binaryOp
```
public ColumnVector binaryOp(BinaryOp op,
                             BinaryOperable rhs,
                             DType outType)
```
    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
  - slice
```
public ColumnVector[] slice(int... indices)
```
    Slices a column (including null values) into a set of columns according to a set of indices. The caller owns the ColumnVectors and is responsible closing them The "slice" function divides part of the input column into multiple intervals of rows using the indices values and it stores the intervals into the output columns. Regarding the interval of indices, a pair of values are taken from the indices array in a consecutive manner. The pair of indices are left-closed and right-open. The pairs of indices in the array are required to comply with the following conditions: a, b belongs to Range[0, input column size] a <= b, where the position of a is less or equal to the position of b. Exceptional cases for the indices array are: When the values in the pair are equal, the function returns an empty column. When the values in the pair are 'strictly decreasing', the outcome is undefined. When any of the values in the pair don't belong to the range[0, input column size), the outcome is undefined. When the indices array is empty, an empty vector of columns is returned. The caller owns the output ColumnVectors and is responsible for closing them.
    
    Parameters:
    
    indices -
    
    Returns:
    
    A new ColumnVector array with slices from the original ColumnVector
  - slice
```
public ColumnVector[] slice(ColumnVector indices)
```
    Slices a column (including null values) into a set of columns according to a set of indices. The caller owns the ColumnVectors and is responsible closing them The "slice" function divides part of the input column into multiple intervals of rows using the indices values and it stores the intervals into the output columns. Regarding the interval of indices, a pair of values are taken from the indices array in a consecutive manner. The pair of indices are left-closed and right-open. The pairs of indices in the array are required to comply with the following conditions: a, b belongs to Range[0, input column size] a <= b, where the position of a is less or equal to the position of b. Exceptional cases for the indices array are: When the values in the pair are equal, the function returns an empty column. When the values in the pair are 'strictly decreasing', the outcome is undefined. When any of the values in the pair don't belong to the range[0, input column size), the outcome is undefined. When the indices array is empty, an empty vector of columns is returned. The caller owns the output ColumnVectors and is responsible for closing them.
    
    Parameters:
    
    indices -
    
    Returns:
    
    A new ColumnVector array with slices from the original ColumnVector
  - sum
```
public Scalar sum()
```
    Computes the sum of all values in the column, returning a scalar of the same type as this column.
  - sum
```
public Scalar sum(DType outType)
```
    Computes the sum of all values in the column, returning a scalar of the specified type.
  - min
```
public Scalar min()
```
    Returns the minimum of all values in the column, returning a scalar of the same type as this column.
  - min
```
public Scalar min(DType outType)
```
    Returns the minimum of all values in the column, returning a scalar of the specified type.
  - max
```
public Scalar max()
```
    Returns the maximum of all values in the column, returning a scalar of the same type as this column.
  - max
```
public Scalar max(DType outType)
```
    Returns the maximum of all values in the column, returning a scalar of the specified type.
  - product
```
public Scalar product()
```
    Returns the product of all values in the column, returning a scalar of the same type as this column.
  - product
```
public Scalar product(DType outType)
```
    Returns the product of all values in the column, returning a scalar of the specified type.
  - sumOfSquares
```
public Scalar sumOfSquares()
```
    Returns the sum of squares of all values in the column, returning a scalar of the same type as this column.
  - sumOfSquares
```
public Scalar sumOfSquares(DType outType)
```
    Returns the sum of squares of all values in the column, returning a scalar of the specified type.
  - standardDeviation
```
public Scalar standardDeviation()
```
    Returns the sample standard deviation of all values in the column, returning a FLOAT64 scalar unless the column type is FLOAT32 then a FLOAT32 scalaris returned. Null's are not counted as an element of the column when calculating the standard deviation.
  - standardDeviation
```
public Scalar standardDeviation(DType outType)
```
    Returns the sample standard deviation of all values in the column, returning a scalar of the specified type. Null's are not counted as an element of the column when calculating the standard deviation.
  - reduce
```
public Scalar reduce(ReductionOp op)
```
    Computes the reduction of the values in all rows of a column. Overflows in reductions are not detected. Specifying a higher precision output type may prevent overflow. Only the MIN and MAX ops are The null values are skipped for the operation.
    
    Parameters:
    
    op - The reduction operation to perform
    
    Returns:
    
    The scalar result of the reduction operation. If the column is empty or the reduction operation fails then the Scalar.isValid() method of the result will return false.
  - reduce
```
public Scalar reduce(ReductionOp op,
                     DType outType)
```
    Computes the reduction of the values in all rows of a column. Overflows in reductions are not detected. Specifying a higher precision output type may prevent overflow. Only the MIN and MAX ops are supported for reduction of non-arithmetic types (DATE32, TIMESTAMP...) The null values are skipped for the operation.
    
    Parameters:
    
    op - The reduction operation to perform
    
    outType - The type of scalar value to return
    
    Returns:
    
    The scalar result of the reduction operation. If the column is empty or the reduction operation fails then the Scalar.isValid() method of the result will return false.
  - not
```
public ColumnVector not()
```
    Returns a vector of the logical `not` of each value in the input column (this)
  - castTo
```
public ColumnVector castTo(DType type,
                           TimeUnit unit)
```
    Generic method to cast ColumnVector When casting from a Date, Timestamp, or Boolean to a numerical type the underlying numerical representationof the data will be used for the cast. In the cast of Timestamp this means the TimeUnit is ignored and lost. When casting between Date32, Date64, and Timestamp the units of time are used.
    
    Parameters:
    
    type - type of the resulting ColumnVector
    
    unit - the unit of time, really only applicable for TIMESTAMP.
    
    Returns:
    
    A new vector allocated on the GPU
  - asBytes
```
public ColumnVector asBytes()
```
    Cast to Byte - ColumnVector This method takes the value provided by the ColumnVector and casts to byte When casting from a Date, Timestamp, or Boolean to a byte type the underlying numerical representation of the data will be used for the cast.
    
    Returns:
    
    A new vector allocated on the GPU
  - asShorts
```
public ColumnVector asShorts()
```
    Cast to Short - ColumnVector This method takes the value provided by the ColumnVector and casts to short When casting from a Date, Timestamp, or Boolean to a short type the underlying numerical representation of the data will be used for the cast.
    
    Returns:
    
    A new vector allocated on the GPU
  - asInts
```
public ColumnVector asInts()
```
    Cast to Int - ColumnVector This method takes the value provided by the ColumnVector and casts to int When casting from a Date, Timestamp, or Boolean to a int type the underlying numerical representation of the data will be used for the cast.
    
    Returns:
    
    A new vector allocated on the GPU
  - asLongs
```
public ColumnVector asLongs()
```
    Cast to Long - ColumnVector This method takes the value provided by the ColumnVector and casts to long When casting from a Date, Timestamp, or Boolean to a long type the underlying numerical representation of the data will be used for the cast.
    
    Returns:
    
    A new vector allocated on the GPU
  - asFloats
```
public ColumnVector asFloats()
```
    Cast to Float - ColumnVector This method takes the value provided by the ColumnVector and casts to float When casting from a Date, Timestamp, or Boolean to a float type the underlying numerical representatio of the data will be used for the cast.
    
    Returns:
    
    A new vector allocated on the GPU
  - asDoubles
```
public ColumnVector asDoubles()
```
    Cast to Double - ColumnVector This method takes the value provided by the ColumnVector and casts to double When casting from a Date, Timestamp, or Boolean to a double type the underlying numerical representation of the data will be used for the cast.
    
    Returns:
    
    A new vector allocated on the GPU
  - asDate32
```
public ColumnVector asDate32()
```
    Cast to Date32 - ColumnVector This method takes the value provided by the ColumnVector and casts to date32
    
    Returns:
    
    A new vector allocated on the GPU
  - asDate64
```
public ColumnVector asDate64()
```
    Cast to Date64 - ColumnVector This method takes the value provided by the ColumnVector and casts to date64
    
    Returns:
    
    A new vector allocated on the GPU
  - asTimestamp
```
public ColumnVector asTimestamp(TimeUnit unit)
```
    Cast to Timestamp - ColumnVector This method takes the value provided by the ColumnVector and casts to timestamp
    
    Returns:
    
    A new vector allocated on the GPU
  - asStrings
```
public ColumnVector asStrings()
```
    Cast to Strings.
    
    Returns:
    
    A new vector allocated on the GPU.
  - asStringCategories
```
public ColumnVector asStringCategories()
```
    Cast to String Categories.
    
    Returns:
    
    A new vector allocated on the GPU.
  - getCategoryIndex
```
public Scalar getCategoryIndex(Scalar s)
```
    Returns the category index of the specified string scalar.
    
    Parameters:
    
    s - a Scalar of type DType.STRING to lookup
    
    Returns:
    
    an integer Scalar containing the category index or -1 if the string was not found in the category.
  - getNativeCudfColumnAddress
```
public final long getNativeCudfColumnAddress()
```
    USE WITH CAUTION: This method exposes the address of the native cudf_column. This allows writing custom kernels or other cuda operations on the data. DO NOT close this column vector until you are completely done using the native column. DO NOT modify the column in any way. This should be treated as a read only data structure. This API is unstable as the underlying C/C++ API is still not stabilized. If the underlying data structure is renamed this API may be replaced. The underlying data structure can change from release to release (it is not stable yet) so be sure that your native code is complied against the exact same version of libcudf as this is released for.
  - builder
```
public static ColumnVector.Builder builder(DType type,
                                           int rows)
```
    Create a new Builder to hold the specified number of rows. Be sure to close the builder when done with it. Please try to use #build(int, Consumer) instead to avoid needing to close the builder.
    
    Parameters:
    
    type - the type of vector to build.
    
    rows - the number of rows this builder can hold
    
    Returns:
    
    the builder to use.
  - builder
```
public static ColumnVector.Builder builder(DType type,
                                           TimeUnit tsTimeUnit,
                                           int rows)
```
    Create a new Builder to hold the specified number of rows. Be sure to close the builder when done with it. Please try to use #build(int, Consumer) instead to avoid needing to close the builder.
    
    Parameters:
    
    type - the type of vector to build.
    
    rows - the number of rows this builder can hold
    
    Returns:
    
    the builder to use.
  - builder
```
public static ColumnVector.Builder builder(DType type,
                                           int rows,
                                           long stringBufferSize)
```
    Create a new Builder to hold the specified number of rows and with enough space to hold the given amount of string data. Be sure to close the builder when done with it. Please try to use #build(int, int, Consumer) instead to avoid needing to close the builder.
    
    Parameters:
    
    type - the type of vector to build.
    
    rows - the number of rows this builder can hold
    
    stringBufferSize - the size of the string buffer to allocate.
    
    Returns:
    
    the builder to use.
  - build
```
public static ColumnVector build(DType type,
                                 int rows,
                                 java.util.function.Consumer<ColumnVector.Builder> init)
```
    Create a new vector.
    
    Parameters:
    
    type - the type of vector to build.
    
    rows - maximum number of rows that the vector can hold.
    
    init - what will initialize the vector.
    
    Returns:
    
    the created vector.
  - build
```
public static ColumnVector build(DType type,
                                 TimeUnit tsTimeUnit,
                                 int rows,
                                 java.util.function.Consumer<ColumnVector.Builder> init)
```
    Create a new vector.
    
    Parameters:
    
    type - the type of vector to build.
    
    tsTimeUnit - the unit of time, really only applicable for TIMESTAMP.
    
    rows - maximum number of rows that the vector can hold.
    
    init - what will initialize the vector.
    
    Returns:
    
    the created vector.
  - build
```
public static ColumnVector build(DType type,
                                 int rows,
                                 long stringBufferSize,
                                 java.util.function.Consumer<ColumnVector.Builder> init)
```
  - buildOnHost
```
public static ColumnVector buildOnHost(DType type,
                                       int rows,
                                       java.util.function.Consumer<ColumnVector.Builder> init)
```
    Create a new vector without sending data to the device.
    
    Parameters:
    
    type - the type of vector to build.
    
    rows - maximum number of rows that the vector can hold.
    
    init - what will initialize the vector.
    
    Returns:
    
    the created vector.
  - buildOnHost
```
public static ColumnVector buildOnHost(DType type,
                                       TimeUnit tsTimeUnit,
                                       int rows,
                                       java.util.function.Consumer<ColumnVector.Builder> init)
```
    Create a new vector without sending data to the device.
    
    Parameters:
    
    type - the type of vector to build.
    
    tsTimeUnit - the unit of time, really only applicable for TIMESTAMP.
    
    rows - maximum number of rows that the vector can hold.
    
    init - what will initialize the vector.
    
    Returns:
    
    the created vector.
  - boolFromBytes
```
public static ColumnVector boolFromBytes(byte... values)
```
    Create a new vector from the given values.
  - fromBytes
```
public static ColumnVector fromBytes(byte... values)
```
    Create a new vector from the given values.
  - fromShorts
```
public static ColumnVector fromShorts(short... values)
```
    Create a new vector from the given values.
  - fromInts
```
public static ColumnVector fromInts(int... values)
```
    Create a new vector from the given values.
  - fromLongs
```
public static ColumnVector fromLongs(long... values)
```
    Create a new vector from the given values.
  - fromFloats
```
public static ColumnVector fromFloats(float... values)
```
    Create a new vector from the given values.
  - fromDoubles
```
public static ColumnVector fromDoubles(double... values)
```
    Create a new vector from the given values.
  - datesFromInts
```
public static ColumnVector datesFromInts(int... values)
```
    Create a new vector from the given values.
  - datesFromLongs
```
public static ColumnVector datesFromLongs(long... values)
```
    Create a new vector from the given values.
  - timestampsFromLongs
```
public static ColumnVector timestampsFromLongs(long... values)
```
    Create a new vector from the given values.
  - timestampsFromLongs
```
public static ColumnVector timestampsFromLongs(TimeUnit tsTimeUnit,
                                               long... values)
```
    Create a new vector from the given values.
  - categoryFromStrings
```
public static ColumnVector categoryFromStrings(String... values)
```
    Create a new category string vector from the given values. This API supports inline nulls. This is really intended to be used only for testing as it is slow and memory intensive to translate between java strings and UTF8 strings.
  - fromStrings
```
public static ColumnVector fromStrings(String... values)
```
    Create a new string vector from the given values. This API supports inline nulls. This is really intended to be used only for testing as it is slow and memory intensive to translate between java strings and UTF8 strings.
  - fromBoxedBooleans
```
public static ColumnVector fromBoxedBooleans(Boolean... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - fromBoxedBytes
```
public static ColumnVector fromBoxedBytes(Byte... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - fromBoxedShorts
```
public static ColumnVector fromBoxedShorts(Short... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - fromBoxedInts
```
public static ColumnVector fromBoxedInts(Integer... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - fromBoxedLongs
```
public static ColumnVector fromBoxedLongs(Long... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - fromBoxedFloats
```
public static ColumnVector fromBoxedFloats(Float... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - fromBoxedDoubles
```
public static ColumnVector fromBoxedDoubles(Double... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - datesFromBoxedInts
```
public static ColumnVector datesFromBoxedInts(Integer... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - datesFromBoxedLongs
```
public static ColumnVector datesFromBoxedLongs(Long... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - timestampsFromBoxedLongs
```
public static ColumnVector timestampsFromBoxedLongs(Long... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - timestampsFromBoxedLongs
```
public static ColumnVector timestampsFromBoxedLongs(TimeUnit tsTimeUnit,
                                                    Long... values)
```
    Create a new vector from the given values. This API supports inline nulls, but is much slower than using a regular array and should really only be used for tests.
  - fromScalar
```
public static ColumnVector fromScalar(Scalar scalar,
                                      int rows)
```
    Create a new vector of length rows, where each row is filled with the Scalar's value
    
    Parameters:
    
    scalar - - Scalar to use to fill rows
    
    rows - - Number of rows in the new ColumnVector
    
    Returns:
    
    - new ColumnVector
  - concatenate
```
public static ColumnVector concatenate(ColumnVector... columns)
```
    Create a new vector by concatenating multiple columns together. Note that all columns must have the same type.
  - exactQuantile
```
public Scalar exactQuantile(QuantileMethod method,
                            double quantile)
```
    Calculate the quantile of this ColumnVector
    
    Parameters:
    
    method - the method used to calculate the quantile
    
    quantile - the quantile value [0,1]
    
    Returns:
    
    the quantile as double. The type can be changed in future
  - approxQuantile
```
public Scalar approxQuantile(double quantile)
```
    Calculate the approximate quantile of this ColumnVector
    
    Parameters:
    
    quantile - the quantile value [0,1]
    
    Returns:
    
    the quantile, with the same type as this object

Class ColumnVector

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface ai.rapids.cudf.BinaryOperable

Method Detail

noWarnLeakExpected

close

toString

incRefCount

getRowCount

getLengths

hash

hash

murmur3

identityHash

getType

getNullCount

getByteCount

hasValidityVector

hasNulls

getTimeUnit

ensureOnDevice

ensureOnHost

isNull

isNotNull

isNull

replaceNulls

getByte

getShort

getInt

getLong

getFloat

getDouble

getBoolean

getJavaString

year

month

day

hour

minute

second

unaryOp

sin

cos

tan

arcsin

arccos

arctan

exp

log

sqrt

ceil

floor

abs

bitInvert

binaryOp

slice

slice

sum

sum

min

min

max

max

product

product

sumOfSquares

sumOfSquares

standardDeviation

standardDeviation

reduce

reduce

not

castTo

asBytes

asShorts

asInts

asLongs

asFloats