Exception thrown when a gradient check fails. More...
#include <roboptim/core/decorator/finite-difference-gradient.hh>
Public Member Functions | |
ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericDifferentiableFunction< T >) | |
BadGradient (const_argument_ref x, const_gradient_ref analyticalGradient, const_gradient_ref finiteDifferenceGradient, const value_type &threshold) | |
Default constructor. | |
virtual | ~BadGradient () |
virtual std::ostream & | print (std::ostream &o) const |
Display the exception on the specified output stream. | |
BadGradient (const_argument_ref x, const_gradient_ref analyticalGradient, const_gradient_ref finiteDifferenceGradient, const value_type &threshold) | |
Public Attributes | |
argument_t | x_ |
Gradient has been computed for this point. | |
gradient_t | analyticalGradient_ |
Analytical gradient. | |
gradient_t | finiteDifferenceGradient_ |
Gradient computed through finite differences. | |
value_type | maxDelta_ |
Maximum error. | |
size_type | maxDeltaComponent_ |
Component containing the maximum error. | |
value_type | threshold_ |
Allowed threshold. | |
Exception thrown when a gradient check fails.
roboptim::BadGradient< T >::BadGradient | ( | const_argument_ref | x, |
const_gradient_ref | analyticalGradient, | ||
const_gradient_ref | finiteDifferenceGradient, | ||
const value_type & | threshold ) |
Default constructor.
References analyticalGradient_, finiteDifferenceGradient_, maxDelta_, maxDeltaComponent_, threshold_, and x_.
|
virtual |
|
inline |
References analyticalGradient_, finiteDifferenceGradient_, maxDelta_, maxDeltaComponent_, threshold_, and x_.
|
virtual |
Display the exception on the specified output stream.
o | output stream used for display |
References analyticalGradient_, roboptim::decindent(), finiteDifferenceGradient_, roboptim::iendl(), roboptim::incindent(), maxDelta_, maxDeltaComponent_, threshold_, and x_.
Referenced by roboptim::operator<<().
roboptim::BadGradient< T >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ | ( | GenericDifferentiableFunction< T > | ) |
gradient_t roboptim::BadGradient< T >::analyticalGradient_ |
Analytical gradient.
Referenced by BadGradient(), and print().
gradient_t roboptim::BadGradient< T >::finiteDifferenceGradient_ |
Gradient computed through finite differences.
Referenced by BadGradient(), and print().
value_type roboptim::BadGradient< T >::maxDelta_ |
Maximum error.
Referenced by BadGradient(), and print().
size_type roboptim::BadGradient< T >::maxDeltaComponent_ |
Component containing the maximum error.
Referenced by BadGradient(), and print().
value_type roboptim::BadGradient< T >::threshold_ |
Allowed threshold.
Referenced by BadGradient(), and print().
argument_t roboptim::BadGradient< T >::x_ |
Gradient has been computed for this point.
Referenced by BadGradient(), and print().