Function operators

Classes
class	roboptim::Bind< U >
	Bind some function input to a constant value. More...
class	roboptim::Chain< U, V >
	Chain two RobOptim functions. More...
class	roboptim::Concatenate< U >
	Concatenate the output of two functions. More...
class	roboptim::Derivative< U >
	Return the derivative of a function w.r.t. More...
class	roboptim::Map< U >
	Apply a function several times to an input vector. More...
class	roboptim::Minus< U, V >
	Subtract two RobOptim functions. More...
class	roboptim::Plus< U, V >
	Sum two RobOptim functions. More...
class	roboptim::Product< U, V >
	Product of two RobOptim functions. More...
class	roboptim::Scalar< U >
	Multiply by a constant scalar value. More...
class	roboptim::SelectionById< U >
	Select part of a function. More...
class	roboptim::Selection< U >
	Select a block of a function's output. More...
class	roboptim::Split< T >
	Select an element of a function's output. More...

Functions
template<typename U>
boost::shared_ptr< Bind< U > >	roboptim::bind (boost::shared_ptr< U > origin, const typename Bind< U >::boundValues_t &boundValues)
template<typename U, typename V>
boost::shared_ptr< Chain< U, V > >	roboptim::chain (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
	Chain two RobOptim functions.
template<typename U, typename V>
boost::shared_ptr< Concatenate< typename detail::PromoteTrait< U, V >::T_promote > >	roboptim::concatenate (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
template<typename U>
boost::shared_ptr< Derivative< U > >	roboptim::derivative (boost::shared_ptr< U > origin, typename Derivative< U >::size_type variableId=0)
template<typename U>
boost::shared_ptr< Map< U > >	roboptim::map (boost::shared_ptr< U > origin, typename U::size_type repeat)
template<typename U, typename V>
boost::shared_ptr< Minus< U, V > >	roboptim::minus (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
template<typename U, typename V>
boost::shared_ptr< Minus< U, V > >	roboptim::operator- (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
template<typename U, typename V>
boost::shared_ptr< Plus< U, V > >	roboptim::plus (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
template<typename U, typename V>
boost::shared_ptr< Plus< U, V > >	roboptim::operator+ (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
template<typename U, typename V>
boost::shared_ptr< Product< U, V > >	roboptim::product (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
template<typename U, typename V>
boost::shared_ptr< Product< U, V > >	roboptim::operator* (boost::shared_ptr< U > left, boost::shared_ptr< V > right)
template<typename U>
boost::shared_ptr< Scalar< U > >	roboptim::scalar (boost::shared_ptr< U > origin, typename Scalar< U >::size_type start=0, typename Scalar< U >::size_type size=1)
template<typename U>
boost::shared_ptr< Scalar< U > >	roboptim::operator* (typename Scalar< U >::value_type scalar, boost::shared_ptr< U > origin)
template<typename U>
boost::shared_ptr< Scalar< U > >	roboptim::operator* (boost::shared_ptr< U > origin, typename Scalar< U >::value_type scalar)
template<typename U>
boost::shared_ptr< U >	roboptim::operator+ (boost::shared_ptr< U > origin)
template<typename U>
boost::shared_ptr< Scalar< U > >	roboptim::operator- (boost::shared_ptr< U > origin)
template<typename U>
boost::shared_ptr< SelectionById< U > >	roboptim::selectionById (boost::shared_ptr< U > origin, std::vector< bool > selector)
template<typename U>
boost::shared_ptr< Selection< U > >	roboptim::selection (boost::shared_ptr< U > origin, typename Selection< U >::size_type start=0, typename Selection< U >::size_type size=1)
template<typename P, typename C>
void	roboptim::addNonScalarConstraint (P &problem, boost::shared_ptr< C > constraint, std::vector< Function::interval_t > interval, std::vector< Function::value_type > scale=std::vector< Function::value_type >())

Detailed Description

Function Documentation

addNonScalarConstraint()

template<typename P, typename C>

void roboptim::addNonScalarConstraint	(	P &	problem,
		boost::shared_ptr< C >	constraint,
		std::vector< Function::interval_t >	interval,
		std::vector< Function::value_type >	scale = std::vector<Function::value_type> () )

bind()

template<typename U>

boost::shared_ptr< Bind< U > > roboptim::bind	(	boost::shared_ptr< U >	origin,
		const typename Bind< U >::boundValues_t &	boundValues )

chain()

template<typename U, typename V>

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

Chain two RobOptim functions.

This will instantiate a Chain<U,V> RobOptim operator that will realize the underlying computations.

concatenate()

template<typename U, typename V>

boost::shared_ptr< Concatenate< typename detail::PromoteTrait< U, V >::T_promote > > roboptim::concatenate	(	boost::shared_ptr< U >	left,
		boost::shared_ptr< V >	right )

derivative()

template<typename U>

boost::shared_ptr< Derivative< U > > roboptim::derivative	(	boost::shared_ptr< U >	origin,
		typename Derivative< U >::size_type	variableId = 0 )

map()

template<typename U>

boost::shared_ptr< Map< U > > roboptim::map	(	boost::shared_ptr< U >	origin,
		typename U::size_type	repeat )

minus()

template<typename U, typename V>

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

operator*() [1/3]

template<typename U, typename V>

boost::shared_ptr< Product< U, V > > roboptim::operator*	(	boost::shared_ptr< U >	left,
		boost::shared_ptr< V >	right )

operator*() [2/3]

template<typename U>

boost::shared_ptr< Scalar< U > > roboptim::operator*	(	boost::shared_ptr< U >	origin,
		typename Scalar< U >::value_type	scalar )

References scalar().

operator*() [3/3]

template<typename U>

boost::shared_ptr< Scalar< U > > roboptim::operator*	(	typename Scalar< U >::value_type	scalar,
		boost::shared_ptr< U >	origin )

References scalar().

operator+() [1/2]

template<typename U, typename V>

boost::shared_ptr< Plus< U, V > > roboptim::operator+	(	boost::shared_ptr< U >	left,
		boost::shared_ptr< V >	right )

operator+() [2/2]

template<typename U>

boost::shared_ptr< U > roboptim::operator+

(

boost::shared_ptr< U >

origin

)

operator-() [1/2]

template<typename U, typename V>

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

operator-() [2/2]

template<typename U>

boost::shared_ptr< Scalar< U > > roboptim::operator-

(

boost::shared_ptr< U >

origin

)

plus()

template<typename U, typename V>

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

product()

template<typename U, typename V>

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

scalar()

template<typename U>

boost::shared_ptr< Scalar< U > > roboptim::scalar	(	boost::shared_ptr< U >	origin,
		typename Scalar< U >::size_type	start = 0,
		typename Scalar< U >::size_type	size = 1 )

Referenced by operator*(), operator*(), roboptim::parent_t< U >::Scalar(), and roboptim::Scalar< U >::Scalar().

selection()

template<typename U>

boost::shared_ptr< Selection< U > > roboptim::selection	(	boost::shared_ptr< U >	origin,
		typename Selection< U >::size_type	start = 0,
		typename Selection< U >::size_type	size = 1 )

selectionById()

template<typename U>

boost::shared_ptr< SelectionById< U > > roboptim::selectionById	(	boost::shared_ptr< U >	origin,
		std::vector< bool >	selector )