roboptim::Selection< U > Class Template Reference

Select a block of a function's output. More...

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

Inheritance diagram for roboptim::Selection< U >:

Public Types
typedef detail::AutopromoteTrait< U > ::T_type	parentType_t
typedef boost::shared_ptr < Selection >	SelectionShPtr_t

Public Member Functions
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (parentType_t)
	Selection (boost::shared_ptr< U > fct, size_type start, size_type size)
	Create a selection given an input function and a block. More...
	~Selection ()
const boost::shared_ptr< U > &	origin () const
boost::shared_ptr< U > &	origin ()
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>
class roboptim::Selection< U >

Select a block of a function's output.

The selected block is a range given by a start and a size.

Template Parameters

U	input function type.

Member Typedef Documentation

template<typename U >

typedef detail::AutopromoteTrait<U>::T_type roboptim::Selection< U >::parentType_t

template<typename U >

typedef boost::shared_ptr<Selection> roboptim::Selection< U >::SelectionShPtr_t

Constructor & Destructor Documentation

template<typename U >

roboptim::Selection< U >::Selection ( boost::shared_ptr< U >  fct, size_type  start, size_type  size  )

explicit

Create a selection given an input function and a block.

Parameters

fct	input function.
start	start of the range.
size	size of the range.

References jacobian_, and result_.

template<typename U >

roboptim::Selection< U >::~Selection

(

)

Member Function Documentation

template<typename U >

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

References result_.

template<typename U >

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

template<typename U >

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

References jacobian_.

template<typename U >

const boost::shared_ptr<U>& roboptim::Selection< U >::origin ( ) const

inline

template<typename U >

boost::shared_ptr<U>& roboptim::Selection< U >::origin ( )

inline

template<typename U >

roboptim::Selection< U >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_

(

parentType_t

)