Apache Commons Math 3.6.1 · org.apache.commons.math3.optim.BaseMultivariateOptimizer

Modifier and Type	Field and Description
private double[]	lowerBound Lower bounds.
private double[]	start Initial guess.
private double[]	upperBound Upper bounds.

Access	Constructor and Description
protected	BaseMultivariateOptimizer(ConvergenceChecker<PAIR> Convergence checker. checker)

Method Summary

Modifier and Type	Method and Description
private void	checkParameters() Check parameters consistency.
public double[]	Returns: the lower bounds, or `null` if not set. getLowerBound()
public double[]	Returns: the initial guess, or `null` if not set. getStartPoint() Gets the initial guess.
public double[]	Returns: the upper bounds, or `null` if not set. getUpperBound()
public PAIR	Returns: a point/value pair that satisfies the convergence criteria. optimize(OptimizationData... Optimization data. In addition to those documented in `BaseOptimizer`, this method will register the following data: `InitialGuess` `SimpleBounds` optData) Overrides org.apache.commons.math3.optim.BaseOptimizer.optimize. Stores data and performs the optimization.
protected void	parseOptimizationData(OptimizationData... Optimization data. The following data will be looked for: `InitialGuess` `SimpleBounds` optData) Overrides org.apache.commons.math3.optim.BaseOptimizer.parseOptimizationData. Scans the list of (required and optional) optimization data that characterize the problem.

Inherited from org.apache.commons.math3.optim.BaseOptimizer:: doOptimize getConvergenceChecker getEvaluations getIterations getMaxEvaluations getMaxIterations incrementEvaluationCount incrementIterationCount optimize

lowerBound	back to summary
private double[] lowerBound Lower bounds.

start	back to summary
private double[] start Initial guess.

upperBound	back to summary
private double[] upperBound Upper bounds.

BaseMultivariateOptimizer	back to summary
protected BaseMultivariateOptimizer(ConvergenceChecker<PAIR> checker) Parameters checker:ConvergenceChecker<PAIR> Convergence checker.

Method Detail

checkParameters	back to summary
private void checkParameters() Check parameters consistency.

getLowerBound	back to summary
public double[] getLowerBound() Returns:double[] the lower bounds, or `null` if not set.

getStartPoint back to summary

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

public double[] getStartPoint()

Gets the initial guess.

Returns:double[]: the initial guess, or null if not set.

getUpperBound	back to summary
public double[] getUpperBound() Returns:double[] the upper bounds, or `null` if not set.

optimize back to summary

optimize	back to summary
public PAIR optimize(OptimizationData... optData) Overrides org.apache.commons.math3.optim.BaseOptimizer.optimize. Doc from org.apache.commons.math3.optim.BaseOptimizer.optimize. 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 `parseOptimizationData(OptimizationData[])` if they need to register their own options; but then, they must also call `super.parseOptimizationData(optData)` within that method. Parameters optData:OptimizationData[] Optimization data. In addition to those documented in `BaseOptimizer`, this method will register the following data: `InitialGuess` `SimpleBounds` Returns:PAIR a point/value pair that satisfies the convergence criteria. Annotations @Override

public PAIR optimize(OptimizationData... optData)

Overrides org.apache.commons.math3.optim.BaseOptimizer.optimize.

Doc from org.apache.commons.math3.optim.BaseOptimizer.optimize.

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 parseOptimizationData(OptimizationData[]) if they need to register their own options; but then, they must also call super.parseOptimizationData(optData) within that method.

Parameters

optData:OptimizationData[]

Optimization data. In addition to those documented in BaseOptimizer, this method will register the following data:

Returns:PAIR

a point/value pair that satisfies the convergence criteria.

Annotations

@Override

parseOptimizationData back to summary

parseOptimizationData	back to summary
protected void parseOptimizationData(OptimizationData... optData) Overrides org.apache.commons.math3.optim.BaseOptimizer.parseOptimizationData. Scans the list of (required and optional) optimization data that characterize the problem. Parameters optData:OptimizationData[] Optimization data. The following data will be looked for: `InitialGuess` `SimpleBounds` Annotations @Override

protected void parseOptimizationData(OptimizationData... optData)

Overrides org.apache.commons.math3.optim.BaseOptimizer.parseOptimizationData.

Scans the list of (required and optional) optimization data that characterize the problem.

Parameters

optData:OptimizationData[]

Optimization data. The following data will be looked for:

Annotations

@Override

public abstract Class BaseMultivariateOptimizer<PAIR>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail