HostColumnVector (cudfjni 0.14 API)

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

All Implemented Interfaces:

AutoCloseable
```
public final class HostColumnVector
extends Object
implements AutoCloseable
```
Similar to a ColumnVector, but the data is stored in host memory and accessible directly from the JVM. 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 incRefCount to increment the reference count.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HostColumnVector.Builder` Build
`protected static class`	`HostColumnVector.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
`static HostColumnVector`	`boolFromBytes(byte... values)` Create a new vector from the given values.
`static HostColumnVector`	`build(DType type, int rows, java.util.function.Consumer<HostColumnVector.Builder> init)` Create a new vector.
`static HostColumnVector`	`build(int rows, long stringBufferSize, java.util.function.Consumer<HostColumnVector.Builder> init)`
`static HostColumnVector.Builder`	`builder(DType type, int rows)` Create a new Builder to hold the specified number of rows.
`static HostColumnVector.Builder`	`builder(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.
`void`	`close()` Close this Vector and free memory allocated for HostMemoryBuffer and DeviceMemoryBuffer
`ColumnVector`	`copyToDevice()` Copy the data to the device.
`static HostColumnVector`	`daysFromInts(int... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBoxedBooleans(Boolean... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBoxedBytes(Byte... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBoxedDoubles(Double... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBoxedFloats(Float... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBoxedInts(Integer... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBoxedLongs(Long... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBoxedShorts(Short... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromBytes(byte... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromDoubles(double... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromFloats(float... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromInts(int... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromLongs(long... values)` Create a new vector from the given values.
`static HostColumnVector`	`fromShorts(short... values)` Create a new vector from the given values.
`static HostColumnVector`	`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.
`double`	`getDouble(long index)` Get the value at index.
`float`	`getFloat(long index)` Get the value at index.
`HostMemoryBuffer`	`getHostBufferFor(BufferType type)` Get access to the raw host buffer for this column.
`long`	`getHostMemorySize()` Returns the amount of host memory used to store column/validity data (not metadata).
`int`	`getInt(long index)` Get the value at index.
`String`	`getJavaString(long index)` Get the value at index.
`long`	`getLong(long index)` Get the value at index.
`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.
`DType`	`getType()` Returns the type of this vector.
`byte[]`	`getUTF8(long index)` Get the raw UTF8 bytes at index.
`boolean`	`hasNulls()` Returns if the vector has nulls.
`boolean`	`hasValidityVector()` Returns if the vector has a validity vector allocated or not.
`HostColumnVector`	`incRefCount()` Increment the reference count for this column.
`boolean`	`isNull(long index)` Check if the value at index is null or not.
`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.
`static HostColumnVector`	`timestampDaysFromBoxedInts(Integer... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampMicroSecondsFromBoxedLongs(Long... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampMicroSecondsFromLongs(long... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampMilliSecondsFromBoxedLongs(Long... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampMilliSecondsFromLongs(long... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampNanoSecondsFromBoxedLongs(Long... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampNanoSecondsFromLongs(long... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampSecondsFromBoxedLongs(Long... values)` Create a new vector from the given values.
`static HostColumnVector`	`timestampSecondsFromLongs(long... values)` Create a new vector from the given values.
`String`	`toString()`

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

- Method Detail
  - noWarnLeakExpected
```
public 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 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 HostColumnVector 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.
  - getHostMemorySize
```
public long getHostMemorySize()
```
    Returns the amount of host memory used to store column/validity data (not metadata).
  - getType
```
public DType getType()
```
    Returns the type of this vector.
  - getNullCount
```
public long getNullCount()
```
    Returns the number of nulls in the data. Note that this might end up being a very expensive operation because if the null count is not known it will be calculated.
  - 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. Note that this might end up being a very expensive operation because if the null count is not known it will be calculated.
  - copyToDevice
```
public ColumnVector copyToDevice()
```
    Copy the data to the device.
  - isNull
```
public boolean isNull(long index)
```
    Check if the value at index is null or not.
  - getHostBufferFor
```
public HostMemoryBuffer getHostBufferFor(BufferType type)
```
    Get access to the raw host buffer for this column. This is intended to be used with a lot of caution. The lifetime of the buffer is tied to the lifetime of the column (Do not close the buffer, as the column will take care of it). Do not modify the contents of the buffer or it might negatively impact what happens on the column. The data must be on the host for this to work.
    
    Parameters:
    
    type - the type of buffer to get access to.
    
    Returns:
    
    the underlying buffer or null if no buffer is associated with it for this column. Please note that if the column is empty there may be no buffers at all associated with the column.
  - 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
  - getUTF8
```
public byte[] getUTF8(long index)
```
    Get the raw UTF8 bytes at index. This API is faster than getJavaString, but still not ideal because it is copying the data onto the heap.
  - 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.
  - builder
```
public static HostColumnVector.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 HostColumnVector.Builder builder(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:
    
    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 HostColumnVector build(DType type,
                                     int rows,
                                     java.util.function.Consumer<HostColumnVector.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 HostColumnVector build(int rows,
                                     long stringBufferSize,
                                     java.util.function.Consumer<HostColumnVector.Builder> init)
```
  - boolFromBytes
```
public static HostColumnVector boolFromBytes(byte... values)
```
    Create a new vector from the given values.
  - fromBytes
```
public static HostColumnVector fromBytes(byte... values)
```
    Create a new vector from the given values.
  - fromShorts
```
public static HostColumnVector fromShorts(short... values)
```
    Create a new vector from the given values.
  - fromInts
```
public static HostColumnVector fromInts(int... values)
```
    Create a new vector from the given values.
  - fromLongs
```
public static HostColumnVector fromLongs(long... values)
```
    Create a new vector from the given values.
  - fromFloats
```
public static HostColumnVector fromFloats(float... values)
```
    Create a new vector from the given values.
  - fromDoubles
```
public static HostColumnVector fromDoubles(double... values)
```
    Create a new vector from the given values.
  - daysFromInts
```
public static HostColumnVector daysFromInts(int... values)
```
    Create a new vector from the given values.
  - timestampSecondsFromLongs
```
public static HostColumnVector timestampSecondsFromLongs(long... values)
```
    Create a new vector from the given values.
  - timestampMilliSecondsFromLongs
```
public static HostColumnVector timestampMilliSecondsFromLongs(long... values)
```
    Create a new vector from the given values.
  - timestampMicroSecondsFromLongs
```
public static HostColumnVector timestampMicroSecondsFromLongs(long... values)
```
    Create a new vector from the given values.
  - timestampNanoSecondsFromLongs
```
public static HostColumnVector timestampNanoSecondsFromLongs(long... values)
```
    Create a new vector from the given values.
  - fromStrings
```
public static HostColumnVector 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 HostColumnVector 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 HostColumnVector 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 HostColumnVector 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 HostColumnVector 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 HostColumnVector 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 HostColumnVector 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 HostColumnVector 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.
  - timestampDaysFromBoxedInts
```
public static HostColumnVector timestampDaysFromBoxedInts(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.
  - timestampSecondsFromBoxedLongs
```
public static HostColumnVector timestampSecondsFromBoxedLongs(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.
  - timestampMilliSecondsFromBoxedLongs
```
public static HostColumnVector timestampMilliSecondsFromBoxedLongs(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.
  - timestampMicroSecondsFromBoxedLongs
```
public static HostColumnVector timestampMicroSecondsFromBoxedLongs(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.
  - timestampNanoSecondsFromBoxedLongs
```
public static HostColumnVector timestampNanoSecondsFromBoxedLongs(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.

Class HostColumnVector

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

noWarnLeakExpected

close

toString

incRefCount

getRowCount

getHostMemorySize

getType

getNullCount

hasValidityVector

hasNulls

copyToDevice

isNull

getHostBufferFor

getByte

getShort

getInt

getLong

getFloat

getDouble

getBoolean

getUTF8

getJavaString

builder

builder

build

build

boolFromBytes

fromBytes

fromShorts

fromInts

fromLongs

fromFloats

fromDoubles

daysFromInts

timestampSecondsFromLongs

timestampMilliSecondsFromLongs

timestampMicroSecondsFromLongs

timestampNanoSecondsFromLongs

fromStrings

fromBoxedBooleans

fromBoxedBytes

fromBoxedShorts

fromBoxedInts

fromBoxedLongs

fromBoxedFloats

fromBoxedDoubles

timestampDaysFromBoxedInts

timestampSecondsFromBoxedLongs

timestampMilliSecondsFromBoxedLongs

timestampMicroSecondsFromBoxedLongs

timestampNanoSecondsFromBoxedLongs