roboptim::SumOfC1Squares Class Reference

Sum of the squares of differentiable functions. More...

#include <roboptim/core/sum-of-c1-squares.hh>

Inheritance diagram for roboptim::SumOfC1Squares:

Collaboration diagram for roboptim::SumOfC1Squares:

List of all members.

Public Types
Types
typedef DifferentiableFunction	parent_t
typedef parent_t::argument_t	argument_t
	Type of a function evaluation argument.
typedef parent_t::jacobian_t	jacobian_t
	Jacobian type.
typedef parent_t::gradient_t	gradient_t
	Gradient type.
typedef parent_t::jacobianSize_t	jacobianSize_t
	Jacobian size type (pair of values).
typedef Function::size_type	size_t
typedef Function::value_type	value_t
Public Member Functions
	SumOfC1Squares (const boost::shared_ptr< DifferentiableFunction > &function, const std::string &name) throw ()
	SumOfC1Squares (const SumOfC1Squares &function) throw ()
virtual	~SumOfC1Squares () throw ()
const boost::shared_ptr< const DifferentiableFunction > &	baseFunction () const
	Get base function Base function is the vector valued function given at construction of this class.
Protected Member Functions
virtual void	impl_compute (result_t &result, const argument_t &x) const throw ()
	Compute value of function Value is sum of squares of coordinates of vector valued base function.
virtual void	impl_gradient (gradient_t &gradient, const argument_t &x, size_type row=0) const throw ()
	Gradient.

---

Detailed Description

Sum of the squares of differentiable functions.

This types enables roboptim to handle Levenberg Marquardt algorithm. This algorithm indeed minimizes the sum of squares of differentiable functions.

The differentiable functions are stored in a vector valued function called base function.

---

Member Typedef Documentation

typedef parent_t::argument_t roboptim::SumOfC1Squares::argument_t

Type of a function evaluation argument.

Reimplemented from roboptim::GenericFunction< T >.

typedef parent_t::gradient_t roboptim::SumOfC1Squares::gradient_t

Gradient type.

Reimplemented from roboptim::GenericDifferentiableFunction< T >.

typedef parent_t::jacobian_t roboptim::SumOfC1Squares::jacobian_t

Jacobian type.

Reimplemented from roboptim::GenericDifferentiableFunction< T >.

typedef parent_t::jacobianSize_t roboptim::SumOfC1Squares::jacobianSize_t

Jacobian size type (pair of values).

Reimplemented from roboptim::GenericDifferentiableFunction< T >.

typedef DifferentiableFunction roboptim::SumOfC1Squares::parent_t

typedef Function::size_type roboptim::SumOfC1Squares::size_t

typedef Function::value_type roboptim::SumOfC1Squares::value_t

---

Constructor & Destructor Documentation

roboptim::SumOfC1Squares::SumOfC1Squares	(	const boost::shared_ptr< DifferentiableFunction > &	function,
		const std::string &	name
	)		throw () [explicit]

roboptim::SumOfC1Squares::SumOfC1Squares

(

const SumOfC1Squares &

function

)

throw () [explicit]

roboptim::SumOfC1Squares::~SumOfC1Squares

(

)

throw () [virtual]

---

Member Function Documentation

const boost::shared_ptr< const DifferentiableFunction > & roboptim::SumOfC1Squares::baseFunction

(

)

const

Get base function Base function is the vector valued function given at construction of this class.

void roboptim::SumOfC1Squares::impl_compute	(	result_t &	result,
		const argument_t &	x
	)		const throw () [protected, virtual]

Compute value of function Value is sum of squares of coordinates of vector valued base function.

ROBOPTIM_DO_NOT_CHECK_ALLOCATION

Implements roboptim::GenericFunction< T >.

void roboptim::SumOfC1Squares::impl_gradient	(	gradient_t &	gradient,
		const argument_t &	x,
		size_type	row = 0
	)		const throw () [protected, virtual]

Gradient.

ROBOPTIM_DO_NOT_CHECK_ALLOCATION

Implements roboptim::GenericDifferentiableFunction< T >.