Introduce Tensor API, Tensor Utilities and compatiblity with ONNX RT

pom.xml

@@ -2002,6 +2002,11 @@
     </build>
     <dependencyManagement>
         <dependencies>
+            <dependency>
+                <groupId>com.microsoft.onnxruntime</groupId>
+                <artifactId>onnxruntime</artifactId>
+                <version>1.17.1</version>
+            </dependency>
             <dependency>
                 <groupId>com.puppycrawl.tools</groupId>
                 <artifactId>checkstyle</artifactId>

tornado-api/src/main/java/module-info.java

@@ -46,6 +46,8 @@
     exports uk.ac.manchester.tornado.api.types.vectors;
     opens uk.ac.manchester.tornado.api.types.vectors;
     exports uk.ac.manchester.tornado.api.types;
+    exports uk.ac.manchester.tornado.api.types.tensors;
+    opens uk.ac.manchester.tornado.api.types.tensors;
     opens uk.ac.manchester.tornado.api.types;
     opens uk.ac.manchester.tornado.api.runtime;
 }

tornado-api/src/main/java/uk/ac/manchester/tornado/api/types/HalfFloat.java

@@ -49,24 +49,6 @@ public HalfFloat(short halfFloat) {
         this.halfFloatValue = halfFloat;
     }
 
-    /**
-     * Gets the half-float stored in the class.
-     *
-     * @return The half float value stored in the {@code HalfFloat} object.
-     */
-    public short getHalfFloatValue() {
-        return this.halfFloatValue;
-    }
-
-    /**
-     * Gets the half-float stored in the class in a 32-bit representation.
-     *
-     * @return The float-32 equivalent value the half float stored in the {@code HalfFloat} object.
-     */
-    public float getFloat32() {
-        return Float.float16ToFloat(halfFloatValue);
-    }
-
     /**
      * Takes two half float values, converts them to a 32-bit representation and performs an addition.
      *
@@ -187,4 +169,27 @@ public static HalfFloat div(HalfFloat a, HalfFloat b) {
         return new HalfFloat(result);
     }
 
+    /**
+     * Gets the half-float stored in the class.
+     *
+     * @return The half float value stored in the {@code HalfFloat} object.
+     */
+    public short getHalfFloatValue() {
+        return this.halfFloatValue;
+    }
+
+    /**
+     * Gets the half-float stored in the class in a 32-bit representation.
+     *
+     * @return The float-32 equivalent value the half float stored in the {@code HalfFloat} object.
+     */
+    public float getFloat32() {
+        return Float.float16ToFloat(halfFloatValue);
+    }
+
+    @Override
+    public String toString() {
+        return String.format("HalfFloat: %.4f", getFloat32());
+    }
+
 }

tornado-api/src/main/java/uk/ac/manchester/tornado/api/types/arrays/HalfFloatArray.java

@@ -112,7 +112,7 @@ public static HalfFloatArray fromSegment(MemorySegment segment) {
         long byteSize = segment.byteSize();
         int numElements = (int) (byteSize / HALF_FLOAT_BYTES);
         HalfFloatArray halfFloatArray = new HalfFloatArray(numElements);
-        MemorySegment.copy(segment, 0, halfFloatArray.segment, halfFloatArray.baseIndex * HALF_FLOAT_BYTES, byteSize);
+        MemorySegment.copy(segment, 0, halfFloatArray.segment, (long) halfFloatArray.baseIndex * HALF_FLOAT_BYTES, byteSize);
         return halfFloatArray;
     }
 

tornado-api/src/main/java/uk/ac/manchester/tornado/api/types/arrays/TornadoNativeArray.java

@@ -19,6 +19,8 @@
 
 import java.lang.foreign.MemorySegment;
 
+import uk.ac.manchester.tornado.api.types.tensors.Tensor;
+
 /**
  * This abstract sealed class represents the common functionality of the TornadoVM custom native arrays,
  * (e.g., {@link ByteArray}, {@link IntArray}, etc.)
@@ -33,7 +35,10 @@
  * The constant {@link ARRAY_HEADER} represents the size of the header in bytes.
  * </p>
  */
-public abstract sealed class TornadoNativeArray permits ByteArray, CharArray, DoubleArray, FloatArray, IntArray, LongArray, ShortArray, HalfFloatArray {
+public abstract sealed class TornadoNativeArray //
+        permits ByteArray, CharArray, DoubleArray, //
+        FloatArray, HalfFloatArray, IntArray, //
+        LongArray, ShortArray, Tensor {
 
     /**
      * The size of the header in bytes. The default value is 24, but it can be configurable through

tornado-api/src/main/java/uk/ac/manchester/tornado/api/types/tensors/DType.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2024, APT Group, Department of Computer Science,
+ * The University of Manchester.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package uk.ac.manchester.tornado.api.types.tensors;
+
+import java.lang.foreign.ValueLayout;
+
+/**
+ * The {@code DType} enum represents the various data types can be found in models.
+ */
+public enum DType {
+    // @formatter:off
+    /**
+     * Represents a half-precision floating-point data type using 2 bytes.
+     */
+    HALF_FLOAT(2, ValueLayout.JAVA_SHORT),
+    /**
+     * Represents a single-precision 32-bit IEEE floating-point data type using 4 bytes.
+     */
+    FLOAT(4, ValueLayout.JAVA_FLOAT),
+    /**
+     * Represents a double-precision 64-bit IEEE floating-point data type using 8 bytes.
+     */
+    DOUBLE(8, ValueLayout.JAVA_DOUBLE),
+    /**
+     * Represents an 8-bit signed integer data type using 1 byte.
+     */
+    INT8(1, ValueLayout.JAVA_BYTE),
+    /**
+     * Represents a 16-bit signed integer data type using 2 bytes.
+     */
+    INT16(2, ValueLayout.JAVA_SHORT),
+    /**
+     * Represents a 32-bit signed integer data type using 4 bytes.
+     */
+    INT32(4, ValueLayout.JAVA_INT),
+    /**
+     * Represents a 64-bit signed integer data type using 8 bytes.
+     */
+    INT64(8, ValueLayout.JAVA_LONG),
+    /**
+     * Represents an 8-bit unsigned integer data type using 1 byte.
+     */
+    UINT8(1, ValueLayout.JAVA_BYTE),
+    /**
+     * Represents a boolean data type using 1 byte for true/false values.
+     */
+    BOOL(1, ValueLayout.JAVA_BYTE),
+    /**
+     * Represents a quantized 8-bit signed integer used in specialized applications like machine learning, using 1 byte.
+     */
+    QINT8(1, ValueLayout.JAVA_BYTE),
+    /**
+     * Represents a quantized 8-bit unsigned integer used in specialized applications like machine learning, using 1 byte.
+     */
+    QUINT8(1, ValueLayout.JAVA_BYTE);
+    // @formatter:on
+
+    /**
+     * The size of the data type in bytes.
+     */
+    private final int size;
+
+    /**
+     * The layout of the data type in memory.
+     */
+    private final ValueLayout layout;
+
+    /**
+     * Constructs an instance of the enum constant with the specified size and memory layout.
+     *
+     * @param size
+     *     The size of the data type in bytes.
+     * @param layout
+     *     The {@link ValueLayout} specifying how the data is laid out in memory.
+     */
+    DType(int size, ValueLayout layout) {
+        this.size = size;
+        this.layout = layout;
+    }
+
+    /**
+     * Returns the size of the data type in bytes.
+     *
+     * @return The size of the data type.
+     */
+    public int getByteSize() {
+        return size;
+    }
+
+    /**
+     * Returns the {@link ValueLayout} of the data type, which describes how the data is laid out in memory.
+     *
+     * @return The memory layout of the data type.
+     */
+    public ValueLayout getLayout() {
+        return layout;
+    }
+
+}

tornado-api/src/main/java/uk/ac/manchester/tornado/api/types/tensors/Shape.java

@@ -0,0 +1,108 @@
+/*
+ * Copyright (c) 2024, APT Group, Department of Computer Science,
+ * The University of Manchester.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package uk.ac.manchester.tornado.api.types.tensors;
+
+import java.util.Arrays;
+
+public record Shape(long... dimensions) {
+
+    /**
+     * Returns the rank of the shape, which is the number of dimensions.
+     *
+     * @return the number of dimensions of the shape
+     */
+    public int getRank() {
+        return dimensions.length;
+    }
+
+    /**
+     * Returns of the dimensions of the shape.
+     *
+     * @return an array of long values representing the dimensions of the shape
+     */
+    public long[] getDimensions() {
+        return dimensions;
+    }
+
+    /**
+     * Calculates and returns the size of the shape, which is the product of all its dimensions.
+     *
+     * @return the total size of the shape as an int
+     */
+    public int getSize() {
+        return (int) Arrays.stream(dimensions).reduce(1, (a, b) -> a * b);
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o)
+            return true;
+        if (o == null || getClass() != o.getClass())
+            return false;
+        Shape shape = (Shape) o;
+        return Arrays.equals(dimensions, shape.dimensions);
+    }
+
+    @Override
+    public int hashCode() {
+        return Arrays.hashCode(dimensions);
+    }
+
+    @Override
+    public String toString() {
+        return STR."Shape{dimensions=\{Arrays.toString(dimensions)}}";
+    }
+
+    /**
+     * Generates a string representation of the shape compatible with TensorFlow's shape format.
+     *
+     * @return a string representing the shape in TensorFlow's format
+     */
+
+    public String toTensorFlowShapeString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append("[");
+        for (int i = 0; i < dimensions.length; i++) {
+            sb.append(dimensions[i]);
+            if (i < dimensions.length - 1) {
+                sb.append(",");
+            }
+        }
+        sb.append("]");
+        return sb.toString();
+    }
+
+    /**
+     * Generates a string representation of the shape compatible with ONNX's shape format.
+     *
+     * @return a string representing the shape in ONNX's format
+     */
+    public String toONNXShapeString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append("{");
+        for (int i = 0; i < dimensions.length; i++) {
+            sb.append("dim_").append(i).append(": ").append(dimensions[i]);
+            if (i < dimensions.length - 1) {
+                sb.append(", ");
+            }
+        }
+        sb.append("}");
+        return sb.toString();
+    }
+
+}

tornado-api/src/main/java/uk/ac/manchester/tornado/api/types/tensors/Tensor.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2024, APT Group, Department of Computer Science,
+ * The University of Manchester.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package uk.ac.manchester.tornado.api.types.tensors;
+
+import uk.ac.manchester.tornado.api.types.arrays.TornadoNativeArray;
+
+public abstract non-sealed class Tensor extends TornadoNativeArray {
+    private final DType dtype;
+    private final Shape shape;
+
+    protected Tensor(DType dtype, Shape shape) {
+        this.dtype = dtype;
+        this.shape = shape;
+    }
+
+    public abstract Shape getShape();
+
+    public abstract String getDTypeAsString();
+
+    public abstract DType getDType();
+
+}