agi.foundation.stoppingconditions

(agi.foundation.models-2024r2.jar)

Enum CircularRange

java.lang.Object

java.lang.Enum<CircularRange>

agi.foundation.stoppingconditions.CircularRange

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CircularRange>

public enum CircularRange
extends Enum<CircularRange>
implements Enumeration

The possible options that a numerical value could be limited to when it represents an angle.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEGATIVE_PI_TO_PI Specifies that the value should be adjusted such that it is between -π and π.
NOT_CIRCULAR The value is not an angle.
ZERO_TO_TWO_PI Specifies that the value should be adjusted such that it is between 0 and 2π.

Method Summary

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

NOT_CIRCULAR

public static final CircularRange NOT_CIRCULAR

The value is not an angle.

ZERO_TO_TWO_PI

public static final CircularRange ZERO_TO_TWO_PI

Specifies that the value should be adjusted such that it is between 0 and 2π.

NEGATIVE_PI_TO_PI

public static final CircularRange NEGATIVE_PI_TO_PI

Specifies that the value should be adjusted such that it is between -π and π.

Method Detail

values

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

Returns:

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

valueOf

public static CircularRange 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 CircularRange 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 CircularRange getDefault()

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

Returns:

The default enum constant.