Module org.tensorflow.ndarray

Package org.tensorflow.ndarray.buffer

Interface FloatDataBuffer

All Superinterfaces:

DataBuffer<Float>

public interface FloatDataBuffer
extends DataBuffer<Float>

A DataBuffer of floats.

Method Summary

Modifier and Type	Method	Description
FloatDataBuffer	copyTo(DataBuffer<Float> dst, long size)	Write the references of the objects in the source array into this buffer.
float	getFloat(long index)	Reads the float at the given index.
default Float	getObject(long index)	Reads the value at the given index.
default FloatDataBuffer	narrow(long size)	Creates a new buffer whose content is a shared subsequence of this buffer's content, whose size is set to the given value.
default FloatDataBuffer	offset(long index)	Creates a new buffer whose content is a shared subsequence of this buffer's content, starting at the given index.
default FloatDataBuffer	read(float[] dst)	Bulk get method, using float arrays.
FloatDataBuffer	read(float[] dst, int offset, int length)	Bulk get method, using float arrays.
FloatDataBuffer	setFloat(float value, long index)	Writes the given float into this buffer at the given index.
default FloatDataBuffer	setObject(Float value, long index)	Writes the given value into this buffer at the given index.
FloatDataBuffer	slice(long index, long size)	Creates a new buffer whose content is a shared subsequence of this buffer's content, starting at the given index and of the given size.
default DataBufferWindow<FloatDataBuffer>	window(long size)	Creates a DataBufferWindow that provides a partial view of this buffer.
default FloatDataBuffer	write(float[] src)	Bulk put method, using float arrays.
FloatDataBuffer	write(float[] src, int offset, int length)	Bulk put method, using float arrays.

Methods inherited from interface org.tensorflow.ndarray.buffer.DataBuffer

accept, equals, isReadOnly, read, read, size, write, write

Method Detail

getFloat

float getFloat(long index)

Reads the float at the given index.

Parameters:

index - the index from which the float will be read

Returns:

the float at the given index

Throws:

IndexOutOfBoundsException - if index is negative or not smaller than the buffer size

setFloat

FloatDataBuffer setFloat(float value,
                         long index)

Writes the given float into this buffer at the given index.

Parameters:

value - the float to be written

index - the index at which the value will be written

Returns:

this buffer

Throws:

IndexOutOfBoundsException - if index is negative or not smaller than the buffer size

ReadOnlyBufferException - if this buffer is read-only

read

default FloatDataBuffer read(float[] dst)

Bulk get method, using float arrays.

This method transfers values from this buffer into the given destination array. If there are fewer values in the buffer than are required to satisfy the request, that is, if dst.length > size(), then no values are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies n = dst.length values from this buffer into the given array.

Parameters:

dst - the array into which values are to be written

Returns:

this buffer

Throws:

BufferUnderflowException - if there are not enough values to copy from this buffer

read

FloatDataBuffer read(float[] dst,
                     int offset,
                     int length)

Bulk get method, using float arrays.

This method transfers values from this buffer into the given destination array. If there are fewer values in the buffer than are required to satisfy the request, that is, if length > size(), then no values are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies n = length values from this buffer into the given array starting at the given offset.

Parameters:

dst - the array into which values are to be written

offset - the offset within the array of the first value to be written; must be non-negative and no larger than dst.length

length - the maximum number of values to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns:

this buffer

Throws:

BufferUnderflowException - if there are fewer than length values remaining in this buffer

IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold

write

default FloatDataBuffer write(float[] src)

Bulk put method, using float arrays.

This method transfers the values in the given source array into this buffer. If there are more values in the source array than in this buffer, that is, if src.length > size(), then no values are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = src.length values from the given array.

Parameters:

src - the source array from which values are to be read

Returns:

this buffer

Throws:

BufferOverflowException - if there is insufficient space in this buffer for the values in the source array

ReadOnlyBufferException - if this buffer is read-only

write

FloatDataBuffer write(float[] src,
                      int offset,
                      int length)

Bulk put method, using float arrays.

This method transfers the values in the given source array into this buffer. If there are more values in the source array than in this buffer, that is, if length > size(), then no values are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = length values from the given array into this buffer, starting at the given offset.

Parameters:

src - the source array from which values are to be read

offset - the offset within the array of the first value to be read; must be non-negative and no larger than src.length

length - the number of values to be read from the given array; must be non-negative and no larger than src.length - offset

Returns:

this buffer

Throws:

BufferOverflowException - if there is insufficient space in this buffer for the values in the source array

IndexOutOfBoundsException - if the preconditions on the offset and length parameters do not hold

ReadOnlyBufferException - if this buffer is read-only

getObject

default Float getObject(long index)

Description copied from interface: DataBuffer

Reads the value at the given index. Important: Usage of this method should be limited to buffers of non-primitive types or when the data type is not deterministically known by the caller. In any other case, prefer the usage of its primitive variant which will significantly improve performances (e.g. IntDataBuffer.getInt(idx)

Specified by:

getObject in interface DataBuffer<Float>

Parameters:

index - the index from which the float will be read

Returns:

the value at the given index

setObject

default FloatDataBuffer setObject(Float value,
                                  long index)

Description copied from interface: DataBuffer

Writes the given value into this buffer at the given index. Important: Usage of this method should be limited to buffers of non-primitive types or when the data type is not deterministically known by the caller. In any other case, prefer the usage of its primitive variant which will significantly improve performances (e.g. IntDataBuffer.setInt(idx)

Specified by:

setObject in interface DataBuffer<Float>

Parameters:

value - the value to be written

index - the index at which the value will be written

Returns:

this buffer

copyTo

FloatDataBuffer copyTo(DataBuffer<Float> dst,
                       long size)

Description copied from interface: DataBuffer

Write the references of the objects in the source array into this buffer.

If there are more values to copy than the destination buffer size, i.e. size > dst.size(), then no values are transferred and a BufferOverflowException is thrown. On the other hand, if there are more values to copy that the source buffer size, i.e. > src.size(), then a BufferUnderfloatException is thrown.

Otherwise, this method copies n = size values from this buffer into the destination buffer.

Specified by:

copyTo in interface DataBuffer<Float>

Parameters:

dst - the destination buffer into which values are copied; must not be this buffer

size - number of values to copy to the destination buffer

Returns:

this buffer

offset

default FloatDataBuffer offset(long index)

Description copied from interface: DataBuffer

Creates a new buffer whose content is a shared subsequence of this buffer's content, starting at the given index.

The index must not be greater than this buffer size. Changes to this buffer's content will be visible in the new buffer and vice versa. The new buffer will be read-only if, and only if, this buffer is read-only.

This call is equivalent to slice(index, size() - index)

Specified by:

offset in interface DataBuffer<Float>

Parameters:

index - index of the first value of the new buffer created, must not be greater than size()

Returns:

the new buffer

narrow

default FloatDataBuffer narrow(long size)

Description copied from interface: DataBuffer

Creates a new buffer whose content is a shared subsequence of this buffer's content, whose size is set to the given value.

The new size must not be greater than this buffer size. Changes to this buffer's content will be visible in the new buffer and vice versa. The new buffer will be read-only if, and only if, this buffer is read-only.

This call is equivalent to slice(0, size)

Specified by:

narrow in interface DataBuffer<Float>

Parameters:

size - size of this new buffer

Returns:

the new buffer

slice

FloatDataBuffer slice(long index,
                      long size)

Description copied from interface: DataBuffer

Creates a new buffer whose content is a shared subsequence of this buffer's content, starting at the given index and of the given size.

The index plus the new size must not be greater than this buffer size. Changes to this buffer's content will be visible in the new buffer and vice versa. The new buffer will be read-only if, and only if, this buffer is read-only.

Specified by:

slice in interface DataBuffer<Float>

Parameters:

index - index of the first value of the new buffer created

size - size of this new buffer, must not be greater than size()

Returns:

the new buffer

window

default DataBufferWindow<FloatDataBuffer> window(long size)

Description copied from interface: DataBuffer

Creates a DataBufferWindow that provides a partial view of this buffer.

The created window has a fixed size and can "slide" along this buffer to provide different views of the data without allocating a new buffer instance, like DataBuffer.offset(long) does. This improves overall performance when this operation is repeated frequently. For example:

 IntDataBuffer bufferA = DataBuffers.ofInts(1024);
 // ... init buffer data
 IntDataBuffer bufferB = DataBuffers.ofInts(1, 2, 3, 4);

 // Return the index of the first occurrence of bufferB in bufferA using a sliding window
 DataBufferWindow<IntDataBuffer> windowA = bufferA.window(4);
 for (int i = 0; i < bufferA.size() - bufferB.size(); ++i) {
     if (windowA.slideTo(i).buffer().equals(bufferB)) {
         return i;
     }
 }
 

The returned object is stateful and is not thread-safe.

Specified by:

window in interface DataBuffer<Float>

Parameters:

size - size of the window

Returns:

a new window that starts at the index 0 of this buffer