Loading...
Searching...
No Matches
roboptim::BadGradient< T > Class Template Reference

Exception thrown when a gradient check fails. More...

#include <roboptim/core/decorator/finite-difference-gradient.hh>

Inheritance diagram for roboptim::BadGradient< T >:
Collaboration diagram for roboptim::BadGradient< T >:

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. More...
 
virtual ~BadGradient ()
 
virtual std::ostream & print (std::ostream &o) const
 Display the exception on the specified output stream. More...
 
 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. More...
 
gradient_t analyticalGradient_
 Analytical gradient. More...
 
gradient_t finiteDifferenceGradient_
 Gradient computed through finite differences. More...
 
value_type maxDelta_
 Maximum error. More...
 
size_type maxDeltaComponent_
 Component containing the maximum error. More...
 
value_type threshold_
 Allowed threshold. More...
 

Detailed Description

template<typename T>
class roboptim::BadGradient< T >

Exception thrown when a gradient check fails.

Constructor & Destructor Documentation

◆ BadGradient() [1/2]

template<typename T >
roboptim::BadGradient< T >::BadGradient ( const_argument_ref  x,
const_gradient_ref  analyticalGradient,
const_gradient_ref  finiteDifferenceGradient,
const value_type &  threshold 
)

◆ ~BadGradient()

template<typename T >
roboptim::BadGradient< T >::~BadGradient
virtual

◆ BadGradient() [2/2]

roboptim::BadGradient< EigenMatrixSparse >::BadGradient ( const_argument_ref  x,
const_gradient_ref  analyticalGradient,
const_gradient_ref  finiteDifferenceGradient,
const value_type &  threshold 
)
inline

Member Function Documentation

◆ print()

template<typename T >
std::ostream & roboptim::BadGradient< T >::print ( std::ostream &  o) const
virtual

Display the exception on the specified output stream.

Parameters
ooutput stream used for display
Returns
output stream

References roboptim::decindent(), roboptim::iendl(), and roboptim::incindent().

Referenced by roboptim::operator<<().

◆ ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_()

template<typename T >
roboptim::BadGradient< T >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ ( GenericDifferentiableFunction< T >  )

Member Data Documentation

◆ analyticalGradient_

template<typename T >
gradient_t roboptim::BadGradient< T >::analyticalGradient_

Analytical gradient.

◆ finiteDifferenceGradient_

template<typename T >
gradient_t roboptim::BadGradient< T >::finiteDifferenceGradient_

Gradient computed through finite differences.

◆ maxDelta_

template<typename T >
value_type roboptim::BadGradient< T >::maxDelta_

Maximum error.

Referenced by roboptim::BadGradient< T >::BadGradient().

◆ maxDeltaComponent_

template<typename T >
size_type roboptim::BadGradient< T >::maxDeltaComponent_

Component containing the maximum error.

Referenced by roboptim::BadGradient< T >::BadGradient().

◆ threshold_

template<typename T >
value_type roboptim::BadGradient< T >::threshold_

Allowed threshold.

◆ x_

template<typename T >
argument_t roboptim::BadGradient< T >::x_

Gradient has been computed for this point.