Module tornado.api

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

Class DoubleArray

java.lang.Object

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

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

public final class DoubleArray
extends TornadoNativeArray

DoubleArray relies on preview features of the Java platform:

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

Programs can only use DoubleArray 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 doubles stored in native memory. The double 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 double values, for initializing the double 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
DoubleArray(int numberOfElements)	Constructs a new instance of the DoubleArray that will store a user-specified number of elements.
DoubleArray(DoubleArray... arrays)	Constructs a new DoubleArray instance by concatenating the contents of the given array of DoubleArray instances.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DoubleArray

public DoubleArray(int numberOfElements)

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

Parameters:

numberOfElements - The number of elements in the array.

DoubleArray

public DoubleArray(DoubleArray... arrays)

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

Parameters:

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

Method Details

fromArray

public static DoubleArray fromArray(double[] values)

Creates a new instance of the DoubleArray class from an on-heap double array.

Parameters:

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

Returns:

A new DoubleArray instance, initialized with values of the on-heap double array.

fromElements

public static DoubleArray fromElements(double... values)

Creates a new instance of the DoubleArray class from a set of double values.

Parameters:

values - The double values to initialize the array with.

Returns:

A new DoubleArray instance, initialized with the given values.

fromSegment

public static DoubleArray fromSegment(MemorySegmentPREVIEW segment)

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

Parameters:

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

Returns:

A new DoubleArray instance, initialized with the segment data.

fromSegmentShallow

public static DoubleArray fromSegmentShallow(MemorySegmentPREVIEW segment)

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

Parameters:

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

Returns:

A new DoubleArray instance that wraps the given segment.

fromDoubleBuffer

public static DoubleArray fromDoubleBuffer(DoubleBuffer buffer)

Creates a new instance of the DoubleArray class from a DoubleBuffer.

Parameters:

buffer - The DoubleBuffer containing the double data.

Returns:

A new DoubleArray instance, initialized with the buffer data.

toHeapArray

public double[] toHeapArray()

Converts the double data from off-heap to on-heap, by copying the values of a DoubleArray instance into a new on-heap array.

Returns:

A new on-heap double array, initialized with the values stored in the DoubleArray instance.

set

public void set(int index,
 double value)

Sets the double value at a specified index of the DoubleArray instance.

Parameters:

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

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

get

public double get(int index)

Gets the double value stored at the specified index of the DoubleArray instance.

Parameters:

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

Returns:

clear

public void clear()

Sets all the values of the DoubleArray instance to zero.

Specified by:

clear in class TornadoNativeArray

getElementSize

public int getElementSize()

Specified by:

getElementSize in class TornadoNativeArray

init

public void init(double value)

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

Parameters:

value - The double value to initialize the DoubleArray instance with.

getSize

public int getSize()

Returns the number of double elements stored in the DoubleArray instance.

Specified by:

getSize in class TornadoNativeArray

Returns:

getSegment

public MemorySegmentPREVIEW getSegment()

Returns the underlying MemorySegment^PREVIEW of the DoubleArray instance.

Specified by:

getSegment in class TornadoNativeArray

Returns:

The MemorySegment^PREVIEW associated with the DoubleArray instance.

getSegmentWithHeader

public MemorySegmentPREVIEW getSegmentWithHeader()

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

Specified by:

getSegmentWithHeader in class TornadoNativeArray

Returns:

The MemorySegment^PREVIEW associated with the DoubleArray instance.

getNumBytesOfSegmentWithHeader

public long getNumBytesOfSegmentWithHeader()

Returns the total number of bytes that the MemorySegment^PREVIEW, associated with the DoubleArray 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 DoubleArray 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(DoubleArray array,
 double value)

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

Parameters:

array - Input Array.

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

concat

public static DoubleArray concat(DoubleArray... arrays)

Concatenates multiple DoubleArray instances into a single DoubleArray.

Parameters:

arrays - Variable number of DoubleArray objects to be concatenated.

Returns:

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

slice

public DoubleArray slice(int offset,
 int length)

Extracts a slice of elements from a given DoubleArray, creating a new DoubleArray 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 DoubleArray instance representing the specified slice of the original array.

Throws:

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