Package com.irurueta.algebra

Enum Class NormType

java.lang.Object

java.lang.Enum<NormType>

com.irurueta.algebra.NormType

All Implemented Interfaces:

Serializable, Comparable<NormType>, Constable

public enum NormType
extends Enum<NormType>

Enumerator defining all possible ways of computing norms for matrices and arrays.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FROBENIUS_NORM	Defines Frobenius norm type.
INFINITY_NORM	Defines Infinity norm type, which is the maximum row sum on a matrix.
ONE_NORM	Defines one norm, which is the maximum column sum on a matrix.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NormType()

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FROBENIUS_NORM

public static final NormType FROBENIUS_NORM

Defines Frobenius norm type.

ONE_NORM

public static final NormType ONE_NORM

Defines one norm, which is the maximum column sum on a matrix.

INFINITY_NORM

public static final NormType INFINITY_NORM

Defines Infinity norm type, which is the maximum row sum on a matrix.

Constructor Details

NormType

private NormType()

Method Details

values

public static NormType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static NormType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null