MathUtils::Sine Class Reference

Sine function functor: f(x) = a * sin(b*x + c) + d. More...

#include <MathUtils_FunctorScalar.hxx>

Public Member Functions
	Sine (double theAmplitude=1.0, double theFrequency=1.0, double thePhase=0.0, double theOffset=0.0)
	Constructor with full parameters.
bool	Value (double theX, double &theY) const
	Evaluates sine function.
bool	Values (double theX, double &theY, double &theDY) const
	Evaluates sine function and derivative.

Detailed Description

Sine function functor: f(x) = a * sin(b*x + c) + d.

Constructor & Destructor Documentation

Sine()

MathUtils::Sine::Sine ( double theAmplitude = 1.0, double theFrequency = 1.0, double thePhase = 0.0, double theOffset = 0.0 )

inline

Constructor with full parameters.

Parameters

theAmplitude	amplitude a
theFrequency	angular frequency b
thePhase	phase shift c
theOffset	vertical offset d

Member Function Documentation

Value()

bool MathUtils::Sine::Value ( double theX, double & theY ) const

inline

Evaluates sine function.

Parameters

[in]	theX	input value
[out]	theY	function value

Returns

true (always succeeds)

Values()

bool MathUtils::Sine::Values ( double theX, double & theY, double & theDY ) const

inline

Evaluates sine function and derivative.

Parameters

[in]	theX	input value
[out]	theY	function value
[out]	theDY	derivative value

Returns

true (always succeeds)

---

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

• MathUtils_FunctorScalar.hxx