Package xal.extension.solver

Class Objective

java.lang.Object
xal.extension.solver.Objective
Direct Known Subclasses:
MinimiseOscillationsEvaluator.MinimizeOscillationsObjective
public abstract class Objective extends 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.
Author:
ky6, t6p

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final String
    name
    the name of the objective

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Objective(String name)
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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 Details

    • name

      protected final String name
      the name of the objective

  • Constructor Details

    • Objective

      protected Objective(String name)
      Constructor
      Parameters:
      name - the name to assign the objective

  • Method Details

    • 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 String getName()
      Get the name of this objective.
      Returns:
      The name of this objective.

    • toString

      public String toString()
      A description of this objective.
      Overrides:
      toString in class Object
      Returns:
      The string representation of an objective.