edu.ucla.sspace.matrix

Enum Matrix.Type

java.lang.Object

java.lang.Enum<Matrix.Type>

edu.ucla.sspace.matrix.Matrix.Type

All Implemented Interfaces:

Serializable, Comparable<Matrix.Type>

Enclosing interface:

Matrix

public static enum Matrix.Type
extends Enum<Matrix.Type>

The type of Matrix instance. This enum should be used as a hint for algorithms that create Matrix instances as to what implementation to use.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DENSE_IN_MEMORY A Matrix that contains very few 0 values and is small enough to fit into memory.
DENSE_ON_DISK A Matrix with very few zero values and is sufficiently large enough that it would not fit in memory.
DIAGONAL_IN_MEMORY A diagonal Matrix, saving a little more meory than a sparse Matrix.
SPARSE_IN_MEMORY A Matrix where the majority of the values are 0, and is small enough to fit into memory.
SPARSE_ON_DISK A Matrix with very few non-zero values and is sufficiently large enough that it would not fit in memory.

Method Summary

Methods

Modifier and Type	Method and Description
static Matrix.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Matrix.Type[]	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

SPARSE_IN_MEMORY

public static final Matrix.Type SPARSE_IN_MEMORY

A Matrix where the majority of the values are 0, and is small enough to fit into memory.

DENSE_IN_MEMORY

public static final Matrix.Type DENSE_IN_MEMORY

A Matrix that contains very few 0 values and is small enough to fit into memory.

SPARSE_ON_DISK

public static final Matrix.Type SPARSE_ON_DISK

A Matrix with very few non-zero values and is sufficiently large enough that it would not fit in memory.

DENSE_ON_DISK

public static final Matrix.Type DENSE_ON_DISK

A Matrix with very few zero values and is sufficiently large enough that it would not fit in memory.

DIAGONAL_IN_MEMORY

public static final Matrix.Type DIAGONAL_IN_MEMORY

A diagonal Matrix, saving a little more meory than a sparse Matrix.

Method Detail

values

public static Matrix.Type[] 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 (Matrix.Type c : Matrix.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static Matrix.Type 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