roboptim::LinearFunction Class Reference

Define an abstract linear function. More...

#include <roboptim/core/linear-function.hh>

+ Inheritance diagram for roboptim::LinearFunction:

List of all members.

Public Member Functions

 LinearFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw ()
 Concrete class constructor should call this constructor.
virtual std::ostream & print (std::ostream &) const throw ()
 Display the function on the specified output stream.
- Public Member Functions inherited from roboptim::QuadraticFunction
 QuadraticFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw ()
 Concrete class constructor should call this constructor.
- Public Member Functions inherited from roboptim::TwiceDerivableFunction
hessianSize_t hessianSize () const throw ()
 Return the size of a hessian.
bool isValidHessian (const hessian_t &hessian) const throw ()
 Check if the hessian is valid (check sizes).
hessian_t hessian (const argument_t &argument, size_type functionId=0) const throw ()
 Compute the hessian at a given point.
void hessian (hessian_t &hessian, const argument_t &argument, size_type functionId=0) const throw ()
 Compute the hessian at a given point.
- Public Member Functions inherited from roboptim::DerivableFunction
size_type gradientSize () const throw ()
 Return the gradient size.
jacobianSize_t jacobianSize () const throw ()
 Return the jacobian size as a pair.
bool isValidGradient (const gradient_t &gradient) const throw ()
 Check if the gradient is valid (check size).
bool isValidJacobian (const jacobian_t &jacobian) const throw ()
 Check if the jacobian is valid (check sizes).
jacobian_t jacobian (const argument_t &argument) const throw ()
 Computes the jacobian.
void jacobian (jacobian_t &jacobian, const argument_t &argument) const throw ()
 Computes the jacobian.
gradient_t gradient (const argument_t &argument, size_type functionId=0) const throw ()
 Computes the gradient.
void gradient (gradient_t &gradient, const argument_t &argument, size_type functionId=0) const throw ()
 Computes the gradient.
- Public Member Functions inherited from roboptim::Function
bool isValidResult (const result_t &result) const throw ()
 Check the given result size is valid.
size_type inputSize () const throw ()
 Return the input size (i.e. argument's vector size).
size_type outputSize () const throw ()
 Return the output size (i.e. result's vector size).
virtual ~Function () throw ()
 Trivial destructor.
result_t operator() (const argument_t &argument) const throw ()
 Evaluate the function at a specified point.
void operator() (result_t &result, const argument_t &argument) const throw ()
 Evaluate the function at a specified point.
const std::string & getName () const throw ()
 Get function name.

Protected Member Functions

void impl_hessian (hessian_t &hessian, const argument_t &argument, size_type functionId=0) const throw ()
 Hessian evaluation.

Detailed Description

Define an abstract linear function.

Inherit from this class when implementing linear functions.


Constructor & Destructor Documentation

roboptim::LinearFunction::LinearFunction ( size_type  inputSize,
size_type  outputSize = 1,
std::string  name = std::string () 
) throw ()

Concrete class constructor should call this constructor.

Parameters:
inputSizefunction arity
outputSizeresult size
namefunction's name

Member Function Documentation

void roboptim::LinearFunction::impl_hessian ( hessian_t hessian,
const argument_t argument,
size_type  functionId = 0 
) const throw ()
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.

Warning:
Do not call this function directly, call hessian instead.
Parameters:
hessianhessian will be stored here
argumentpoint where the hessian will be computed
functionIdevaluated function id in the split representation

Implements roboptim::TwiceDerivableFunction.

std::ostream & roboptim::LinearFunction::print ( std::ostream &  o) const throw ()
virtual

Display the function on the specified output stream.

Parameters:
ooutput stream used for display
Returns:
output stream

Reimplemented from roboptim::QuadraticFunction.

Reimplemented in roboptim::NumericLinearFunction, roboptim::ConstantFunction, and roboptim::IdentityFunction.