org.nd4j.linalg.api.io.NDArrayIO Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of nd4j-api Show documentation

There is a newer version: 1.0.0-M2.1

package org.nd4j.linalg.api.io;

import org.nd4j.linalg.api.complex.IComplexNDArray;
import org.nd4j.linalg.api.ndarray.INDArray;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * NDArrayIO (interop)
 * @author Adam Gibson
 */
public interface NDArrayIO {


    /**
     * Read in an ndrray from an input stream
     * @param is the input stream to read in from
     * @return the ndarray read in
     */
    public INDArray read(InputStream is) throws IOException;

    /**
     * Read in a complex ndarray
     * @param is the input stream to read in from
     * @return the complex ndarray that was read in
     */
    public IComplexNDArray readComplex(InputStream is) throws IOException;


    /**
     * Read in an ndarray from a file
     * @param file the file to read in from
     * @return the ndarray that was read in
     */
    public INDArray read(File file) throws IOException;


    /**
     * Read in a complex ndarray from a file
     * @param file the ndarray to read from
     * @return the read in ndarray
     */
    public IComplexNDArray readComplex(File file)  throws IOException;



    /**
     * Write an ndarray to the output stream
     * @param out the ndarray to write
     * @param to the output stream to write to
     */
    public void write(INDArray out,File to)  throws IOException;

    /**
     * Write a complex ndarray to an output stream
     * @param out the ndarray to write
     * @param to the output stream to write to
     */
    public void writeComplex(IComplexNDArray out,File to)  throws IOException;

    /**
     * Write an ndarray to the output stream
     * @param out the ndarray to write
     * @param to the output stream to write to
     */
    public void write(INDArray out,OutputStream to)  throws IOException;

    /**
     * Write a complex ndarray to an output stream
     * @param out the ndarray to write
     * @param to the output stream to write to
     */
    public void writeComplex(IComplexNDArray out,OutputStream to)  throws IOException;


}