Simbody
3.6
|
This is a Function_ subclass whose output value is a sinusoid of its argument: f(x) = a*sin(w*x + p) where a is amplitude, w is frequency in radians per unit of x, p is phase in radians. More...
Public Member Functions | |
Sinusoid (Real amplitude, Real frequency, Real phase=0) | |
Create a Function::Sinusoid object, returning a*sin(w*x+p). More... | |
void | setAmplitude (Real amplitude) |
void | setFrequency (Real frequency) |
void | setPhase (Real phase) |
Real | getAmplitude () const |
Real | getFrequency () const |
Real | getPhase () const |
virtual Real | calcValue (const Vector &x) const override |
Calculate the value of this function at a particular point. More... | |
virtual Real | calcDerivative (const Array_< int > &derivComponents, const Vector &x) const override |
Calculate a partial derivative of this function at a particular point. More... | |
int | getArgumentSize () const override |
Get the number of components expected in the input vector. More... | |
int | getMaxDerivativeOrder () const override |
Get the maximum derivative order this Function_ object can calculate. More... | |
Sinusoid * | clone () const override |
Create a new heap-allocated copy of this concrete Function. More... | |
Real | calcDerivative (const std::vector< int > &derivComponents, const Vector &x) const |
This provides compatibility with std::vector without requiring any copying. More... | |
Public Member Functions inherited from SimTK::Function_< Real > | |
virtual | ~Function_ () |
Real | calcDerivative (const std::vector< int > &derivComponents, const Vector &x) const |
This provides compatibility with std::vector without requiring any copying. More... | |
This is a Function_ subclass whose output value is a sinusoid of its argument: f(x) = a*sin(w*x + p) where a is amplitude, w is frequency in radians per unit of x, p is phase in radians.
This is only defined for a scalar (Real) return value.
|
inline |
Create a Function::Sinusoid object, returning a*sin(w*x+p).
[in] | amplitude | 'a' in the above formula |
[in] | frequency | 'w' in the above formula |
[in] | phase | 'p' in the above formula (default is zero) |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inlineoverridevirtual |
Calculate the value of this function at a particular point.
x | the Vector of input arguments. Its size must equal the value returned by getArgumentSize(). |
Implements SimTK::Function_< Real >.
|
inlineoverridevirtual |
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.
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 SimTK::Function_< Real >.
|
inlineoverridevirtual |
Get the number of components expected in the input vector.
Implements SimTK::Function_< Real >.
|
inlineoverridevirtual |
Get the maximum derivative order this Function_ object can calculate.
Implements SimTK::Function_< Real >.
|
inlineoverridevirtual |
Create a new heap-allocated copy of this concrete Function.
For backwards compatibility this is not pure virtual; it has a default implementation that throws an exception if called. However, it should always be implemented.
Reimplemented from SimTK::Function_< Real >.
|
inline |
This provides compatibility with std::vector without requiring any copying.