edu.ucla.sspace.matrix

Enum MatrixIO.Format

java.lang.Object

java.lang.Enum<MatrixIO.Format>

edu.ucla.sspace.matrix.MatrixIO.Format

All Implemented Interfaces:

Serializable, Comparable<MatrixIO.Format>

Enclosing class:

MatrixIO

public static enum MatrixIO.Format
extends Enum<MatrixIO.Format>

An enum that specifies the formatting used for the matrix that is serialized in a file. Format specifications are as follows:

format	description
DENSE_TEXT	Each row is on its own line, with each column being delimited by one or more white space characters. All rows should have the same number of columns.
MATLAB_SPARSE	The sparse format supported by Matlab. See here for full details.
SVDLIBC_SPARSE_TEXT	The sparse human readable format supported by SVDLIBC. See here for full details.
SVDLIBC_DENSE_TEXT	The dense human readable format supported by SVDLIBC. See here for full details.
SVDLIBC_SPARSE_BINARY	The sparse binary format supported by SVDLIBC. See here for full details.
SVDLIBC_DENSE_BINARY	The dense binary format supported by SVDLIBC. See here for full details.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLUTO_DENSE The sparse text format supported by CLUTO.
CLUTO_SPARSE The sparse text format supported by CLUTO.
DENSE_TEXT A human readable format where each row has its own line and all column values are provided.
MATLAB_SPARSE The sparse format supported by Matlab.
SVDLIBC_DENSE_BINARY The dense binary format supported by SVDLIBC.
SVDLIBC_DENSE_TEXT The dense human readable format supported by SVDLIBC.
SVDLIBC_SPARSE_BINARY The sparse binary format supported by SVDLIBC.
SVDLIBC_SPARSE_TEXT The sparse human readable format supported by SVDLIBC.

Method Summary

Methods

Modifier and Type	Method and Description
static MatrixIO.Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static MatrixIO.Format[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DENSE_TEXT

public static final MatrixIO.Format DENSE_TEXT

A human readable format where each row has its own line and all column values are provided.

MATLAB_SPARSE

public static final MatrixIO.Format MATLAB_SPARSE

The sparse format supported by Matlab. See here for full details.

SVDLIBC_SPARSE_TEXT

public static final MatrixIO.Format SVDLIBC_SPARSE_TEXT

The sparse human readable format supported by SVDLIBC. See here for full details.

SVDLIBC_DENSE_TEXT

public static final MatrixIO.Format SVDLIBC_DENSE_TEXT

The dense human readable format supported by SVDLIBC. See here for full details.

SVDLIBC_SPARSE_BINARY

public static final MatrixIO.Format SVDLIBC_SPARSE_BINARY

The sparse binary format supported by SVDLIBC. See here for full details.

SVDLIBC_DENSE_BINARY

public static final MatrixIO.Format SVDLIBC_DENSE_BINARY

The dense binary format supported by SVDLIBC. See here for full details.

CLUTO_DENSE

public static final MatrixIO.Format CLUTO_DENSE

The sparse text format supported by CLUTO. See more details in the CLUTO manual.

CLUTO_SPARSE

public static final MatrixIO.Format CLUTO_SPARSE

The sparse text format supported by CLUTO. See more details in the CLUTO manual.

Method Detail

values

public static MatrixIO.Format[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MatrixIO.Format c : MatrixIO.Format.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MatrixIO.Format valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null