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

Subtract two RobOptim functions. More...

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

Inheritance diagram for roboptim::Minus< U, V >:

Collaboration diagram for roboptim::Minus< U, V >:

Public Types
typedef detail::PromoteTrait< U, V >::T_promote	parentType_t
typedef boost::shared_ptr< Minus >	MinusShPtr_t
Public Types inherited from roboptim::detail::T_promote< U, V >
enum
enum
typedef AutopromoteTrait< U >::T_type	T1
typedef AutopromoteTrait< V >::T_type	T2
typedef promote2< T1, T2, promoteToT1 >::T_promote	T_promote

Public Member Functions
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (parentType_t)
	Minus (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
	~Minus ()
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
Public Member Functions inherited from roboptim::detail::T_promote< U, V >
	BOOST_MPL_ASSERT ((boost::mpl::bool_< knowBothRanks >))

Detailed Description

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

Subtract two RobOptim functions.

Template Parameters

U	first input function type.
V	second input function type.

Member Typedef Documentation

MinusShPtr_t

template<typename U, typename V>

typedef boost::shared_ptr<Minus> roboptim::Minus< U, V >::MinusShPtr_t

parentType_t

template<typename U, typename V>

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

Constructor & Destructor Documentation

Minus()

template<typename U, typename V>

roboptim::Minus< U, V >::Minus ( boost::shared_ptr< U > left, boost::shared_ptr< V > right )

explicit

References left(), and right().

~Minus()

template<typename U, typename V>

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

(

)

Member Function Documentation

impl_compute()

template<typename U, typename V>

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

impl_gradient()

template<typename U, typename V>

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

impl_jacobian()

template<typename U, typename V>

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

left() [1/2]

template<typename U, typename V>

U & roboptim::Minus< U, V >::left ( )

inline

left() [2/2]

template<typename U, typename V>

const boost::shared_ptr< U > & roboptim::Minus< U, V >::left ( ) const

inline

Referenced by Minus().

right() [1/2]

template<typename U, typename V>

V & roboptim::Minus< U, V >::right ( )

inline

right() [2/2]

template<typename U, typename V>

const boost::shared_ptr< V > & roboptim::Minus< U, V >::right ( ) const

inline

Referenced by Minus().

ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_()

template<typename U, typename V>

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

(

parentType_t

)