roboptim::BadJacobian< T > Class Template Reference

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

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

Inheritance diagram for roboptim::BadJacobian< T >:

Collaboration diagram for roboptim::BadJacobian< T >:

Public Member Functions
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericDifferentiableFunction< T >)
	BadJacobian (const_argument_ref x, const_jacobian_ref analyticalJacobian, const_jacobian_ref finiteDifferenceJacobian, const value_type &threshold)
	Default constructor.
virtual	~BadJacobian ()
virtual std::ostream &	print (std::ostream &o) const
	Display the exception on the specified output stream.
	BadJacobian (const_argument_ref x, const_jacobian_ref analyticalJacobian, const_jacobian_ref finiteDifferenceJacobian, const value_type &threshold)

Public Attributes
argument_t	x_
	Jacobian has been computed for this point.
gradient_t	analyticalJacobian_
	Analytical Jacobian.
gradient_t	finiteDifferenceJacobian_
	Jacobian computed through finite differences.
value_type	maxDelta_
	Maximum error.
size_type	maxDeltaRow_
	Components containing the maximum error.
size_type	maxDeltaCol_
value_type	threshold_
	Allowed threshold.

Detailed Description

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

Exception thrown when a Jacobian check fails.

Constructor & Destructor Documentation

BadJacobian() [1/2]

template<typename T>

roboptim::BadJacobian< T >::BadJacobian	(	const_argument_ref	x,
		const_jacobian_ref	analyticalJacobian,
		const_jacobian_ref	finiteDifferenceJacobian,
		const value_type &	threshold )

Default constructor.

References analyticalJacobian_, finiteDifferenceJacobian_, maxDelta_, maxDeltaCol_, maxDeltaRow_, threshold_, and x_.

~BadJacobian()

template<typename T>

roboptim::BadJacobian< T >::~BadJacobian ( )

virtual

BadJacobian() [2/2]

roboptim::BadJacobian< EigenMatrixSparse >::BadJacobian ( const_argument_ref x, const_jacobian_ref analyticalJacobian, const_jacobian_ref finiteDifferenceJacobian, const value_type & threshold )

inline

References analyticalJacobian_, finiteDifferenceJacobian_, maxDelta_, maxDeltaCol_, maxDeltaRow_, threshold_, and x_.

Member Function Documentation

print()

template<typename T>

std::ostream & roboptim::BadJacobian< 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 analyticalJacobian_, roboptim::decindent(), finiteDifferenceJacobian_, roboptim::iendl(), roboptim::incindent(), maxDelta_, maxDeltaCol_, maxDeltaRow_, threshold_, and x_.

Referenced by roboptim::operator<<().

ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_()

template<typename T>

roboptim::BadJacobian< T >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_

(

GenericDifferentiableFunction< T >

)

Member Data Documentation

analyticalJacobian_

template<typename T>

gradient_t roboptim::BadJacobian< T >::analyticalJacobian_

Analytical Jacobian.

Referenced by BadJacobian(), and print().

finiteDifferenceJacobian_

template<typename T>

gradient_t roboptim::BadJacobian< T >::finiteDifferenceJacobian_

Jacobian computed through finite differences.

Referenced by BadJacobian(), and print().

maxDelta_

template<typename T>

value_type roboptim::BadJacobian< T >::maxDelta_

Maximum error.

Referenced by BadJacobian(), and print().

maxDeltaCol_

template<typename T>

size_type roboptim::BadJacobian< T >::maxDeltaCol_

Referenced by BadJacobian(), and print().

maxDeltaRow_

template<typename T>

size_type roboptim::BadJacobian< T >::maxDeltaRow_

Components containing the maximum error.

Referenced by BadJacobian(), and print().

threshold_

template<typename T>

value_type roboptim::BadJacobian< T >::threshold_

Allowed threshold.

Referenced by BadJacobian(), and print().

x_

template<typename T>

argument_t roboptim::BadJacobian< T >::x_

Jacobian has been computed for this point.

Referenced by BadJacobian(), and print().