SinusoidFunction Class Reference

#include <RiboseMobilizer.h>

Inheritance diagram for SinusoidFunction:

List of all members.

---

Detailed Description

Implements a simple functional relationship, y = amplitude * sin(x - phase).

Public Member Functions
	SinusoidFunction ()
	SinusoidFunction (Angle amp, Angle phi)
Vec< 1 >	calcValue (const Vector &x) const
	Calculate the value of this function at a particular point.
Vec< 1 >	calcDerivative (const std::vector< int > &derivComponents, const Vector &x) const
	Calculate a partial derivative of this function at a particular point.
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.

---

Constructor & Destructor Documentation

SinusoidFunction

(

)

[inline]

SinusoidFunction	(	Angle	amp,
		Angle	phi
	)			[inline]

---

Member Function Documentation

Vec<1> 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< 1 >.

Vec<1> 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< 1 >.

References VectorBase::size().

int getArgumentSize

(

)

const [inline, virtual]

Get the number of components expected in the input vector.

Implements Function< 1 >.

int getMaxDerivativeOrder

(

)

const [inline, virtual]

Get the maximum derivative order this Function object can calculate.

Implements Function< 1 >.

---

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

• RiboseMobilizer.h