Module tornado.api

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

Class TensorFP16

java.lang.Object

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

uk.ac.manchester.tornado.api.types.tensors.Tensor

uk.ac.manchester.tornado.api.types.tensors.TensorFP16

public final class TensorFP16
extends Tensor

TensorFP16 relies on preview features of the Java platform:

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

Programs can only use TensorFP16 when preview features are enabled.

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

Field Summary

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

ARRAY_HEADER

Constructor Summary

Constructors

Constructor	Description
TensorFP16(Shape shape)	The memory segment representing the tensor data in native memory.

Method Summary

Modifier and Type	Method	Description
protected void	clear()	Clears the contents of the native array.
static TensorFP16	concat(TensorFP16... arrays)	Concatenates multiple TensorFP16 instances into a single TensorFP16.
HalfFloat	get(int index)	Gets the half_float value stored at the specified index of the HalfFloatArray instance.
DType	getDType()
String	getDTypeAsString()
int	getElementSize()
long	getNumBytesOfSegment()	Returns the number of bytes of the MemorySegmentPREVIEW, excluding the header bytes.
long	getNumBytesOfSegmentWithHeader()	Returns the total number of bytes that the MemorySegmentPREVIEW occupies, including the header bytes.
MemorySegmentPREVIEW	getSegment()	Returns the underlying MemorySegmentPREVIEW of the native array, without the Tornado Array header.
MemorySegmentPREVIEW	getSegmentWithHeader()	Returns the underlying MemorySegmentPREVIEW of the native array, including the header.
Shape	getShape()
int	getSize()	Returns the number of elements stored in the native array.
void	init(HalfFloat value)
static void	initialize(TensorFP16 tensor, HalfFloat value)
void	set(int index, HalfFloat value)

Methods inherited from class java.lang.Object

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

Constructor Details

TensorFP16

public TensorFP16(Shape shape)

The memory segment representing the tensor data in native memory.

Method Details

init

public void init(HalfFloat value)

set

public void set(int index,
 HalfFloat value)

get

public HalfFloat get(int index)

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

Parameters:

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

Returns:

getSize

public int getSize()

Description copied from class: TornadoNativeArray

Returns the number of elements stored in the native array.

Specified by:

getSize in class TornadoNativeArray

Returns:

The number of elements of the native data array.

getSegment

public MemorySegmentPREVIEW getSegment()

Description copied from class: TornadoNativeArray

Returns the underlying MemorySegment^PREVIEW of the native array, without the Tornado Array header.

Specified by:

getSegment in class TornadoNativeArray

Returns:

The MemorySegment^PREVIEW associated with the native array instance.

getSegmentWithHeader

public MemorySegmentPREVIEW getSegmentWithHeader()

Description copied from class: TornadoNativeArray

Returns the underlying MemorySegment^PREVIEW of the native array, including the header.

Specified by:

getSegmentWithHeader in class TornadoNativeArray

Returns:

The MemorySegment^PREVIEW associated with the native array instance.

getNumBytesOfSegmentWithHeader

public long getNumBytesOfSegmentWithHeader()

Description copied from class: TornadoNativeArray

Returns the total number of bytes that the MemorySegment^PREVIEW occupies, including the header bytes.

Specified by:

getNumBytesOfSegmentWithHeader in class TornadoNativeArray

Returns:

The total number of bytes of the MemorySegment^PREVIEW.

getNumBytesOfSegment

public long getNumBytesOfSegment()

Description copied from class: TornadoNativeArray

Returns the number of bytes of the MemorySegment^PREVIEW, excluding the header bytes.

Specified by:

getNumBytesOfSegment in class TornadoNativeArray

Returns:

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

clear

protected void clear()

Description copied from class: TornadoNativeArray

Clears the contents of the native array.

Specified by:

clear in class TornadoNativeArray

getElementSize

public int getElementSize()

Specified by:

getElementSize in class TornadoNativeArray

getShape

public Shape getShape()

Specified by:

getShape in class Tensor

getDTypeAsString

public String getDTypeAsString()

Specified by:

getDTypeAsString in class Tensor

getDType

public DType getDType()

Specified by:

getDType in class Tensor

initialize

public static void initialize(TensorFP16 tensor,
 HalfFloat value)

concat

public static TensorFP16 concat(TensorFP16... arrays)

Concatenates multiple TensorFP16 instances into a single TensorFP16.

Parameters:

arrays - Variable number of TensorFP16 objects to be concatenated.

Returns:

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