edu.stanford.rsl.conrad.numerics

Enum SimpleMatrix.MatrixNormType

java.lang.Object

java.lang.Enum<SimpleMatrix.MatrixNormType>

edu.stanford.rsl.conrad.numerics.SimpleMatrix.MatrixNormType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimpleMatrix.MatrixNormType>

Enclosing class:

SimpleMatrix

public static enum SimpleMatrix.MatrixNormType
extends java.lang.Enum<SimpleMatrix.MatrixNormType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAT_NORM_FROBENIUS The Frobenius norm is the entry-wise 2-norm (the sum of squares of all entries).
MAT_NORM_L1 The L_1-induced norm is equivalent to the maximum absolute column sum of the matrix.
MAT_NORM_L2 The L_2-induced norm is the largest singular value of the matrix M or the largest eigenvalue of A^* * A.
MAT_NORM_LINF The L_infinity-induced norm is equivalent to the maximum absolute row sum of the matrix.

Method Summary

Methods

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

MAT_NORM_L1

public static final SimpleMatrix.MatrixNormType MAT_NORM_L1

The L_1-induced norm is equivalent to the maximum absolute column sum of the matrix.

MAT_NORM_L2

public static final SimpleMatrix.MatrixNormType MAT_NORM_L2

The L_2-induced norm is the largest singular value of the matrix M or the largest eigenvalue of A^* * A.

MAT_NORM_LINF

public static final SimpleMatrix.MatrixNormType MAT_NORM_LINF

The L_infinity-induced norm is equivalent to the maximum absolute row sum of the matrix.

MAT_NORM_FROBENIUS

public static final SimpleMatrix.MatrixNormType MAT_NORM_FROBENIUS

The Frobenius norm is the entry-wise 2-norm (the sum of squares of all entries).

Method Detail

values

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

Returns:

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

valueOf

public static SimpleMatrix.MatrixNormType 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