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.
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.

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 )

Default constructor.

References analyticalGradient_, finiteDifferenceGradient_, maxDelta_, maxDeltaComponent_, threshold_, and x_.

~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

References analyticalGradient_, finiteDifferenceGradient_, maxDelta_, maxDeltaComponent_, threshold_, and x_.

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

o	output stream used for display

Returns

output stream

References analyticalGradient_, roboptim::decindent(), finiteDifferenceGradient_, roboptim::iendl(), roboptim::incindent(), maxDelta_, maxDeltaComponent_, threshold_, and x_.

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.

Referenced by BadGradient(), and print().

finiteDifferenceGradient_

template<typename T>

gradient_t roboptim::BadGradient< T >::finiteDifferenceGradient_

Gradient computed through finite differences.

Referenced by BadGradient(), and print().

maxDelta_

template<typename T>

value_type roboptim::BadGradient< T >::maxDelta_

Maximum error.

Referenced by BadGradient(), and print().

maxDeltaComponent_

template<typename T>

size_type roboptim::BadGradient< T >::maxDeltaComponent_

Component containing the maximum error.

Referenced by BadGradient(), and print().

threshold_

template<typename T>

value_type roboptim::BadGradient< T >::threshold_

Allowed threshold.

Referenced by BadGradient(), and print().

x_

template<typename T>

argument_t roboptim::BadGradient< T >::x_

Gradient has been computed for this point.

Referenced by BadGradient(), and print().