cern.colt.matrix

Enum Norm

java.lang.Object

java.lang.Enum<Norm>

cern.colt.matrix.Norm

All Implemented Interfaces:

Serializable, Comparable<Norm>

public enum Norm
extends Enum<Norm>

Types of matrix norms.

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

Enum Constant Summary

Enum Constants

Enum Constant and Description
Frobenius The root of sum of the sum of squares
Infinity Maximum column sum
One Maximum absolute row sum
Two Euclidean norm

Method Summary

Methods

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

One

public static final Norm One

Maximum absolute row sum

Two

public static final Norm Two

Euclidean norm

Frobenius

public static final Norm Frobenius

The root of sum of the sum of squares

Infinity

public static final Norm Infinity

Maximum column sum

Method Detail

values

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

Returns:

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

valueOf

public static Norm valueOf(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:

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

NullPointerException - if the argument is null