ai.rapids.cudf

Class HostMemoryBuffer

java.lang.Object

ai.rapids.cudf.HostMemoryBuffer

All Implemented Interfaces:

AutoCloseable

public class HostMemoryBuffer
extends Object

This class represents an off-heap buffer held in the host memory. NOTE: Instances must be explicitly closed or native memory will be leaked!

Field Summary

Fields

Modifier and Type	Field and Description
protected long	address
protected boolean	closed
protected long	length

Method Summary

Modifier and Type	Method and Description
protected void	addressOutOfBoundsCheck(long address, long size, String type)
static HostMemoryBuffer	allocate(long bytes) Factory method to create this buffer
void	close() Close this buffer and free memory
void	copyFromHostBuffer(long destOffset, HostMemoryBuffer srcData, long srcOffset, long length) Copy the contents of the given buffer to this buffer
protected void	doClose() Actually close the buffer.
byte	getByte(long offset) Returns the byte value at that offset
void	getBytes(byte[] dst, long dstOffset, long srcOffset, long len) Copy a set of bytes to an array from the buffer starting at offset.
long	getLength() Returns the size of this buffer
void	setByte(long offset, byte value) Sets the byte value at that offset
void	setBytes(long offset, byte[] data, long srcOffset, long len) Copy a set of bytes from an array into the buffer at offset.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

address

protected final long address

length

protected final long length

closed

protected boolean closed

Method Detail

allocate

public static HostMemoryBuffer allocate(long bytes)

Factory method to create this buffer

Parameters:

bytes - - size in bytes to allocate

Returns:

- return this newly created buffer

copyFromHostBuffer

public final void copyFromHostBuffer(long destOffset,
                                     HostMemoryBuffer srcData,
                                     long srcOffset,
                                     long length)

Copy the contents of the given buffer to this buffer

Parameters:

destOffset - offset in bytes in this buffer to start copying to

srcData - Buffer to be copied from

srcOffset - offset in bytes to start copying from in srcData

length - number of bytes to copy

getByte

public final byte getByte(long offset)

Returns the byte value at that offset

Parameters:

offset - - offset from the address

Returns:

- value

setByte

public final void setByte(long offset,
                          byte value)

Sets the byte value at that offset

Parameters:

offset - - offset from the address

value - - value to be set

getBytes

public final void getBytes(byte[] dst,
                           long dstOffset,
                           long srcOffset,
                           long len)

Copy a set of bytes to an array from the buffer starting at offset.

Parameters:

dstOffset - the offset from the address to start copying to

dst - the data to be copied.

setBytes

public final void setBytes(long offset,
                           byte[] data,
                           long srcOffset,
                           long len)

Copy a set of bytes from an array into the buffer at offset.

Parameters:

offset - the offset from the address to start copying to

data - the data to be copied.

doClose

protected void doClose()

Actually close the buffer.

getLength

public long getLength()

Returns the size of this buffer

Returns:

- size

addressOutOfBoundsCheck

protected final void addressOutOfBoundsCheck(long address,
                                             long size,
                                             String type)

close

public final void close()

Close this buffer and free memory

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object