maspack.matrix

Enum Matrix.Partition

java.lang.Object

java.lang.Enum<Matrix.Partition>

maspack.matrix.Matrix.Partition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Matrix.Partition>

Enclosing interface:

Matrix

public static enum Matrix.Partition
extends java.lang.Enum<Matrix.Partition>

Describes different partitions of a matrix object.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Full Specfies the entire matrix.
LowerTriangular Specifices the lower triangular portion of this matrix.
None No partition specified.
UpperTriangular Specifices the upper triangular portion of this matrix.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final Matrix.Partition None

No partition specified.

Full

public static final Matrix.Partition Full

Specfies the entire matrix.

UpperTriangular

public static final Matrix.Partition UpperTriangular

Specifices the upper triangular portion of this matrix.

LowerTriangular

public static final Matrix.Partition LowerTriangular

Specifices the lower triangular portion of this matrix.

Method Detail

values

public static Matrix.Partition[] 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.Partition c : Matrix.Partition.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.Partition valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null