Class TensorReader

java.lang.Object
org.flag4j.io.TensorReader
public final class TensorReader extends Object
The TensorReader class provides several static methods for reading serialized tensors, matrices, and vectors from a file.

  • Method Details

    • read

      public static AbstractTensor<?,?,?> read(String filePath) throws IOException, ClassNotFoundException

      Reads a serialized AbstractTensor from a specified file using a ObjectInputStream.

      The object returned from this tensor will likely need to be cast to the desired type: 

      
      Matrix matrix;
      try {
          matrix = (Matrix) TensorReader.read("some_file.ser")
      } catch(IOException | ClassNotFoundException | ClassCastException e) {
          // Handel exception.
      }
      Parameters:
      filePath - Path of the file containing the serialized tensor.
      Returns:
      The deserialized tensor from the specified file.
      Throws:
      IOException - If an I/O exception occurs while reading the object.
      ClassNotFoundException - Class of a serialized object cannot be found.

    • fromCsv

      public static MatrixMixin<?,?,?,?> fromCsv(String fileName, Class<? extends MatrixMixin<?,?,?,?>> matrixType) throws IOException

      Reads a CSV file into a matrix of the specified type. This method uses "," as the default delimiter in the CSV file. If another delimiter is desired, specify using fromCsv(String, String, Class).

      Usage example: 

      
      Matrix realMatrix;
      try {
          realMatrix = (Matrix) TensorRead.fromCsv("real_data.csv", Matrix.class);
      } catch (IOException e) {
          // Handel exception.
      }

      CMatrix complexMatrix;
      try {
          complexMatrix = (CMatrix) TensorRead.fromCsv("complex_data.csv", CMatrix.class);
      } catch (IOException e) {
          // Handel exception.
      }
      Parameters:
      fileName - Path to the CSV file.
      matrixType - The class object of the desired matrix to read into. Must be either Matrix.class or CMatrix.class.
      Returns:
      A MatrixMixin object containing the data from the CSV file.
      Throws:
      IOException - If an I/O error occurs while reading the file.
      IllegalArgumentException - If the CSV file is malformed or the matrixType isn't supported.
      See Also:

    • fromCsv

      public static MatrixMixin<?,?,?,?> fromCsv(String fileName, String delimiter, Class<? extends MatrixMixin<?,?,?,?>> matrixType) throws IOException

      Reads a CSV file into a matrix of the specified type.

      Usage example: 

      
      Matrix realMatrix;
      try {
          realMatrix = (Matrix) TensorRead.fromCsv("real_data.csv", ",", Matrix.class);
      } catch (IOException e) {
          // Handel exception.
      }

      CMatrix complexMatrix;
      try {
          complexMatrix = (CMatrix) TensorRead.fromCsv("complex_data.csv", ",", CMatrix.class);
      } catch (IOException e) {
          // Handel exception.
      }
      Parameters:
      fileName - Path to the CSV file.
      delimiter - Delimiter used in the CSV file.
      matrixType - The class object of the desired matrix to read into. Must be either Matrix.class or CMatrix .class.
      Returns:
      A MatrixMixin object containing the data from the CSV file.
      Throws:
      IOException - If an I/O error occurs while reading the file.
      IllegalArgumentException - If the CSV file is malformed or the matrixType isn't supported. #fromCsv(String, Class)