SinFunction Class Reference

SinFunction. More...

Inheritance diagram for SinFunction:

Inheritance graph
[legend]
Collaboration diagram for SinFunction:

Collaboration graph
[legend]
List of all members.

Constructors

 SinFunction (Real phase=0.0, Real span=1.0, Real amplitude=1.0)
 SinFunction (PropertySettings &prop)
virtual ~SinFunction ()

Interface

Real frequency ()
virtual void apply (RealVec &inputs, RealVec &outputs)
virtual SinFunctionclone () const

Detailed Description

Properties
Name Type [isVector] Access mode Description Class
typename string read-only Class's type Propertized
phase Real read/write X offset of the centre PeriodicFunction
span Real read/write distance between peaks; see frequency PeriodicFunction
amplitude Real read/write nonnegative value of the wave's magnitude PeriodicFunction


Constructor & Destructor Documentation

SinFunction ( Real  phase = 0.0,
Real  span = 1.0,
Real  amplitude = 1.0 
)

Construct

SinFunction ( PropertySettings prop  ) 

Construct

virtual ~SinFunction (  )  [inline, virtual]

Destructor


Member Function Documentation

Real frequency (  ) 

Return the frequency of the sinusoidal wave

Parameters:
frequency is equal to 2*pi_greco/span

virtual void apply ( RealVec inputs,
RealVec outputs 
) [virtual]

Implement the Sin function

Implements PeriodicFunction.

virtual SinFunction* clone (  )  const [virtual]

Clone this object

Implements PeriodicFunction.


The documentation for this class was generated from the following file:
BerliOS Developer Logo Valid XHTML 1.0 Transitional Valid CSS!