Explicit specialization for the stop case of NTimesDerivable class. More...
#include <roboptim/core/n-times-derivable-function.hh>
Public Member Functions | |
virtual size_type | derivabilityOrderMax () const |
Returns the maximum derivability order (relevant for N>2 only) More... | |
virtual | ~NTimesDerivableFunction () throw () |
size_type | derivativeSize () const throw () |
Return the size of the derivative vector. More... | |
bool | isValidDerivative (const gradient_t &derivative) const throw () |
Check if a derivative is valid (check sizes). More... | |
result_t | operator() (double argument) const throw () |
Evaluate the function at a specified point. More... | |
void | operator() (result_t &result, double argument) const throw () |
Evaluate the function at a specified point. More... | |
gradient_t | derivative (double argument, size_type order=1) const throw () |
Compute the derivative of the function. More... | |
void | derivative (gradient_t &derivative, double argument, size_type order=1) const throw () |
Compute the derivative of the function. More... | |
virtual std::ostream & | print (std::ostream &o) const throw () |
Display the function on the specified output stream. 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... | |
Static Public Attributes | |
static const size_type | derivabilityOrder = 2 |
Function derivability order. More... | |
Protected Member Functions | |
NTimesDerivableFunction (size_type outputSize=1, std::string name=std::string()) throw () | |
Concrete class constructor should call this constructor. More... | |
void | impl_compute (result_t &result, const argument_t &argument) const throw () |
Function evaluation. More... | |
virtual void | impl_compute (result_t &result, double t) const =0 throw () |
Function evaluation. More... | |
void | impl_gradient (gradient_t &gradient, const argument_t &argument, size_type functionId=0) const throw () |
Gradient evaluation. More... | |
virtual void | impl_derivative (gradient_t &derivative, double argument, size_type order=1) const =0 throw () |
Derivative evaluation. More... | |
void | impl_hessian (hessian_t &hessian, const argument_t &argument, size_type functionId=0) const throw () |
Hessian evaluation. More... | |
![]() | |
GenericTwiceDifferentiableFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw () | |
Concrete class constructor should call this constructor. More... | |
void | setZero (hessian_t &symmetric) const |
Set a symmetric matrix to zero. More... | |
![]() | |
GenericDifferentiableFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw () | |
Concrete class constructor should call this constructor. More... | |
virtual void | impl_jacobian (jacobian_t &jacobian, const argument_t &arg) const throw () |
Jacobian evaluation. More... | |
template<> | |
void | impl_jacobian (jacobian_t &jacobian, const argument_t &argument) const throw() |
![]() | |
GenericFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw () | |
Concrete class constructor should call this constructor. More... | |
Additional Inherited Members | |
![]() | |
typedef matrix_t | hessian_t |
Hessian type. More... | |
typedef std::pair< size_type, size_type > | hessianSize_t |
Hessian size type represented as a pair of values. More... | |
![]() | |
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... | |
Explicit specialization for the stop case of NTimesDerivable class.
This specialization defines the interface of a ``n times derivable function'' and implements generic methods required by upper classes using this class specific interface.
|
inlinevirtual |
|
inlineprotected |
Concrete class constructor should call this constructor.
outputSize | output size (result size) |
name | function's name |
|
inlinevirtual |
Returns the maximum derivability order (relevant for N>2 only)
|
inline |
Compute the derivative of the function.
Derivative is computed for a certain order, at a given point.
argument | point at which the derivative will be computed |
order | derivative order (if 0 then function is evaluated) |
|
inline |
Compute the derivative of the function.
Derivative is computed for a certain order, at a given point.
derivative | derivative will be stored in this vector |
argument | point at which the derivative will be computed |
order | derivative order (if 0 then function is evaluated) |
References roboptim::NTimesDerivableFunction< DerivabilityOrder >::derivabilityOrderMax().
|
inline |
Return the size of the derivative vector.
|
inlineprotectedvirtual |
Function evaluation.
Implement generic function evaluation, as required by Function, using this class evaluation method (using a double instead of a vector).
result | result will be stored in this vector |
argument | point at which the function will be evaluated |
Implements roboptim::GenericFunction< T >.
|
protectedpure virtual |
Function evaluation.
Evaluate the function, has to be implemented in concrete classes.
result | result will be stored in this vector |
t | point at which the function will be evaluated |
|
protectedpure virtual |
Derivative evaluation.
Compute the derivative, has to be implemented in concrete classes.
derivative | derivative will be store in this argument |
argument | point where the gradient will be computed |
order | derivative order (if 0 evaluates the function) |
|
inlineprotectedvirtual |
Gradient evaluation.
Implement the gradient computation, as required by DerivableFunction. The gradient is computed for a specific sub-function which id is passed through the functionId argument.
gradient | gradient will be store in this argument |
argument | point where the gradient will be computed |
functionId | evaluated function id in the split representation |
ROBOPTIM_DO_NOT_CHECK_ALLOCATION
Implements roboptim::GenericDifferentiableFunction< T >.
|
inlineprotectedvirtual |
Hessian evaluation.
Implement the hessian computation, as required by the TwiceDerivableFunction class using the derivative method. 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 >.
|
inline |
Check if a derivative is valid (check sizes).
derivative | derivative vector to be checked |
|
inline |
Evaluate the function at a specified point.
The program will abort if the argument does not have the expected size.
argument | point at which the function will be evaluated |
|
inline |
Evaluate the function at a specified point.
The program will abort if the argument does not have the expected size.
result | result will be stored in this vector |
argument | point at which the function will be evaluated |
|
inlinevirtual |
Display the function on the specified output stream.
o | output stream used for display |
Reimplemented from roboptim::GenericTwiceDifferentiableFunction< T >.
References roboptim::NTimesDerivableFunction< DerivabilityOrder >::derivabilityOrderMax().
|
static |
Function derivability order.
One static const variable per class in inheritance structure.