agi.foundation

(agi.foundation.core-2024r3.jar)

Enum SphericalMedianCalculationMethod

java.lang.Object

java.lang.Enum<SphericalMedianCalculationMethod>

agi.foundation.SphericalMedianCalculationMethod

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SphericalMedianCalculationMethod>

public enum SphericalMedianCalculationMethod
extends Enum<SphericalMedianCalculationMethod>
implements Enumeration

Specifies which method to use when calculating the spherical median.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMBEDDED_R3 Minimize the function, 1 / n Σ Acos( x_i * a ), to compute the median.
NORMALIZED_SPATIAL_MEDIAN Minimize the function, 1 / n Σ | x_i - a |, to compute the median.

Method Summary

Modifier and Type	Method and Description
static SphericalMedianCalculationMethod	getDefault() Get the enum constant that is considered to be the default.
static SphericalMedianCalculationMethod	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static SphericalMedianCalculationMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static SphericalMedianCalculationMethod[]	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

NORMALIZED_SPATIAL_MEDIAN

public static final SphericalMedianCalculationMethod NORMALIZED_SPATIAL_MEDIAN

Minimize the function, 1 / n Σ | x_i - a |, to compute the median.

EMBEDDED_R3

public static final SphericalMedianCalculationMethod EMBEDDED_R3

Minimize the function, 1 / n Σ Acos( x_i * a ), to compute the median.

Method Detail

values

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

Returns:

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

valueOf

public static SphericalMedianCalculationMethod 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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static SphericalMedianCalculationMethod getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static SphericalMedianCalculationMethod getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.