Module tornado.api

Package uk.ac.manchester.tornado.api.types.arrays

Class HalfFloatArray

java.lang.Object

uk.ac.manchester.tornado.api.types.arrays.TornadoNativeArray

uk.ac.manchester.tornado.api.types.arrays.HalfFloatArray

public final class HalfFloatArray
extends TornadoNativeArray

HalfFloatArray relies on preview features of the Java platform:

• HalfFloatArray refers to one or more preview APIs: MemorySegment.

Programs can only use HalfFloatArray when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

This class represents an array of half floats (float16 types) stored in native memory. The half float data is stored in a MemorySegment^PREVIEW, which represents a contiguous region of off-heap memory. The class also encapsulates methods for setting and getting half float values, for initializing the half float array, and for converting the array to and from different representations.

Field Summary

Fields inherited from class uk.ac.manchester.tornado.api.types.arrays.TornadoNativeArray

ARRAY_HEADER

Constructor Summary

Constructors

Constructor	Description
HalfFloatArray(int numberOfElements)	Constructs a new instance of the HalfFloatArray that will store a user-specified number of elements.
HalfFloatArray(HalfFloatArray... arrays)	Constructs a new HalfFloatArray instance by concatenating the contents of the given array of HalfFloatArray instances.

Method Summary

Modifier and Type	Method	Description
void	clear()	Sets all the values of the HalfFloatArray instance to zero.
static HalfFloatArray	concat(HalfFloatArray... arrays)	Concatenates multiple HalfFloatArray instances into a single HalfFloatArray.
static HalfFloatArray	fromArray(HalfFloat[] values)	Creates a new instance of the HalfFloatArray class from an on-heap HalfFloat.
static HalfFloatArray	fromElements(HalfFloat... values)	Creates a new instance of the HalfFloatArray class from a set of HalfFloat values.
static HalfFloatArray	fromSegment(MemorySegmentPREVIEW segment)	Creates a new instance of the HalfFloatArray class from a MemorySegmentPREVIEW.
static HalfFloatArray	fromSegmentShallow(MemorySegmentPREVIEW segment)	Creates a new instance of the HalfFloatArray class by wrapping an existing MemorySegmentPREVIEW without copying its contents.
HalfFloat	get(int index)	Gets the HalfFloat value stored at the specified index of the HalfFloatArray instance.
int	getElementSize()
long	getNumBytesOfSegment()	Returns the number of bytes of the MemorySegmentPREVIEW that is associated with the HalfFloatArray instance, excluding the header bytes.
long	getNumBytesOfSegmentWithHeader()	Returns the total number of bytes that the MemorySegmentPREVIEW, associated with the HalfFloatArray instance, occupies.
MemorySegmentPREVIEW	getSegment()	Returns the underlying MemorySegmentPREVIEW of the HalfFloatArray instance.
MemorySegmentPREVIEW	getSegmentWithHeader()	Returns the underlying MemorySegmentPREVIEW of the HalfFloatArray instance, including the header.
int	getSize()	Returns the number of half float elements stored in the HalfFloatArray instance.
void	init(HalfFloat value)	Initializes all the elements of the HalfFloatArray instance with a specified value.
static void	initialize(HalfFloatArray array, HalfFloat value)	Factory method to initialize a HalfFloatArray.
void	set(int index, HalfFloat value)	Sets the HalfFloat value at a specified index of the HalfFloatArray instance.
HalfFloatArray	slice(int offset, int length)	Extracts a slice of elements from a given , creating a new instance.
HalfFloat[]	toHeapArray()	Converts the HalfFloat data from off-heap to on-heap, by copying the values of a HalfFloatArray instance into a new on-heap HalfFloat.
short[]	toShortArray()	Converts the HalfFloat data from off-heap to an on-heap short representation, by getting the values of a HalfFloatArray instance as short and coping them into a new on-heap short array.

Methods inherited from class java.lang.Object

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

Constructor Details

HalfFloatArray

public HalfFloatArray(int numberOfElements)

Constructs a new instance of the HalfFloatArray that will store a user-specified number of elements.

Parameters:

numberOfElements - The number of elements in the array.

HalfFloatArray

public HalfFloatArray(HalfFloatArray... arrays)

Constructs a new HalfFloatArray instance by concatenating the contents of the given array of HalfFloatArray instances.

Parameters:

arrays - An array of HalfFloatArray instances to be concatenated into the new instance.

Method Details

fromArray

public static HalfFloatArray fromArray(HalfFloat[] values)

Creates a new instance of the HalfFloatArray class from an on-heap HalfFloat.

Parameters:

values - The on-heap HalfFloat array to create the instance from.

Returns:

A new HalfFloatArray instance, initialized with values of the on-heap HalfFloat array.

fromElements

public static HalfFloatArray fromElements(HalfFloat... values)

Creates a new instance of the HalfFloatArray class from a set of HalfFloat values.

Parameters:

values - The HalfFloat values to initialize the array with.

Returns:

A new instance, initialized with the given values.

fromSegment

public static HalfFloatArray fromSegment(MemorySegmentPREVIEW segment)

Creates a new instance of the HalfFloatArray class from a MemorySegment^PREVIEW.

Parameters:

segment - The MemorySegment^PREVIEW containing the off-heap half float data.

Returns:

A new HalfFloatArray instance, initialized with the segment data.

fromSegmentShallow

public static HalfFloatArray fromSegmentShallow(MemorySegmentPREVIEW segment)

Creates a new instance of the HalfFloatArray class by wrapping an existing MemorySegment^PREVIEW without copying its contents.

Parameters:

segment - The MemorySegment^PREVIEW containing *both* the off-heap half-float *header* and *data*.

Returns:

A new HalfFloatArray instance that wraps the given segment.

toHeapArray

public HalfFloat[] toHeapArray()

Converts the HalfFloat data from off-heap to on-heap, by copying the values of a HalfFloatArray instance into a new on-heap HalfFloat.

Returns:

A new on-heap HalfFloat array, initialized with the values stored in the HalfFloatArray instance.

toShortArray

public short[] toShortArray()

Converts the HalfFloat data from off-heap to an on-heap short representation, by getting the values of a HalfFloatArray instance as short and coping them into a new on-heap short array.

Returns:

A new on-heap short array, initialized with the values stored in the HalfFloatArray instance.

set

public void set(int index,
 HalfFloat value)

Sets the HalfFloat value at a specified index of the HalfFloatArray instance.

Parameters:

index - The index at which to set the HalfFloat value.

value - The HalfFloat value to store at the specified index.

get

public HalfFloat get(int index)

Gets the HalfFloat value stored at the specified index of the HalfFloatArray instance.

Parameters:

index - The index of which to retrieve the HalfFloat value.

Returns:

clear

public void clear()

Sets all the values of the HalfFloatArray instance to zero.

Specified by:

clear in class TornadoNativeArray

getElementSize

public int getElementSize()

Specified by:

getElementSize in class TornadoNativeArray

init

public void init(HalfFloat value)

Initializes all the elements of the HalfFloatArray instance with a specified value.

Parameters:

value - The HalfFloat value to initialize the HalfFloatArray instance with.

getSize

public int getSize()

Returns the number of half float elements stored in the HalfFloatArray instance.

Specified by:

getSize in class TornadoNativeArray

Returns:

getSegment

public MemorySegmentPREVIEW getSegment()

Returns the underlying MemorySegment^PREVIEW of the HalfFloatArray instance.

Specified by:

getSegment in class TornadoNativeArray

Returns:

The MemorySegment^PREVIEW associated with the HalfFloatArray instance.

getSegmentWithHeader

public MemorySegmentPREVIEW getSegmentWithHeader()

Returns the underlying MemorySegment^PREVIEW of the HalfFloatArray instance, including the header.

Specified by:

getSegmentWithHeader in class TornadoNativeArray

Returns:

The MemorySegment^PREVIEW associated with the HalfFloatArray instance.

getNumBytesOfSegmentWithHeader

public long getNumBytesOfSegmentWithHeader()

Returns the total number of bytes that the MemorySegment^PREVIEW, associated with the HalfFloatArray instance, occupies.

Specified by:

getNumBytesOfSegmentWithHeader in class TornadoNativeArray

Returns:

The total number of bytes of the MemorySegment^PREVIEW.

getNumBytesOfSegment

public long getNumBytesOfSegment()

Returns the number of bytes of the MemorySegment^PREVIEW that is associated with the HalfFloatArray instance, excluding the header bytes.

Specified by:

getNumBytesOfSegment in class TornadoNativeArray

Returns:

The number of bytes of the raw data in the MemorySegment^PREVIEW.

initialize

public static void initialize(HalfFloatArray array,
 HalfFloat value)

Factory method to initialize a HalfFloatArray. This method can be invoked from a Task-Graph.

Parameters:

array - Input Array.

value - The float value to initialize the HalfFloatArray instance with.

concat

public static HalfFloatArray concat(HalfFloatArray... arrays)

Concatenates multiple HalfFloatArray instances into a single HalfFloatArray.

Parameters:

arrays - Variable number of HalfFloatArray objects to be concatenated.

Returns:

A new HalfFloatArray instance containing all the elements of the input arrays, concatenated in the order they were provided.

slice

public HalfFloatArray slice(int offset,
 int length)

Extracts a slice of elements from a given , creating a new instance.

Parameters:

offset - The starting index from which to begin the slice, inclusive.

length - The number of elements to include in the slice.

Returns:

A new instance representing the specified slice of the original array.

Throws:

IllegalArgumentException - if the specified slice is out of the bounds of the original array.