roboptim::GenericSumOfC1Squares< T > Class Template Reference

Generic sum of the squares of differentiable functions. More...

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

Inheritance diagram for roboptim::GenericSumOfC1Squares< T >:

List of all members.

Public Member Functions
	GenericSumOfC1Squares (const boost::shared_ptr< parent_t > &function, const std::string &name)
	GenericSumOfC1Squares (const GenericSumOfC1Squares< T > &function)
virtual	~GenericSumOfC1Squares ()
const boost::shared_ptr< const parent_t > &	baseFunction () const
	Get base function Base function is the vector valued function given at construction of this class.
Types
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericDifferentiableFunction< T >)
Protected Member Functions
virtual void	impl_compute (result_ref result, const_argument_ref x) const
	Compute value of function Value is sum of squares of coordinates of vector valued base function.
virtual void	impl_gradient (gradient_ref gradient, const_argument_ref x, size_type row=0) const
	Gradient.

---

Detailed Description

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

Generic sum of the squares of differentiable functions.

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

Template Parameters:

T	function type

---

Constructor & Destructor Documentation

template<typename T >

roboptim::GenericSumOfC1Squares< T >::GenericSumOfC1Squares	(	const boost::shared_ptr< parent_t > &	function,
		const std::string &	name
	)		[explicit]

template<typename T >

roboptim::GenericSumOfC1Squares< T >::GenericSumOfC1Squares

(

const GenericSumOfC1Squares< T > &

function

)

[explicit]

template<typename T >

roboptim::GenericSumOfC1Squares< T >::~GenericSumOfC1Squares

(

)

[virtual]

---

Member Function Documentation

template<typename T >

const boost::shared_ptr< const typename GenericSumOfC1Squares< T >::parent_t > & roboptim::GenericSumOfC1Squares< T >::baseFunction

(

)

const

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

template<typename T >

void roboptim::GenericSumOfC1Squares< T >::impl_compute	(	result_ref	result,
		const_argument_ref	x
	)		const [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 >.

template<typename T>

void roboptim::GenericSumOfC1Squares< T >::impl_gradient	(	gradient_ref	gradient,
		const_argument_ref	x,
		size_type	row = 0
	)		const [protected, virtual]

Gradient.

ROBOPTIM_DO_NOT_CHECK_ALLOCATION

Implements roboptim::GenericDifferentiableFunction< T >.

template<typename T>

roboptim::GenericSumOfC1Squares< T >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_

(

GenericDifferentiableFunction< T >

)