roboptim::Scalar< U > Class Template Reference

Multiply by a constant scalar value. More...

#include <roboptim/core/filter/scalar.hh>

List of all members.

Public Types
typedef detail::AutopromoteTrait< U > ::T_type	parentType_t
typedef boost::shared_ptr< Scalar >	ScalarShPtr_t
Public Member Functions
	ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (parentType_t)
	Scalar (boost::shared_ptr< U > fct, value_type scalar)
	Create a scalar filter.
	~Scalar ()
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::Scalar< U >

Multiply by a constant scalar value.

Template Parameters:

U	input function type.

---

Member Typedef Documentation

template<typename U>

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

template<typename U>

typedef boost::shared_ptr<Scalar> roboptim::Scalar< U >::ScalarShPtr_t

---

Constructor & Destructor Documentation

template<typename U >

roboptim::Scalar< U >::Scalar	(	boost::shared_ptr< U >	fct,
		value_type	scalar
	)		[explicit]

Create a scalar filter.

Parameters:

fct	input function.
scalar	scalar value.

template<typename U >

roboptim::Scalar< U >::~Scalar

(

)

---

Member Function Documentation

template<typename U >

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

template<typename U >

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

template<typename U >

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

template<typename U>

const boost::shared_ptr<U>& roboptim::Scalar< U >::origin

(

)

const [inline]

template<typename U>

boost::shared_ptr<U>& roboptim::Scalar< U >::origin

(

)

[inline]

template<typename U>

roboptim::Scalar< U >::ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_

(

parentType_t

)