MultidimensionalFunction Class Reference
Public Member Functions | |
| MultidimensionalFunction () | |
| virtual | ~MultidimensionalFunction () |
| virtual Object * | copy () const |
| Construct and return a copy of this object. | |
| virtual double | calcValue (const SimTK::Vector &x) const |
| Calculate the value of this function at a particular point. | |
| virtual double | calcDerivative (const std::vector< int > &derivComponents, const SimTK::Vector &x) const |
| Calculate a partial derivative of this function at a particular point. | |
| virtual int | getArgumentSize () const |
| Get the number of components expected in the input vector. | |
| virtual int | getMaxDerivativeOrder () const |
| Get the maximum derivative order this Function object can calculate. | |
| virtual SimTK::Function * | createSimTKFunction () const |
| MultidimensionalFunction () | |
| virtual | ~MultidimensionalFunction () |
| virtual Object * | copy () const |
| Construct and return a copy of this object. | |
| virtual double | calcValue (const SimTK::Vector &x) const |
| Calculate the value of this function at a particular point. | |
| virtual double | calcDerivative (const std::vector< int > &derivComponents, const SimTK::Vector &x) const |
| Calculate a partial derivative of this function at a particular point. | |
| virtual int | getArgumentSize () const |
| Get the number of components expected in the input vector. | |
| virtual int | getMaxDerivativeOrder () const |
| Get the maximum derivative order this Function object can calculate. | |
| virtual SimTK::Function * | createSimTKFunction () const |
Constructor & Destructor Documentation
| MultidimensionalFunction::MultidimensionalFunction | ( | ) | [inline] |
| virtual MultidimensionalFunction::~MultidimensionalFunction | ( | ) | [inline, virtual] |
| MultidimensionalFunction::MultidimensionalFunction | ( | ) | [inline] |
| virtual MultidimensionalFunction::~MultidimensionalFunction | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual double MultidimensionalFunction::calcDerivative | ( | const std::vector< int > & | derivComponents, | |
| const SimTK::Vector & | x | |||
| ) | const [inline, virtual] |
Calculate a partial derivative of this function at a particular point.
Which derivative to take is specified by listing the input components with which to take it. For example, if derivComponents=={0}, that indicates a first derivative with respective to component 0. If derivComponents=={0, 0, 0}, that indicates a third derivative with respective to component 0. If derivComponents=={4, 7}, that indicates a partial second derivative with respect to components 4 and 7.
- Parameters:
-
derivComponents the input components with respect to which the derivative should be taken. Its size must be less than or equal to the value returned by getMaxDerivativeOrder(). x the Vector of input arguments. Its size must equal the value returned by getArgumentSize().
Reimplemented from OpenSim::Function.
| virtual double MultidimensionalFunction::calcDerivative | ( | const std::vector< int > & | derivComponents, | |
| const SimTK::Vector & | x | |||
| ) | const [inline, virtual] |
Calculate a partial derivative of this function at a particular point.
Which derivative to take is specified by listing the input components with which to take it. For example, if derivComponents=={0}, that indicates a first derivative with respective to component 0. If derivComponents=={0, 0, 0}, that indicates a third derivative with respective to component 0. If derivComponents=={4, 7}, that indicates a partial second derivative with respect to components 4 and 7.
- Parameters:
-
derivComponents the input components with respect to which the derivative should be taken. Its size must be less than or equal to the value returned by getMaxDerivativeOrder(). x the Vector of input arguments. Its size must equal the value returned by getArgumentSize().
Reimplemented from OpenSim::Function.
| virtual double MultidimensionalFunction::calcValue | ( | const SimTK::Vector & | x | ) | const [inline, virtual] |
Calculate the value of this function at a particular point.
- Parameters:
-
x the Vector of input arguments. Its size must equal the value returned by getArgumentSize().
Reimplemented from OpenSim::Function.
| virtual double MultidimensionalFunction::calcValue | ( | const SimTK::Vector & | x | ) | const [inline, virtual] |
Calculate the value of this function at a particular point.
- Parameters:
-
x the Vector of input arguments. Its size must equal the value returned by getArgumentSize().
Reimplemented from OpenSim::Function.
| virtual Object* MultidimensionalFunction::copy | ( | ) | const [inline, virtual] |
Construct and return a copy of this object.
The object is allocated using the new operator, so the caller is responsible for deleting the returned object.
- Returns:
- Copy of this object.
Implements OpenSim::Function.
| virtual Object* MultidimensionalFunction::copy | ( | ) | const [inline, virtual] |
Construct and return a copy of this object.
The object is allocated using the new operator, so the caller is responsible for deleting the returned object.
- Returns:
- Copy of this object.
Implements OpenSim::Function.
| virtual SimTK::Function* MultidimensionalFunction::createSimTKFunction | ( | ) | const [inline, virtual] |
Implements OpenSim::Function.
| virtual SimTK::Function* MultidimensionalFunction::createSimTKFunction | ( | ) | const [inline, virtual] |
Implements OpenSim::Function.
| virtual int MultidimensionalFunction::getArgumentSize | ( | ) | const [inline, virtual] |
Get the number of components expected in the input vector.
Reimplemented from OpenSim::Function.
| virtual int MultidimensionalFunction::getArgumentSize | ( | ) | const [inline, virtual] |
Get the number of components expected in the input vector.
Reimplemented from OpenSim::Function.
| virtual int MultidimensionalFunction::getMaxDerivativeOrder | ( | ) | const [inline, virtual] |
Get the maximum derivative order this Function object can calculate.
Reimplemented from OpenSim::Function.
| virtual int MultidimensionalFunction::getMaxDerivativeOrder | ( | ) | const [inline, virtual] |
Get the maximum derivative order this Function object can calculate.
Reimplemented from OpenSim::Function.
The documentation for this class was generated from the following files:
- OpenSim/Simulation/SimbodyEngine/Test/testConstraints.cpp
- OpenSim/Simulation/SimbodyEngine/Test/testJoints.cpp
