Drake
Drake C++ Documentation
NumericalGradientOption Class Reference

#include <drake/math/compute_numerical_gradient.h>

Public Member Functions

 NumericalGradientOption (NumericalGradientMethod method, double function_accuracy=1e-15)
 
NumericalGradientMethod method () const
 
double perturbation_size () const
 

Constructor & Destructor Documentation

◆ NumericalGradientOption()

NumericalGradientOption ( NumericalGradientMethod  method,
double  function_accuracy = 1e-15 
)
explicit
Parameters
function_accuracyThe accuracy of evaluating function f(x). For double-valued functions (with magnitude around 1), the accuracy is usually about 1E-15.

Member Function Documentation

◆ method()

NumericalGradientMethod method ( ) const

◆ perturbation_size()

double perturbation_size ( ) const

The documentation for this class was generated from the following file: