Package org.moeaframework.core.objective

Class Maximize

java.lang.Object
org.moeaframework.core.objective.AbstractObjective
org.moeaframework.core.objective.Maximize
All Implemented Interfaces:
Serializable, Comparable<Objective>, Copyable<Objective>, Defined, Named, Objective
public class Maximize extends AbstractObjective
A maximized objective.
See Also:

  • Constructor Details

    • Maximize

      public Maximize()
      Constructs a new, anonymous maximized objective.

    • Maximize

      public Maximize(String name)
      Constructs a new maximized objective.
      Parameters:
      name - the objective name

    • Maximize

      protected Maximize(String name, double value)
      Constructs a new maximized objective.
      Parameters:
      name - the objective name
      value - the objective value

  • Method Details

    • getCanonicalValue

      public double getCanonicalValue()
      Description copied from interface: Objective
      Returns the canonical value of this objective.

      The canonical value is the objective converted into a minimized form, with the target or ideal towards -1d/0d. This allows an implementation to use the numeric value of the objective directly, without needing to be aware of the optimization direction. This works since minimizing -f(x) is equivalent to maximizing f(x).

      Returns:
      the canonical value

    • compareTo

      public int compareTo(double value)
      Description copied from interface: Objective
      Similar to Comparable.compareTo(Object), compares this objective to a given value.
      Parameters:
      value - the value
      Returns:
      -1, 0, or 1 depending if this objective is less than, equal to, or greater than the given value

    • copy

      public Maximize copy()
      Description copied from interface: Copyable
      Creates and returns a copy of this object. It is required that x.copy() is completely independent from x. This means any method invoked on x.copy() in no way alters the state of x and vice versa. It is typically the case that x.copy().getClass() == x.getClass() and x.copy().equals(x).
      Returns:
      the copy

    • normalize

      public NormalizedObjective normalize(double minimum, double maximum)
      Description copied from interface: Objective
      Returns a normalized objective that is:
      1. scaled between the minimum and maximum bounds, typically producing a value falling between [0, 1], and
      2. has an ideal or target value of Double#NEGATIVE_INFINITY.
      Parameters:
      minimum - the minimum bound
      maximum - the maximum bound
      Returns:
      the normalized objective

    • getIdealValue

      public double getIdealValue()
      Description copied from interface: Objective
      Returns the ideal or best possible value for this objective.
      Returns:
      the ideal objective value

    • value

      public static Maximize value()
      Constructs a new, anonymous maximized objective.
      Returns:
      the objective

    • value

      public static Maximize value(String name)
      Constructs a new maximized objective.
      Parameters:
      name - the objective name
      Returns:
      the objective