Constant Class Reference

This is a Function_ subclass which simply returns a fixed value, independent of its arguments. More...

#include <Function.h>

Inheritance diagram for Constant:
Function_< T >

List of all members.

Public Member Functions

 Constant (T value, int argumentSize)
 Create a Function_::Constant object.
calcValue (const Vector &x) const
 Calculate the value of this function at a particular point.
calcDerivative (const std::vector< int > &derivComponents, const 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.
int getMaxDerivativeOrder () const
 Get the maximum derivative order this Function_ object can calculate.

Detailed Description

template<class T>
class SimTK::Function_< T >::Constant

This is a Function_ subclass which simply returns a fixed value, independent of its arguments.


Constructor & Destructor Documentation

Constant ( value,
int  argumentSize 
) [inline]

Create a Function_::Constant object.

Parameters:
value the value which should be returned by calcValue();
argumentSize the value which should be returned by getArgumentSize();

Member Function Documentation

T calcDerivative ( const std::vector< int > &  derivComponents,
const 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().

Implements Function_< T >.

T calcValue ( const 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().

Implements Function_< T >.

References VectorBase< ELT >::size().

virtual int getArgumentSize (  )  const [inline, virtual]

Get the number of components expected in the input vector.

Implements Function_< T >.

int getMaxDerivativeOrder (  )  const [inline, virtual]

Get the maximum derivative order this Function_ object can calculate.

Implements Function_< T >.

References SimTK::max().


The documentation for this class was generated from the following file:

Generated by  doxygen 1.6.2