Uses of Interface org.apache.commons.math3.optim.ConvergenceChecker (Apache Commons Math 3.6.1 API)

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

- Packages that use ConvergenceChecker
  Package | Description
  --- | ---
  org.apache.commons.math3.fitting.leastsquares | This package provides algorithms that minimize the residuals between observations and model values.
  org.apache.commons.math3.optim | Generally, optimizers are algorithms that will either `minimize` or `maximize` a scalar function, called the `objective function`.
  org.apache.commons.math3.optim.nonlinear.scalar | Algorithms for optimizing a scalar function.
  org.apache.commons.math3.optim.nonlinear.scalar.gradient | This package provides optimization algorithms that require derivatives.
  org.apache.commons.math3.optim.nonlinear.scalar.noderiv | This package provides optimization algorithms that do not require derivatives.
  org.apache.commons.math3.optim.nonlinear.vector | Algorithms for optimizing a vector function.
  org.apache.commons.math3.optim.nonlinear.vector.jacobian | This package provides optimization algorithms that require derivatives.
  org.apache.commons.math3.optim.univariate | One-dimensional optimization algorithms.

- - ### Uses of ConvergenceChecker in org.apache.commons.math3.fitting.leastsquares

    Classes in org.apache.commons.math3.fitting.leastsquares that implement ConvergenceChecker
    Modifier and Type | Class and Description
    --- | ---
    `class` | `EvaluationRmsChecker` Check if an optimization has converged based on the change in computed RMS.

    Methods in org.apache.commons.math3.fitting.leastsquares that return ConvergenceChecker
    Modifier and Type | Method and Description
    --- | ---
    `static ConvergenceChecker<LeastSquaresProblem.Evaluation>` | LeastSquaresFactory.`evaluationChecker(ConvergenceChecker<PointVectorValuePair> checker)` View a convergence checker specified for a `PointVectorValuePair` as one specified for an `LeastSquaresProblem.Evaluation`.
    `ConvergenceChecker<LeastSquaresProblem.Evaluation>` | LeastSquaresAdapter.`getConvergenceChecker()` Gets the convergence checker.

    Methods in org.apache.commons.math3.fitting.leastsquares with parameters of type ConvergenceChecker
    Modifier and Type | Method and Description
    --- | ---
    `LeastSquaresBuilder` | LeastSquaresBuilder.`checker(ConvergenceChecker<LeastSquaresProblem.Evaluation> newChecker)` Configure the convergence checker.
    `LeastSquaresBuilder` | LeastSquaresBuilder.`checkerPair(ConvergenceChecker<PointVectorValuePair> newChecker)` Configure the convergence checker.
    `static LeastSquaresProblem` | LeastSquaresFactory.`create(MultivariateJacobianFunction model, RealVector observed, RealVector start, ConvergenceChecker<LeastSquaresProblem.Evaluation> checker, int maxEvaluations, int maxIterations)` Create a `LeastSquaresProblem` from the given elements.
    `static LeastSquaresProblem` | LeastSquaresFactory.`create(MultivariateJacobianFunction model, RealVector observed, RealVector start, RealMatrix weight, ConvergenceChecker<LeastSquaresProblem.Evaluation> checker, int maxEvaluations, int maxIterations)` Create a `LeastSquaresProblem` from the given elements.

    `static LeastSquaresProblem`

    LeastSquaresFactory.`create(MultivariateJacobianFunction model, RealVector observed, RealVector start, RealMatrix weight, ConvergenceChecker<LeastSquaresProblem.Evaluation> checker, int maxEvaluations, int maxIterations, boolean lazyEvaluation, ParameterValidator paramValidator)`
    Create a `LeastSquaresProblem` from the given elements.

    `static LeastSquaresProblem`

    LeastSquaresFactory.`create(MultivariateVectorFunction model, MultivariateMatrixFunction jacobian, double[] observed, double[] start, RealMatrix weight, ConvergenceChecker<LeastSquaresProblem.Evaluation> checker, int maxEvaluations, int maxIterations)`
    Create a `LeastSquaresProblem` from the given elements.

    `static ConvergenceChecker<LeastSquaresProblem.Evaluation>` | LeastSquaresFactory.`evaluationChecker(ConvergenceChecker<PointVectorValuePair> checker)` View a convergence checker specified for a `PointVectorValuePair` as one specified for an `LeastSquaresProblem.Evaluation`.

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

    Classes in org.apache.commons.math3.optim 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.optim that return ConvergenceChecker
    Modifier and Type | Method and Description
    --- | ---
    `ConvergenceChecker<PAIR>` | AbstractOptimizationProblem.`getConvergenceChecker()` Gets the convergence checker.
    `ConvergenceChecker<PAIR>` | BaseOptimizer.`getConvergenceChecker()` Gets the convergence checker.
    `ConvergenceChecker<PAIR>` | OptimizationProblem.`getConvergenceChecker()` Gets the convergence checker.

    Constructors in org.apache.commons.math3.optim with parameters of type ConvergenceChecker
    Constructor and Description
    `AbstractOptimizationProblem(int maxEvaluations, int maxIterations, ConvergenceChecker<PAIR> checker)` Create an `AbstractOptimizationProblem` from the given data.
    `BaseMultivariateOptimizer(ConvergenceChecker<PAIR> checker)`
    `BaseOptimizer(ConvergenceChecker<PAIR> checker)`
    `BaseOptimizer(ConvergenceChecker<PAIR> checker, int maxEval, int maxIter)`

  - ### Uses of ConvergenceChecker in org.apache.commons.math3.optim.nonlinear.scalar

    Constructors in org.apache.commons.math3.optim.nonlinear.scalar with parameters of type ConvergenceChecker
    Constructor and Description
    `GradientMultivariateOptimizer(ConvergenceChecker<PointValuePair> checker)`
    `MultivariateOptimizer(ConvergenceChecker<PointValuePair> checker)`

  - ### Uses of ConvergenceChecker in org.apache.commons.math3.optim.nonlinear.scalar.gradient

    Constructors in org.apache.commons.math3.optim.nonlinear.scalar.gradient with parameters of type ConvergenceChecker
    Constructor and Description
    `NonLinearConjugateGradientOptimizer(NonLinearConjugateGradientOptimizer.Formula updateFormula, ConvergenceChecker<PointValuePair> checker)` Constructor with default tolerances for the line search (1e-8) and `preconditioner`.
    `NonLinearConjugateGradientOptimizer(NonLinearConjugateGradientOptimizer.Formula updateFormula, ConvergenceChecker<PointValuePair> checker, double relativeTolerance, double absoluteTolerance, double initialBracketingRange)` Constructor with default `preconditioner`.
    `NonLinearConjugateGradientOptimizer(NonLinearConjugateGradientOptimizer.Formula updateFormula, ConvergenceChecker<PointValuePair> checker, double relativeTolerance, double absoluteTolerance, double initialBracketingRange, Preconditioner preconditioner)`
    `NonLinearConjugateGradientOptimizer(NonLinearConjugateGradientOptimizer.Formula updateFormula, ConvergenceChecker<PointValuePair> checker, UnivariateSolver lineSearchSolver)` Deprecated. as of 3.3. Please use `NonLinearConjugateGradientOptimizer.NonLinearConjugateGradientOptimizer(Formula,ConvergenceChecker,double,double,double)` instead.
    `NonLinearConjugateGradientOptimizer(NonLinearConjugateGradientOptimizer.Formula updateFormula, ConvergenceChecker<PointValuePair> checker, UnivariateSolver lineSearchSolver, Preconditioner preconditioner)` Deprecated. as of 3.3. Please use `NonLinearConjugateGradientOptimizer.NonLinearConjugateGradientOptimizer(Formula,ConvergenceChecker,double,double,double,Preconditioner)` instead.

  - ### Uses of ConvergenceChecker in org.apache.commons.math3.optim.nonlinear.scalar.noderiv

    Constructors in org.apache.commons.math3.optim.nonlinear.scalar.noderiv with parameters of type ConvergenceChecker
    Constructor and Description
    `CMAESOptimizer(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.
    `PowellOptimizer(double rel, double abs, double lineRel, double lineAbs, 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.optim.nonlinear.vector

    Constructors in org.apache.commons.math3.optim.nonlinear.vector with parameters of type ConvergenceChecker
    Constructor and Description
    `JacobianMultivariateVectorOptimizer(ConvergenceChecker<PointVectorValuePair> checker)` Deprecated.
    `MultivariateVectorOptimizer(ConvergenceChecker<PointVectorValuePair> checker)` Deprecated.

  - ### Uses of ConvergenceChecker in org.apache.commons.math3.optim.nonlinear.vector.jacobian

    Constructors in org.apache.commons.math3.optim.nonlinear.vector.jacobian with parameters of type ConvergenceChecker
    Constructor and Description
    `AbstractLeastSquaresOptimizer(ConvergenceChecker<PointVectorValuePair> checker)` Deprecated.
    `GaussNewtonOptimizer(boolean useLU, ConvergenceChecker<PointVectorValuePair> checker)` Deprecated.
    `GaussNewtonOptimizer(ConvergenceChecker<PointVectorValuePair> checker)` Deprecated. Simple constructor with default settings.
    `LevenbergMarquardtOptimizer(ConvergenceChecker<PointVectorValuePair> checker)` Deprecated. Constructor that allows the specification of a custom convergence checker.
    `LevenbergMarquardtOptimizer(double initialStepBoundFactor, ConvergenceChecker<PointVectorValuePair> checker, double costRelativeTolerance, double parRelativeTolerance, double orthoTolerance, double threshold)` Deprecated. Constructor that allows the specification of a custom convergence checker, in addition to the standard ones.

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

    Classes in org.apache.commons.math3.optim.univariate that implement ConvergenceChecker
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SimpleUnivariateValueChecker` Simple implementation of the `ConvergenceChecker` interface that uses only objective function values.

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

Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.