org.shared.array.kernel

Class MatlabIoKernel

java.lang.Object

org.shared.array.kernel.MatlabIoKernel

All Implemented Interfaces:

ArrayIoKernel, Service

public class MatlabIoKernel
extends Object
implements ArrayIoKernel

An implementation of ArrayIoKernel that reads and writes MATLAB MAT-files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MatlabIoKernel.DataElement<T> A MATLAB data element.
protected static class	MatlabIoKernel.DoubleArrayDataElement A MATLAB data element that is an array of doubles.
protected static class	MatlabIoKernel.IntArrayDataElement A MATLAB data element that is an array of ints.
protected static class	MatlabIoKernel.MatrixDataElement A MATLAB matrix data element.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ThreadLocal<Integer>	complexArrayCountLocal A ComplexArray counter local to the current thread.
protected static ThreadLocal<Integer>	integerArrayCountLocal An IntegerArray counter local to the current thread.
protected static ThreadLocal<Integer>	realArrayCountLocal A RealArray counter local to the current thread.

Constructor Summary

Constructors

Constructor and Description
MatlabIoKernel() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	getBytes(ComplexArray complexArray, String name) Converts the given ComplexArray into bytes.
static byte[]	getBytes(IntegerArray array, String name) Converts the given IntegerArray into bytes.
static byte[]	getBytes(RealArray array, String name) Converts the given RealArray into bytes.
<T extends Array<T,?>> byte[]	getBytes(T array) Converts an Array into bytes.
protected static int	getDataElementSize(MatlabIo.DataType type, int nElts) Gets the data element size, given the MatlabIo.DataType and the number of elements.
static byte[]	getHeaderBytes(String text) Gets the binary representation of the MAT-file header.
<T extends Array<T,E>,E> byte[]	getMatBytes(T... arrays) Converts the given Arrays into MAT-file format.
<T extends Array<T,?>> T	parse(byte[] data) Parses an Array from bytes.
Array<?,?>[]	parseMat(byte[] data) Parses a series of Arrays from MAT-file format.
protected static void	writeDataElementBody(ByteBuffer bb, byte[] arr) Writes the data element body.
protected static void	writeDataElementBody(ByteBuffer bb, double[] arr) Writes the data element body.
protected static void	writeDataElementBody(ByteBuffer bb, int[] arr) Writes the data element body.
protected static void	writeDataElementHeader(ByteBuffer bb, MatlabIo.DataType type, int nElts) Writes the data element header, given the MatlabIo.DataType and the number of elements.

Methods inherited from class java.lang.Object

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

Field Detail

realArrayCountLocal

protected static final ThreadLocal<Integer> realArrayCountLocal

A RealArray counter local to the current thread.

complexArrayCountLocal

protected static final ThreadLocal<Integer> complexArrayCountLocal

A ComplexArray counter local to the current thread.

integerArrayCountLocal

protected static final ThreadLocal<Integer> integerArrayCountLocal

An IntegerArray counter local to the current thread.

Constructor Detail

MatlabIoKernel

public MatlabIoKernel()

Default constructor.

Method Detail

getBytes

public <T extends Array<T,?>> byte[] getBytes(T array)

Description copied from interface: ArrayIoKernel

Converts an Array into bytes.

Specified by:

getBytes in interface ArrayIoKernel

Type Parameters:

T - the Array type.

Parameters:

array - the Array.

Returns:

the bytes.

parse

public <T extends Array<T,?>> T parse(byte[] data)

Description copied from interface: ArrayIoKernel

Parses an Array from bytes.

Specified by:

parse in interface ArrayIoKernel

Type Parameters:

T - the inferred Array type.

Parameters:

data - the bytes.

Returns:

the Array.

getHeaderBytes

public static final byte[] getHeaderBytes(String text)

Gets the binary representation of the MAT-file header.

getBytes

public static final byte[] getBytes(RealArray array,
              String name)

Converts the given RealArray into bytes.

getBytes

public static final byte[] getBytes(ComplexArray complexArray,
              String name)

Converts the given ComplexArray into bytes.

getBytes

public static final byte[] getBytes(IntegerArray array,
              String name)

Converts the given IntegerArray into bytes.

getMatBytes

public <T extends Array<T,E>,E> byte[] getMatBytes(T... arrays)

Converts the given Arrays into MAT-file format.

Type Parameters:

T - the Array type.

E - the Array element type.

parseMat

public Array<?,?>[] parseMat(byte[] data)

Parses a series of Arrays from MAT-file format.

writeDataElementHeader

protected static final void writeDataElementHeader(ByteBuffer bb,
                          MatlabIo.DataType type,
                          int nElts)

Writes the data element header, given the MatlabIo.DataType and the number of elements.

writeDataElementBody

protected static final void writeDataElementBody(ByteBuffer bb,
                        byte[] arr)

Writes the data element body.

writeDataElementBody

protected static final void writeDataElementBody(ByteBuffer bb,
                        int[] arr)

Writes the data element body.

writeDataElementBody

protected static final void writeDataElementBody(ByteBuffer bb,
                        double[] arr)

Writes the data element body.

getDataElementSize

protected static final int getDataElementSize(MatlabIo.DataType type,
                     int nElts)

Gets the data element size, given the MatlabIo.DataType and the number of elements.