Package org.flag4j.io

Class TensorOutputStream

java.lang.Object

java.io.OutputStream

org.flag4j.io.TensorOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class TensorOutputStream
extends OutputStream

A class for writing tensors to a file in various formats.

Field Summary

Fields

Modifier and Type	Field	Description
private final FileOutputStream	fileOut	Stream for writing data to a file.
private final ObjectOutputStream	objectOut	Stream for serializing object.

Constructor Summary

Constructors

Constructor	Description
TensorOutputStream(String fileName)	Creates TensorOutputStream which will use an ObjectOutputStream to write serialized data to a FileOutputStream which will in-turn write the serialized data to a file.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the stream.
void	write(int b)	Writes a bite to the output stream.
void	write(TensorBase<?,?,?,?,?,?,?> A)	Writes a TensorBase object to a file by serializing the object.

Methods inherited from class java.io.OutputStream

flush, nullOutputStream, write, write

Methods inherited from class java.lang.Object

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

Field Details

fileOut

private final FileOutputStream fileOut

Stream for writing data to a file.

objectOut

private final ObjectOutputStream objectOut

Stream for serializing object.

Constructor Details

TensorOutputStream

public TensorOutputStream(String fileName)
                   throws IOException

Creates TensorOutputStream which will use an ObjectOutputStream to write serialized data to a FileOutputStream which will in-turn write the serialized data to a file.

Parameters:

fileName - File name, including extension, of file to write data to.

Throws:

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

Method Details

write

public void write(TensorBase<?,?,?,?,?,?,?> A)
           throws IOException

Writes a TensorBase object to a file by serializing the object.

Parameters:

A - Object to write to file. This may be a real/complex dense or sparse tensor, matrix, or vector.

Throws:

IOException

write

public void write(int b)
           throws IOException

Writes a bite to the output stream. This method will forward the write to ObjectOutputStream.write(int).

Specified by:

write in class OutputStream

Parameters:

b - the byte.

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

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 OutputStream

Throws:

IOException - If an I/O exception has occurred.