Mathematical abstract functions

Classes
class	roboptim::DerivableParametrizedFunction< F >
	Parametrized function with parameter derivative available. More...
class	roboptim::GenericDifferentiableFunction< T >
	Define an abstract derivable function ( ). More...
class	roboptim::FunctionPool< F, FLIST >
	A pool of functions that will be processed together. More...
struct	roboptim::GenericFunctionTraits< T >
	GenericFunction traits. More...
class	roboptim::GenericFunction< T >
	Define an abstract mathematical function ( ). More...
struct	roboptim::GenericFunctionTraits< EigenMatrixDense >
	Trait specializing GenericFunction for Eigen dense matrices. More...
struct	roboptim::GenericFunctionTraits< EigenMatrixSparse >
	Trait specializing GenericFunction for Eigen sparse matrices. More...
class	roboptim::GenericLinearFunction< T >
	Define an abstract linear function. More...
class	roboptim::ParametrizedFunction< F >
	Define an abstract parametrized mathematical function ( ). More...
class	roboptim::GenericQuadraticFunction< T >
	Define an abstract quadratic function. More...
class	roboptim::GenericSumOfC1Squares< T >
	Generic sum of the squares of differentiable functions. More...
class	roboptim::GenericTwiceDifferentiableFunction< T >
	Define an abstract function which is twice-derivable ( ). More...
Typedefs
typedef GenericSumOfC1Squares < EigenMatrixDense >	roboptim::SumOfC1Squares
	Sum of the squares of dense differentiable functions.
typedef GenericSumOfC1Squares < EigenMatrixSparse >	roboptim::SumOfC1SquaresSparse
	Sum of the squares of sparse differentiable functions.
Functions
template<typename T >
std::ostream &	roboptim::operator<< (std::ostream &o, const GenericFunction< T > &f)
	Override operator<< to handle function display.
	roboptim::GenericFunction< T >::GenericFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string())
	Concrete class constructor should call this constructor.
virtual	roboptim::GenericFunction< T >::~GenericFunction ()
	Trivial destructor.
virtual std::ostream &	roboptim::GenericFunction< T >::print (std::ostream &) const
	Display the function on the specified output stream.
Variables
static const int	roboptim::StorageOrder = Eigen::ROBOPTIM_STORAGE_ORDER
	Default matrix storage order.
static log4cxx::LoggerPtr	roboptim::GenericFunction< T >::logger
	Pointer to function logger (see log4cxx documentation).

---

Typedef Documentation

typedef GenericSumOfC1Squares<EigenMatrixDense> roboptim::SumOfC1Squares

Sum of the squares of dense differentiable functions.

See also:

GenericSumOfC1Squares

typedef GenericSumOfC1Squares<EigenMatrixSparse> roboptim::SumOfC1SquaresSparse

Sum of the squares of sparse differentiable functions.

See also:

GenericSumOfC1Squares

---

Function Documentation

template<typename T >

roboptim::GenericFunction< T >::GenericFunction	(	size_type	inputSize,
		size_type	outputSize = 1,
		std::string	name = std::string ()
	)		[protected]

Concrete class constructor should call this constructor.

Parameters:

inputSize	function arity
outputSize	result size
name	function's name

Exceptions:

std::runtime_error

template<typename T >

std::ostream & roboptim::operator<<	(	std::ostream &	o,
		const GenericFunction< T > &	f
	)

Override operator<< to handle function display.

Parameters:

o	output stream used for display
f	function to be displayed

Returns:

output stream

template<typename T >

std::ostream & roboptim::GenericFunction< T >::print

(

std::ostream &

o

)

const [virtual]

Display the function on the specified output stream.

Parameters:

o	output stream used for display

Returns:

output stream

Reimplemented in roboptim::GenericDifferentiableFunction< T >, roboptim::NTimesDerivableFunction< 2 >, roboptim::GenericTwiceDifferentiableFunction< T >, roboptim::GenericNumericQuadraticFunction< T >, roboptim::GenericConstantFunction< T >, roboptim::GenericNumericLinearFunction< T >, roboptim::GenericIdentityFunction< T >, roboptim::Polynomial< T >, roboptim::GenericLinearFunction< T >, roboptim::GenericQuadraticFunction< T >, roboptim::Cos< T >, and roboptim::Sin< T >.

References roboptim::indent().

template<typename T >

roboptim::GenericFunction< T >::~GenericFunction

(

)

[virtual]

Trivial destructor.

---

Variable Documentation

template<typename T>

log4cxx::LoggerPtr roboptim::GenericFunction< T >::logger [static, protected]

Pointer to function logger (see log4cxx documentation).

Referenced by roboptim::GenericDifferentiableFunction< T >::gradient(), roboptim::GenericTwiceDifferentiableFunction< T >::hessian(), roboptim::GenericDifferentiableFunction< T >::jacobian(), and roboptim::GenericFunction< T >::operator()().

const int roboptim::StorageOrder = Eigen::ROBOPTIM_STORAGE_ORDER [static]

Default matrix storage order.

Referenced by roboptim::visualization::matplotlib::detail::sparse_matrix_to_matplotlib().