maspack.solvers

Enum NMFactorization.Normalization

java.lang.Object

java.lang.Enum<NMFactorization.Normalization>

maspack.solvers.NMFactorization.Normalization

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NMFactorization.Normalization>

Enclosing class:

NMFactorization

public static enum NMFactorization.Normalization
extends java.lang.Enum<NMFactorization.Normalization>

Normalization applied to the factors once the factorization is complete.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE No normalization is applied.
UNITY_MAX Each column of W is scaled so that its maximum entry is 1, with the corresponding row of H scaled inversely.
UNITY_NORM Each column of W is scaled to unit Euclidean norm, with the corresponding row of H scaled inversely.

Method Summary

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

No normalization is applied.

UNITY_MAX

public static final NMFactorization.Normalization UNITY_MAX

Each column of W is scaled so that its maximum entry is 1, with the corresponding row of H scaled inversely.

UNITY_NORM

public static final NMFactorization.Normalization UNITY_NORM

Each column of W is scaled to unit Euclidean norm, with the corresponding row of H scaled inversely.

Method Detail

values

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

Returns:

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

valueOf

public static NMFactorization.Normalization 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