xal.extension.solver

Class Objective

java.lang.Object

xal.extension.solver.Objective

public abstract class Objective
extends java.lang.Object

Objective represents a goal to achieve in optimization. An objective corresponds to some specified measure and determines that satisfaction achieved by a particular value of the measure.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_name the name of the objective

Constructor Summary

Constructors

Constructor and Description
Objective(java.lang.String name) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of this objective.
abstract double	satisfaction(double value) Determines how satisfied the user is with the specified value for this objective.
java.lang.String	toString() A description of this objective.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_name

protected final java.lang.String _name

the name of the objective

Constructor Detail

Objective

public Objective(java.lang.String name)

Constructor

Parameters:

name - the name to assign the objective

Method Detail

satisfaction

public abstract double satisfaction(double value)

Determines how satisfied the user is with the specified value for this objective.

Parameters:

value - The value associated with this objective for a particular trial

Returns:

the user satisfaction for the specified value

getName

public java.lang.String getName()

Get the name of this objective.

Returns:

The name of this objective.

toString

public java.lang.String toString()

A description of this objective.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of an objective.