NonLinearConjugateGradientOptimizer.BracketingStep (Apache Commons Math 3.3 API)

org.apache.commons.math3.optim.nonlinear.scalar.gradient

## Class NonLinearConjugateGradientOptimizer.BracketingStep

- java.lang.Object
- - org.apache.commons.math3.optim.nonlinear.scalar.gradient.NonLinearConjugateGradientOptimizer.BracketingStep

- All Implemented Interfaces:
    OptimizationData
  Enclosing class:
    NonLinearConjugateGradientOptimizer

  Deprecated.
  As of v3.3, this class is not used anymore. This setting is replaced by the `initialBracketingRange` argument to the new constructors.

      @Deprecated
      public static class NonLinearConjugateGradientOptimizer.BracketingStep
      extends Object
      implements OptimizationData

  The initial step is a factor with respect to the search direction (which itself is roughly related to the gradient of the function).
  It is used to find an interval that brackets the optimum in line search.
  Since:
    3.1

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `NonLinearConjugateGradientOptimizer.BracketingStep(double step)` Deprecated.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `double` | `getBracketingStep()` Deprecated. Gets the initial step.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### NonLinearConjugateGradientOptimizer.BracketingStep

          public NonLinearConjugateGradientOptimizer.BracketingStep(double step)

      Deprecated.
      Parameters:
        `step` - Initial step for the bracket search.

  - ### Method Detail

    - #### getBracketingStep

          public double getBracketingStep()

      Deprecated.
      Gets the initial step.
      Returns:
        the initial step.

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