Mathematical abstract functions

Classes

class  roboptim::DerivableParametrizedFunction< F >
 Parametrized function with parameter derivative available. More...
 
class  roboptim::GenericDifferentiableFunction< T >
 Define an abstract derivable function ( $C^1$). 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 ( $C^0$). 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 ( $C^0$). 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 ( $C^2$). More...
 

Typedefs

typedef GenericSumOfC1Squares< EigenMatrixDense > roboptim::SumOfC1Squares
 Sum of the squares of dense differentiable functions. More...
 
typedef GenericSumOfC1Squares< EigenMatrixSparse > roboptim::SumOfC1SquaresSparse
 Sum of the squares of sparse differentiable functions. More...
 

Functions

template<typename T >
std::ostream & roboptim::operator<< (std::ostream &o, const GenericFunction< T > &f)
 Override operator<< to handle function display. More...
 
 roboptim::GenericFunction< T >::GenericFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string())
 Concrete class constructor should call this constructor. More...
 
virtual roboptim::GenericFunction< T >::~GenericFunction ()
 Trivial destructor. More...
 
virtual std::ostream & roboptim::GenericFunction< T >::print (std::ostream &) const
 Display the function on the specified output stream. More...
 

Variables

static const int roboptim::StorageOrder = Eigen::ROBOPTIM_STORAGE_ORDER
 Default matrix storage order. More...
 
static log4cxx::LoggerPtr roboptim::GenericFunction< T >::logger
 Pointer to function logger (see log4cxx documentation). More...
 

Detailed Description

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
inputSizefunction arity
outputSizeresult size
namefunction'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
ooutput stream used for display
ffunction to be displayed
Returns
output stream
template<typename T >
roboptim::GenericFunction< T >::~GenericFunction ( )
virtual

Trivial destructor.

Variable Documentation

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