Package org.hipparchus.optim

Class BaseMultivariateOptimizer<P>

java.lang.Object
org.hipparchus.optim.BaseOptimizer<P>
org.hipparchus.optim.BaseMultivariateOptimizer<P>
Type Parameters:
P - Type of the point/value pair returned by the optimization algorithm.
Direct Known Subclasses:
BaseMultiStartMultivariateOptimizer, ConstraintOptimizer, MultivariateOptimizer
public abstract class BaseMultivariateOptimizer<P> extends BaseOptimizer<P>
Base class for implementing optimizers for multivariate functions. It contains the boiler-plate code for initial guess and bounds specifications. It is not a "user" class.

  • Constructor Details

    • BaseMultivariateOptimizer

      protected BaseMultivariateOptimizer(ConvergenceChecker<P> checker)
      Simple constructor.
      Parameters:
      checker - Convergence checker.

  • Method Details

    • optimize

      public P optimize(OptimizationData... optData)
      Stores data and performs the optimization.

      The list of parameters is open-ended so that sub-classes can extend it with arguments specific to their concrete implementations.

      When the method is called multiple times, instance data is overwritten only when actually present in the list of arguments: when not specified, data set in a previous call is retained (and thus is optional in subsequent calls).

      Important note: Subclasses must override BaseOptimizer.parseOptimizationData(OptimizationData[]) if they need to register their own options; but then, they must also call super.parseOptimizationData(optData) within that method.

      Overrides:
      optimize in class BaseOptimizer<P>
      Parameters:
      optData - Optimization data. In addition to those documented in BaseOptimizer, this method will register the following data:
      Returns:
      a point/value pair that satisfies the convergence criteria.

    • parseOptimizationData

      protected void parseOptimizationData(OptimizationData... optData)
      Scans the list of (required and optional) optimization data that characterize the problem.
      Overrides:
      parseOptimizationData in class BaseOptimizer<P>
      Parameters:
      optData - Optimization data. The following data will be looked for:

    • getStartPoint

      public double[] getStartPoint()
      Gets the initial guess.
      Returns:
      the initial guess, or null if not set.

    • getLowerBound

      public double[] getLowerBound()
      Get lower bounds.
      Returns:
      the lower bounds, or null if not set.

    • getUpperBound

      public double[] getUpperBound()
      Get upper bounds.
      Returns:
      the upper bounds, or null if not set.