Differentiable function.
More...
#include <hpp/constraints/differentiable-function.hh>
List of all members.
Detailed Description
Constructor & Destructor Documentation
virtual hpp::constraints::DifferentiableFunction::~DifferentiableFunction |
( |
| ) |
[inline, virtual] |
hpp::constraints::DifferentiableFunction::DifferentiableFunction |
( |
size_type |
inputSize, |
|
|
size_type |
inputDerivativeSize, |
|
|
size_type |
outputSize, |
|
|
std::string |
name = std::string () |
|
) |
| [inline, protected] |
Concrete class constructor should call this constructor.
- Parameters:
-
inputSize | function arity |
outputSize | result size |
name | function's name |
Member Function Documentation
virtual void hpp::constraints::DifferentiableFunction::impl_compute |
( |
vectorOut_t |
result, |
|
|
vectorIn_t |
argument |
|
) |
| const [protected, pure virtual] |
User implementation of function evaluation.
virtual void hpp::constraints::DifferentiableFunction::impl_jacobian |
( |
matrixOut_t |
jacobian, |
|
|
vectorIn_t |
arg |
|
) |
| const [protected, pure virtual] |
size_type hpp::constraints::DifferentiableFunction::inputDerivativeSize |
( |
| ) |
const [inline] |
Get dimension of input derivative vector.
The dimension of configuration vectors might differ from the dimension of velocity vectors since some joints are represented by non minimal size vectors: e.g. quaternion for SO(3)
size_type hpp::constraints::DifferentiableFunction::inputSize |
( |
| ) |
const [inline] |
Get dimension of input vector.
void hpp::constraints::DifferentiableFunction::jacobian |
( |
matrixOut_t |
jacobian, |
|
|
vectorIn_t |
argument |
|
) |
| const [inline] |
Computes the jacobian.
- Return values:
-
jacobian | jacobian will be stored in this argument |
- Parameters:
-
argument | point at which the jacobian will be computed |
const std::string& hpp::constraints::DifferentiableFunction::name |
( |
| ) |
const [inline] |
Get function name.
- Returns:
- Function name.
void hpp::constraints::DifferentiableFunction::operator() |
( |
vectorOut_t |
result, |
|
|
vectorIn_t |
argument |
|
) |
| const [inline] |
Evaluate the function at a given parameter.
- Note:
- parameters should be of the correct size.
size_type hpp::constraints::DifferentiableFunction::outputSize |
( |
| ) |
const [inline] |
Get dimension of output vector.
virtual std::ostream& hpp::constraints::DifferentiableFunction::print |
( |
std::ostream & |
o | ) |
const [inline, virtual] |