roboptim::Chain< U, V > Class Template Reference

Chain two RobOptim functions. More...

#include <roboptim/core/operator/chain.hh>

List of all members.

Public Types
typedef detail::PromoteTrait < U, V >::T_promote	parentType_t
typedef boost::shared_ptr< Chain >	ChainShPtr_t
Public Member Functions
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (parentType_t)
	Chain (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
	Chain operator constructor.
	~Chain ()
const boost::shared_ptr< U > &	left () const
U &	left ()
const boost::shared_ptr< V > &	right () const
V &	right ()
void	impl_compute (result_ref result, const_argument_ref x) const
void	impl_gradient (gradient_ref gradient, const_argument_ref argument, size_type functionId=0) const
void	impl_jacobian (jacobian_ref jacobian, const_argument_ref arg) const

---

Detailed Description

template<typename U, typename V>
class roboptim::Chain< U, V >

Chain two RobOptim functions.

Input: (size: right function input size) x

Output: x (size: left function output size) left (right (x))

(left (right (x)))' = left'(right(x)) * right'(x)

Template Parameters:

U	left input function type.
V	right input function type.

---

Member Typedef Documentation

template<typename U , typename V >

typedef boost::shared_ptr<Chain> roboptim::Chain< U, V >::ChainShPtr_t

template<typename U , typename V >

typedef detail::PromoteTrait<U, V>::T_promote roboptim::Chain< U, V >::parentType_t

---

Constructor & Destructor Documentation

template<typename U , typename V >

roboptim::Chain< U, V >::Chain	(	boost::shared_ptr< U >	left,
		boost::shared_ptr< V >	right
	)		[explicit]

Chain operator constructor.

Parameters:

left	Left function
right	Right function

template<typename U , typename V >

roboptim::Chain< U, V >::~Chain

(

)

---

Member Function Documentation

template<typename U , typename V >

void roboptim::Chain< U, V >::impl_compute	(	result_ref	result,
		const_argument_ref	x
	)		const

template<typename U , typename V >

void roboptim::Chain< U, V >::impl_gradient	(	gradient_ref	gradient,
		const_argument_ref	argument,
		size_type	functionId = 0
	)		const

template<typename U , typename V >

void roboptim::Chain< U, V >::impl_jacobian	(	jacobian_ref	jacobian,
		const_argument_ref	arg
	)		const

template<typename U , typename V >

const boost::shared_ptr<U>& roboptim::Chain< U, V >::left

(

)

const [inline]

template<typename U , typename V >

U& roboptim::Chain< U, V >::left

(

)

[inline]

template<typename U , typename V >

const boost::shared_ptr<V>& roboptim::Chain< U, V >::right

(

)

const [inline]

template<typename U , typename V >

V& roboptim::Chain< U, V >::right

(

)

[inline]

template<typename U , typename V >

roboptim::Chain< U, V >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_

(

parentType_t

)