Loading...
Searching...
No Matches
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< EigenMatrixDenseroboptim::SumOfC1Squares
 Sum of the squares of dense differentiable functions.
 
typedef GenericSumOfC1Squares< EigenMatrixSparseroboptim::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).
 

Detailed Description

Typedef Documentation

◆ SumOfC1Squares

Sum of the squares of dense differentiable functions.

See also
GenericSumOfC1Squares

◆ SumOfC1SquaresSparse

Sum of the squares of sparse differentiable functions.

See also
GenericSumOfC1Squares

Function Documentation

◆ GenericFunction()

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

References inputSize(), and outputSize().

Referenced by roboptim::GenericDifferentiableFunction< T >::GenericDifferentiableFunction(), and roboptim::interval_t< traits_t >::ROBOPTIM_FUNCTION_FWD_TYPEDEFS_().

◆ operator<<()

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

References roboptim::GenericFunction< T >::print().

◆ print()

template<typename T>
std::ostream & roboptim::GenericFunction< T >::print ( std::ostream & o) const
virtual

Display the function on the specified output stream.

Parameters
ooutput stream used for display
Returns
output stream

Reimplemented in roboptim::Cos< T >, roboptim::GenericConstantFunction< T >, roboptim::GenericConstantFunction< EigenMatrixDense >, roboptim::GenericConstantFunction< EigenMatrixDense >, roboptim::GenericDifferentiableFunction< T >, roboptim::GenericDifferentiableFunction< EigenMatrixDense >, roboptim::GenericDifferentiableFunction< EigenMatrixDense >, roboptim::GenericDifferentiableFunction< EigenMatrixSparse >, roboptim::GenericDifferentiableFunction< EigenMatrixSparse >, roboptim::GenericDifferentiableFunction< traits_t >, roboptim::GenericDifferentiableFunction< traits_t >, roboptim::GenericDifferentiableFunction< typename FuncType::traits_t >, roboptim::GenericDifferentiableFunction< typename FuncType::traits_t >, roboptim::GenericIdentityFunction< T >, roboptim::GenericIdentityFunction< EigenMatrixDense >, roboptim::GenericIdentityFunction< EigenMatrixDense >, roboptim::GenericLinearFunction< T >, roboptim::GenericLinearFunction< EigenMatrixDense >, roboptim::GenericLinearFunction< EigenMatrixDense >, roboptim::GenericLinearFunction< EigenMatrixSparse >, roboptim::GenericLinearFunction< EigenMatrixSparse >, roboptim::GenericNumericLinearFunction< T >, roboptim::GenericNumericLinearFunction< EigenMatrixDense >, roboptim::GenericNumericLinearFunction< EigenMatrixDense >, roboptim::GenericNumericQuadraticFunction< T >, roboptim::GenericNumericQuadraticFunction< EigenMatrixDense >, roboptim::GenericNumericQuadraticFunction< EigenMatrixDense >, roboptim::GenericQuadraticFunction< T >, roboptim::GenericQuadraticFunction< EigenMatrixDense >, roboptim::GenericQuadraticFunction< EigenMatrixDense >, roboptim::GenericQuadraticFunction< EigenMatrixSparse >, roboptim::GenericQuadraticFunction< EigenMatrixSparse >, roboptim::GenericTwiceDifferentiableFunction< T >, roboptim::GenericTwiceDifferentiableFunction< EigenMatrixDense >, roboptim::GenericTwiceDifferentiableFunction< EigenMatrixDense >, roboptim::GenericTwiceDifferentiableFunction< EigenMatrixSparse >, roboptim::GenericTwiceDifferentiableFunction< EigenMatrixSparse >, roboptim::interval_t< traits_t >, roboptim::interval_t< traits_t >, roboptim::NTimesDerivableFunction< 2 >, roboptim::NTimesDerivableFunction< 2 >, roboptim::Polynomial< T >, and roboptim::Sin< T >.

References getName(), and roboptim::indent().

Referenced by roboptim::operator<<().

◆ ~GenericFunction()

template<typename T>
roboptim::GenericFunction< T >::~GenericFunction ( )
virtual

Trivial destructor.

Variable Documentation

◆ logger

template<typename T>
log4cxx::LoggerPtr roboptim::GenericFunction< T >::logger
staticprotected

Pointer to function logger (see log4cxx documentation).

Referenced by roboptim::interval_t< traits_t >::gradient(), and roboptim::interval_t< traits_t >::jacobian().

◆ StorageOrder

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