ObjectiveFunctionGradient (Apache Commons Math 3.6.1 API)

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

## Class ObjectiveFunctionGradient

- java.lang.Object
- - org.apache.commons.math3.optim.nonlinear.scalar.ObjectiveFunctionGradient

- All Implemented Interfaces:
    OptimizationData

      public class ObjectiveFunctionGradient
      extends Object
      implements OptimizationData

  Gradient of the scalar function to be optimized.
  Since:
    3.1

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ObjectiveFunctionGradient(MultivariateVectorFunction g)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `MultivariateVectorFunction` | `getObjectiveFunctionGradient()` Gets the gradient of the function to be optimized.

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

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

- - ### Constructor Detail

    - #### ObjectiveFunctionGradient

          public ObjectiveFunctionGradient(MultivariateVectorFunction g)

      Parameters:
        `g` - Gradient of the function to be optimized.

  - ### Method Detail

    - #### getObjectiveFunctionGradient

          public MultivariateVectorFunction getObjectiveFunctionGradient()

      Gets the gradient of the function to be optimized.
      Returns:
        the objective function gradient.

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