Loading...
Searching...
No Matches
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 >:
Collaboration diagram for roboptim::Selection< U >:

Public Types

typedef detail::AutopromoteTrait< U >::T_type parentType_t
 
typedef boost::shared_ptr< SelectionSelectionShPtr_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
Uinput function type.

Member Typedef Documentation

◆ parentType_t

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

◆ SelectionShPtr_t

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

Constructor & Destructor Documentation

◆ Selection()

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
fctinput function.
startstart of the range.
sizesize of the range.

References roboptim::Selection< U >::origin().

◆ ~Selection()

template<typename U >
roboptim::Selection< U >::~Selection

Member Function Documentation

◆ impl_compute()

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

◆ impl_gradient()

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

◆ impl_jacobian()

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

◆ origin() [1/2]

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

◆ origin() [2/2]

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

◆ ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_()

template<typename U >
roboptim::Selection< U >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ ( parentType_t  )