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

Class CharArray

java.lang.Object
uk.ac.manchester.tornado.api.types.arrays.TornadoNativeArray
uk.ac.manchester.tornado.api.types.arrays.CharArray
public final class CharArray extends TornadoNativeArray
CharArray relies on preview features of the Java platform:
Programs can only use CharArray 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 characters stored in native memory. The char data is stored in a MemorySegmentPREVIEW, which represents a contiguous region of off-heap memory. The class also encapsulates methods for setting and getting char values, for initializing the char array, and for converting the array to and from different representations.

  • Constructor Details

    • CharArray

      public CharArray(int numberOfElements)
      Constructs a new instance of the CharArray that will store a user-specified number of elements.
      Parameters:
      numberOfElements - The number of elements in the array.

    • CharArray

      public CharArray(CharArray... arrays)
      Constructs a new CharArray instance by concatenating the contents of the given array of CharArray instances.
      Parameters:
      arrays - An array of CharArray instances to be concatenated into the new instance.

  • Method Details

    • fromArray

      public static CharArray fromArray(char[] values)
      Creates a new instance of the CharArray class from an on-heap char array.
      Parameters:
      values - The on-heap char array to create the instance from.
      Returns:
      A new CharArray instance, initialized with values of the on-heap char array.

    • fromElements

      public static CharArray fromElements(char... values)
      Creates a new instance of the CharArray class from a set of char values.
      Parameters:
      values - The char values to initialize the array with.
      Returns:
      A new CharArray instance, initialized with the given values.

    • fromSegment

      public static CharArray fromSegment(MemorySegmentPREVIEW segment)
      Creates a new instance of the CharArray class from a MemorySegmentPREVIEW.
      Parameters:
      segment - The MemorySegmentPREVIEW containing the off-heap char data.
      Returns:
      A new CharArray instance, initialized with the segment data.

    • fromSegmentShallow

      public static CharArray fromSegmentShallow(MemorySegmentPREVIEW segment)
      Creates a new instance of the CharArray class by wrapping an existing MemorySegmentPREVIEW without copying its contents.
      Parameters:
      segment - The MemorySegmentPREVIEW containing *both* the off-heap char *header* and *data*.
      Returns:
      A new CharArray instance that wraps the given segment.

    • fromCharBuffer

      public static CharArray fromCharBuffer(CharBuffer buffer)
      Creates a new instance of the CharArray class from a CharBuffer.
      Parameters:
      buffer - The CharBuffer containing the float data.
      Returns:
      A new CharArray instance, initialized with the buffer data.

    • clear

      public void clear()
      Sets all the values of the CharArray instance to , the default char value.
      Specified by:
      clear in class TornadoNativeArray

    • getElementSize

      public int getElementSize()
      Specified by:
      getElementSize in class TornadoNativeArray

    • toHeapArray

      public char[] toHeapArray()
      Converts the char data from off-heap to on-heap, by copying the values of a CharArray instance into a new on-heap array.
      Returns:
      A new on-heap char array, initialized with the values stored in the CharArray instance.

    • set

      public void set(int index, char value)
      Sets the char value at a specified index of the CharArray instance.
      Parameters:
      index - The index at which to set the char value.
      value - The char value to store at the specified index.

    • get

      public char get(int index)
      Gets the char value stored at the specified index of the CharArray instance.
      Parameters:
      index - The index of which to retrieve the char value.
      Returns:

    • init

      public void init(char value)
      Initializes all the elements of the CharArray instance with a specified value.
      Parameters:
      value - The char value to initialize the ByteArray instance with.

    • getSize

      public int getSize()
      Returns the number of char elements stored in the CharArray instance.
      Specified by:
      getSize in class TornadoNativeArray
      Returns:

    • getSegment

      public MemorySegmentPREVIEW getSegment()
      Returns the underlying MemorySegmentPREVIEW of the CharArray instance.
      Specified by:
      getSegment in class TornadoNativeArray
      Returns:
      The MemorySegmentPREVIEW associated with the CharArray instance.

    • getSegmentWithHeader

      public MemorySegmentPREVIEW getSegmentWithHeader()
      Returns the underlying MemorySegmentPREVIEW of the CharArray instance, including the header.
      Specified by:
      getSegmentWithHeader in class TornadoNativeArray
      Returns:
      The MemorySegmentPREVIEW associated with the CharArray instance.

    • getNumBytesOfSegmentWithHeader

      public long getNumBytesOfSegmentWithHeader()
      Returns the total number of bytes that the MemorySegmentPREVIEW, associated with the CharArray instance, occupies.
      Specified by:
      getNumBytesOfSegmentWithHeader in class TornadoNativeArray
      Returns:
      The total number of bytes of the MemorySegmentPREVIEW.

    • getNumBytesOfSegment

      public long getNumBytesOfSegment()
      Returns the number of bytes of the MemorySegmentPREVIEW that is associated with the CharArray instance, excluding the header bytes.
      Specified by:
      getNumBytesOfSegment in class TornadoNativeArray
      Returns:
      The number of bytes of the raw data in the MemorySegmentPREVIEW.

    • initialize

      public static void initialize(CharArray array, char value)
      Factory method to initialize a CharArray. This method can be invoked from a Task-Graph.
      Parameters:
      array - Input Array.
      value - The float value to initialize the CharArray instance with.

    • concat

      public static CharArray concat(CharArray... arrays)
      Concatenates multiple CharArray instances into a single CharArray.
      Parameters:
      arrays - Variable number of CharArray objects to be concatenated.
      Returns:
      A new CharArray instance containing all the elements of the input arrays, concatenated in the order they were provided.

    • slice

      public CharArray slice(int offset, int length)
      Extracts a slice of elements from a given CharArray, creating a new CharArray 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 CharArray instance representing the specified slice of the original array.
      Throws:
      IllegalArgumentException - if the specified slice is out of the bounds of the original array.