KSLCore/ksl.modeling.decision.descriptor/RewardSense

RewardSense

enum RewardSense : Enum<RewardSense> (source)

Whether a declared term is something to maximise or something to minimise.

Required per term rather than inferred from the sign of a rate, because a sign convention is exactly what a modeler gets wrong. A COST term is negated once, at declaration, so the rest of the system sees one quantity that is always maximised and no code downstream has to track senses (§4.2.5).

Entries

REWARD

COST

Properties

entries

val entries: EnumEntries<RewardSense>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

valueOf

fun valueOf(value: String): RewardSense

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.)

values

fun values(): Array<RewardSense>

Returns an array containing the constants of this enum type, in the order they're declared.