at.tuwien.ifs.somtoolbox.layers.metrics

Enum DistanceMetric.SparcseMetricModes

java.lang.Object

java.lang.Enum<DistanceMetric.SparcseMetricModes>

at.tuwien.ifs.somtoolbox.layers.metrics.DistanceMetric.SparcseMetricModes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DistanceMetric.SparcseMetricModes>

Enclosing interface:

DistanceMetric

public static enum DistanceMetric.SparcseMetricModes
extends java.lang.Enum<DistanceMetric.SparcseMetricModes>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH_NON_ZERO Mode where both vector elements have to be non-zero.
FIRST_NON_ZERO Mode where only the first vector element has to be non-zero.
SECOND_NON_ZERO Mode where only the second vector element has to be non-zero.

Method Summary

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

BOTH_NON_ZERO

public static final DistanceMetric.SparcseMetricModes BOTH_NON_ZERO

Mode where both vector elements have to be non-zero.

FIRST_NON_ZERO

public static final DistanceMetric.SparcseMetricModes FIRST_NON_ZERO

Mode where only the first vector element has to be non-zero.

SECOND_NON_ZERO

public static final DistanceMetric.SparcseMetricModes SECOND_NON_ZERO

Mode where only the second vector element has to be non-zero.

Method Detail

values

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

Returns:

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

valueOf

public static DistanceMetric.SparcseMetricModes 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