maspack.solvers

Enum NMFactorization.Update

java.lang.Object

java.lang.Enum<NMFactorization.Update>

maspack.solvers.NMFactorization.Update

All Implemented Interfaces:

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

Enclosing class:

NMFactorization

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

Method used to update the factors at each iteration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANLS Alternating non-negative least squares, with each least squares problem solved exactly as a k X k LCP.
MULTIPLICATIVE Multiplicative update rules of Lee and Seung.

Method Summary

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

ANLS

public static final NMFactorization.Update ANLS

Alternating non-negative least squares, with each least squares problem solved exactly as a k X k LCP.

MULTIPLICATIVE

public static final NMFactorization.Update MULTIPLICATIVE

Multiplicative update rules of Lee and Seung.

Method Detail

values

public static NMFactorization.Update[] 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.Update c : NMFactorization.Update.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.Update 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