## Uses of Interface
org.apache.commons.math3.optimization.ConvergenceChecker

- Packages that use ConvergenceChecker
  Package | Description
  --- | ---
  org.apache.commons.math3.optimization | This package provides common interfaces for the optimization algorithms provided in sub-packages.
  org.apache.commons.math3.optimization.direct | This package provides optimization algorithms that don't require derivatives.
  org.apache.commons.math3.optimization.general | This package provides optimization algorithms that require derivatives.
  org.apache.commons.math3.optimization.univariate | Univariate real functions minimum finding algorithms.

- - ### Uses of ConvergenceChecker in org.apache.commons.math3.optimization

    Classes in org.apache.commons.math3.optimization that implement ConvergenceChecker
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractConvergenceChecker<PAIR>` Base class for all convergence checker implementations.
    `class` | `SimplePointChecker<PAIR extends Pair<double[],? extends Object>>` Simple implementation of the `ConvergenceChecker` interface using only point coordinates.
    `class` | `SimpleValueChecker` Simple implementation of the `ConvergenceChecker` interface using only objective function values.
    `class` | `SimpleVectorValueChecker` Simple implementation of the `ConvergenceChecker` interface using only objective function values.

    Methods in org.apache.commons.math3.optimization that return ConvergenceChecker
    Modifier and Type | Method and Description
    --- | ---
    `ConvergenceChecker<PointVectorValuePair>` | BaseMultivariateVectorMultiStartOptimizer.`getConvergenceChecker()` Get the convergence checker.
    `ConvergenceChecker<PAIR>` | BaseOptimizer.`getConvergenceChecker()` Get the convergence checker.
    `ConvergenceChecker<PointValuePair>` | BaseMultivariateMultiStartOptimizer.`getConvergenceChecker()` Get the convergence checker.

  - ### Uses of ConvergenceChecker in org.apache.commons.math3.optimization.direct

    Methods in org.apache.commons.math3.optimization.direct that return ConvergenceChecker
    Modifier and Type | Method and Description
    --- | ---
    `ConvergenceChecker<PointValuePair>` | BaseAbstractMultivariateOptimizer.`getConvergenceChecker()` Get the convergence checker.
    `ConvergenceChecker<PointVectorValuePair>` | BaseAbstractMultivariateVectorOptimizer.`getConvergenceChecker()` Get the convergence checker.

    Constructors in org.apache.commons.math3.optimization.direct with parameters of type ConvergenceChecker
    Constructor and Description
    `BaseAbstractMultivariateOptimizer(ConvergenceChecker<PointValuePair> checker)`
    `BaseAbstractMultivariateSimpleBoundsOptimizer(ConvergenceChecker<PointValuePair> checker)`
    `BaseAbstractMultivariateVectorOptimizer(ConvergenceChecker<PointVectorValuePair> checker)`
    `CMAESOptimizer(int lambda, double[] inputSigma, int maxIterations, double stopFitness, boolean isActiveCMA, int diagonalOnly, int checkFeasableCount, RandomGenerator random, boolean generateStatistics, ConvergenceChecker<PointValuePair> checker)`
    `PowellOptimizer(double rel, double abs, ConvergenceChecker<PointValuePair> checker)` This constructor allows to specify a user-defined convergence checker, in addition to the parameters that control the default convergence checking procedure and the line search tolerances.
    `SimplexOptimizer(ConvergenceChecker<PointValuePair> checker)`

  - ### Uses of ConvergenceChecker in org.apache.commons.math3.optimization.general

    Constructors in org.apache.commons.math3.optimization.general with parameters of type ConvergenceChecker
    Constructor and Description
    `AbstractLeastSquaresOptimizer(ConvergenceChecker<PointVectorValuePair> checker)`
    `AbstractScalarDifferentiableOptimizer(ConvergenceChecker<PointValuePair> checker)`
    `GaussNewtonOptimizer(boolean useLU, ConvergenceChecker<PointVectorValuePair> checker)`
    `GaussNewtonOptimizer(ConvergenceChecker<PointVectorValuePair> checker)` Simple constructor with default settings.
    `LevenbergMarquardtOptimizer(ConvergenceChecker<PointVectorValuePair> checker)` Constructor that allows the specification of a custom convergence checker.
    `LevenbergMarquardtOptimizer(double initialStepBoundFactor, ConvergenceChecker<PointVectorValuePair> checker, double costRelativeTolerance, double parRelativeTolerance, double orthoTolerance, double threshold)` Constructor that allows the specification of a custom convergence checker, in addition to the standard ones.
    `NonLinearConjugateGradientOptimizer(ConjugateGradientFormula updateFormula, ConvergenceChecker<PointValuePair> checker)` Constructor with default `line search solver` and `preconditioner`.
    `NonLinearConjugateGradientOptimizer(ConjugateGradientFormula updateFormula, ConvergenceChecker<PointValuePair> checker, UnivariateSolver lineSearchSolver)` Constructor with default `preconditioner`.
    `NonLinearConjugateGradientOptimizer(ConjugateGradientFormula updateFormula, ConvergenceChecker<PointValuePair> checker, UnivariateSolver lineSearchSolver, Preconditioner preconditioner)`

  - ### Uses of ConvergenceChecker in org.apache.commons.math3.optimization.univariate

    Methods in org.apache.commons.math3.optimization.univariate that return ConvergenceChecker
    Modifier and Type | Method and Description
    --- | ---
    `ConvergenceChecker<UnivariatePointValuePair>` | BaseAbstractUnivariateOptimizer.`getConvergenceChecker()` Get the convergence checker.
    `ConvergenceChecker<UnivariatePointValuePair>` | UnivariateMultiStartOptimizer.`getConvergenceChecker()` Get the convergence checker.

    Constructors in org.apache.commons.math3.optimization.univariate with parameters of type ConvergenceChecker
    Constructor and Description
    `BaseAbstractUnivariateOptimizer(ConvergenceChecker<UnivariatePointValuePair> checker)`
    `BrentOptimizer(double rel, double abs, ConvergenceChecker<UnivariatePointValuePair> checker)` The arguments are used implement the original stopping criterion of Brent's algorithm.

Copyright © 2003-2012 The Apache Software Foundation. All Rights Reserved.