edu.stanford.rsl.konrad.numerics
Enum SimpleVector.VectorNormType

java.lang.Object
  extended by java.lang.Enum<SimpleVector.VectorNormType>
      extended by edu.stanford.rsl.konrad.numerics.SimpleVector.VectorNormType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SimpleVector.VectorNormType>
Enclosing class:
SimpleVector

public static enum SimpleVector.VectorNormType
extends java.lang.Enum<SimpleVector.VectorNormType>


Enum Constant Summary
VEC_NORM_L1
          A vectors' L_1 norm is the sum of its absolute values.
VEC_NORM_L2
          A vectors' L_2 norm is the square root of the sum of squares of its entries.
VEC_NORM_LINF
          A vectors' L_infinity norm is the maximum of its absolute values.
 
Method Summary
static SimpleVector.VectorNormType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SimpleVector.VectorNormType[] 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

VEC_NORM_L1

public static final SimpleVector.VectorNormType VEC_NORM_L1
A vectors' L_1 norm is the sum of its absolute values.


VEC_NORM_L2

public static final SimpleVector.VectorNormType VEC_NORM_L2
A vectors' L_2 norm is the square root of the sum of squares of its entries.


VEC_NORM_LINF

public static final SimpleVector.VectorNormType VEC_NORM_LINF
A vectors' L_infinity norm is the maximum of its absolute values.

Method Detail

values

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

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

valueOf

public static SimpleVector.VectorNormType 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