agi.foundation.numericalmethods

(agi.foundation.core-2025r1.jar)

Enum CostFunctionGoal

java.lang.Object

java.lang.Enum<CostFunctionGoal>

agi.foundation.numericalmethods.CostFunctionGoal

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CostFunctionGoal>

public enum CostFunctionGoal
extends Enum<CostFunctionGoal>
implements Enumeration

Specifies whether the cost function should be minimized or maximized.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAXIMIZE The cost function should be maximized.
MINIMIZE The cost function should be minimized.

Method Summary

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

MINIMIZE

public static final CostFunctionGoal MINIMIZE

The cost function should be minimized.

MAXIMIZE

public static final CostFunctionGoal MAXIMIZE

The cost function should be maximized.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.