Define an abstract linear function. More...
#include <roboptim/core/linear-function.hh>
Public Member Functions | |
GenericLinearFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw () | |
Concrete class constructor should call this constructor. More... | |
virtual std::ostream & | print (std::ostream &) const throw () |
Display the function on the specified output stream. More... | |
![]() | |
GenericQuadraticFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw () | |
Concrete class constructor should call this constructor. More... | |
![]() | |
ROBOPTIM_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericDifferentiableFunction< T >) | |
hessianSize_t | hessianSize () const throw () |
Return the size of a hessian. More... | |
bool | isValidHessian (const hessian_t &hessian) const throw () |
Check if the hessian is valid (check sizes). More... | |
hessian_t | hessian (const argument_t &argument, size_type functionId=0) const throw () |
Compute the hessian at a given point. More... | |
void | hessian (hessian_t &hessian, const argument_t &argument, size_type functionId=0) const throw () |
Compute the hessian at a given point. More... | |
![]() | |
ROBOPTIM_FUNCTION_FWD_TYPEDEFS_ (GenericFunction< T >) | |
size_type | gradientSize () const throw () |
Return the gradient size. More... | |
jacobianSize_t | jacobianSize () const throw () |
Return the jacobian size as a pair. More... | |
bool | isValidGradient (const gradient_t &gradient) const throw () |
Check if the gradient is valid (check size). More... | |
bool | isValidJacobian (const jacobian_t &jacobian) const throw () |
Check if the jacobian is valid (check sizes). More... | |
jacobian_t | jacobian (const argument_t &argument) const throw () |
Computes the jacobian. More... | |
void | jacobian (jacobian_t &jacobian, const argument_t &argument) const throw () |
Computes the jacobian. More... | |
gradient_t | gradient (const argument_t &argument, size_type functionId=0) const throw () |
Computes the gradient. More... | |
void | gradient (gradient_t &gradient, const argument_t &argument, size_type functionId=0) const throw () |
Computes the gradient. More... | |
![]() | |
bool | isValidResult (const result_t &result) const throw () |
Check the given result size is valid. More... | |
GenericFunction< T >::size_type | inputSize () const throw () |
Return the input size (i.e. More... | |
GenericFunction< T >::size_type | outputSize () const throw () |
Return the output size (i.e. More... | |
virtual | ~GenericFunction () throw () |
Trivial destructor. More... | |
result_t | operator() (const argument_t &argument) const throw () |
Evaluate the function at a specified point. More... | |
void | operator() (result_t &result, const argument_t &argument) const throw () |
Evaluate the function at a specified point. More... | |
const std::string & | getName () const throw () |
Get function name. More... | |
Protected Member Functions | |
void | impl_hessian (hessian_t &hessian, const argument_t &argument, size_type functionId=0) const throw () |
Hessian evaluation. More... | |
Additional Inherited Members | |
![]() | |
static value_type | epsilon () throw () |
Get the value of the machine epsilon, useful for floating types comparison. More... | |
static value_type | infinity () throw () |
Get the value that symbolizes positive infinity. More... | |
static interval_t | makeInterval (value_type l, value_type u) throw () |
Construct an interval from a lower and upper bound. More... | |
static interval_t | makeInfiniteInterval () throw () |
Construct an infinite interval. More... | |
static interval_t | makeLowerInterval (value_type l) throw () |
Construct an interval from a lower bound. More... | |
static interval_t | makeUpperInterval (value_type u) throw () |
Construct an interval from an upper bound. More... | |
static double | getLowerBound (const interval_t &interval) throw () |
Get the lower bound of an interval. More... | |
static double | getUpperBound (const interval_t &interval) throw () |
Get the upper bound of an interval. More... | |
static discreteInterval_t | makeDiscreteInterval (value_type min, value_type max, value_type step) |
Construct a discrete interval. More... | |
static discreteInterval_t | makeDiscreteInterval (interval_t interval, value_type step) |
Construct a discrete interval. More... | |
static double | getLowerBound (const discreteInterval_t &interval) throw () |
Get the lower bound of a discrete interval. More... | |
static double | getUpperBound (const discreteInterval_t &interval) throw () |
Get the upper bound of a discrete interval. More... | |
static double | getStep (const discreteInterval_t &interval) throw () |
Get the upper step of a discrete interval. More... | |
template<typename F > | |
static void | foreach (const discreteInterval_t interval, F functor) |
Iterate on an interval. More... | |
template<typename F > | |
static void | foreach (const interval_t interval, const size_type n, F functor) |
Iterate on an interval. More... | |
![]() | |
static log4cxx::LoggerPtr | logger |
Pointer to function logger (see log4cxx documentation). More... | |
Define an abstract linear function.
Inherit from this class when implementing linear functions.
typedef parent_t::argument_t roboptim::GenericLinearFunction< T >::argument_t |
typedef parent_t::hessian_t roboptim::GenericLinearFunction< T >::hessian_t |
typedef GenericQuadraticFunction<T> roboptim::GenericLinearFunction< T >::parent_t |
typedef parent_t::result_t roboptim::GenericLinearFunction< T >::result_t |
typedef parent_t::size_type roboptim::GenericLinearFunction< T >::size_type |
typedef parent_t::vector_t roboptim::GenericLinearFunction< T >::vector_t |
roboptim::GenericLinearFunction< T >::GenericLinearFunction | ( | size_type | inputSize, |
size_type | outputSize = 1 , |
||
std::string | name = std::string () |
||
) | |||
throw | ( | ||
) |
Concrete class constructor should call this constructor.
inputSize | function arity |
outputSize | result size |
name | function's name |
|
protectedvirtual |
Hessian evaluation.
Compute the hessian, has to be implemented in concrete classes. The hessian is computed for a specific sub-function which id is passed through the functionId argument.
hessian | hessian will be stored here |
argument | point where the hessian will be computed |
functionId | evaluated function id in the split representation |
Implements roboptim::GenericTwiceDifferentiableFunction< T >.
|
virtual |
Display the function on the specified output stream.
o | output stream used for display |
Reimplemented from roboptim::GenericQuadraticFunction< T >.
Reimplemented in roboptim::GenericNumericLinearFunction< T >, roboptim::IdentityFunction, and roboptim::ConstantFunction.