gov.sandia.cognition.math.matrix

Enum EntryIndexComparator.Compare

java.lang.Object

java.lang.Enum<EntryIndexComparator.Compare>

gov.sandia.cognition.math.matrix.EntryIndexComparator.Compare

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EntryIndexComparator.Compare>

Enclosing interface:

EntryIndexComparator<EntryType>

public static enum EntryIndexComparator.Compare
extends java.lang.Enum<EntryIndexComparator.Compare>

Indicates which of two iterators has the lowest index

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH_ENTRIES_NULL both entries are null
ENTRIES_EQUAL both iterators are equally indexed
FIRST_ENTRY_NULL first entry is null
FIRST_LOWEST first iterator has lowest index
SECOND_ENTRY_NULL second entry is null
SECOND_LOWEST second iterator has lowest index

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRST_LOWEST

public static final EntryIndexComparator.Compare FIRST_LOWEST

first iterator has lowest index

SECOND_LOWEST

public static final EntryIndexComparator.Compare SECOND_LOWEST

second iterator has lowest index

ENTRIES_EQUAL

public static final EntryIndexComparator.Compare ENTRIES_EQUAL

both iterators are equally indexed

BOTH_ENTRIES_NULL

public static final EntryIndexComparator.Compare BOTH_ENTRIES_NULL

both entries are null

FIRST_ENTRY_NULL

public static final EntryIndexComparator.Compare FIRST_ENTRY_NULL

first entry is null

SECOND_ENTRY_NULL

public static final EntryIndexComparator.Compare SECOND_ENTRY_NULL

second entry is null

Method Detail

values

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

Returns:

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

valueOf

public static EntryIndexComparator.Compare 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