Package org.flag4j.io

Class TensorInputStream

java.lang.Object

java.io.InputStream

org.flag4j.io.TensorInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class TensorInputStream
extends InputStream

A TensorInputStream obtains bytes from a system file using a FileInputStream containing a serialized tensor, matrix, or vector. Then, deserializes that object using an ObjectInputStream.

Field Summary

Fields

Modifier and Type	Field	Description
private final FileInputStream	fileIn	Stream for loading bytes from a system file.
private final ObjectInputStream	objectIn	Stream for deserializing an object.

Constructor Summary

Constructors

Constructor	Description
TensorInputStream(String fileName)	Creates TensorInputStream which will open a connection with a file through an ObjectInputStream and a FileInputStream.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the stream.
int	read()	Reads a byte of data.
Matrix	readMatrix()	Reads a serialized matrix from a file.
Tensor	readTensor()	Reads a serialized tesnor from a file.
Vector	readVector()	Reads a serialized vector from a file.

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

fileIn

private final FileInputStream fileIn

Stream for loading bytes from a system file.

objectIn

private final ObjectInputStream objectIn

Stream for deserializing an object.

Constructor Details

TensorInputStream

public TensorInputStream(String fileName)
                  throws IOException

Creates TensorInputStream which will open a connection with a file through an ObjectInputStream and a FileInputStream. This TensorInputStream can be used to deserialize a tensor, matrix, or vector which is stored in a system file.

Parameters:

fileName - File name, including extension, of tensor, matrix, or vector to read.

Throws:

IOException - If an I/O error occurs while reading the stream header.

Method Details

readTensor

public Tensor readTensor()
                  throws IOException,
ClassNotFoundException

Reads a serialized tesnor from a file.

Returns:

The deserialized tensor object stored in the specified file.

Throws:

IOException

ClassNotFoundException

readMatrix

public Matrix readMatrix()
                  throws IOException,
ClassNotFoundException

Reads a serialized matrix from a file.

Returns:

The deserialized matrix object stored in the specified file.

Throws:

IOException

ClassNotFoundException

readVector

public Vector readVector()
                  throws IOException,
ClassNotFoundException

Reads a serialized vector from a file.

Returns:

The deserialized vector object stored in the specified file.

Throws:

IOException

ClassNotFoundException

read

public int read()
         throws IOException

Reads a byte of data. This method will block if no input is available. The read operation is forwarded to ObjectInputStream.read().

Specified by:

read in class InputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached.

Throws:

IOException - If an I/O error occurs.

close

public void close()
           throws IOException

Closes the stream. This method must be called to release any resources associated with the stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException - If an I/O exception has occurred.