SinFunction Class Reference

SinFunction. More...

Inheritance diagram for SinFunction:

List of all members.

Public Member Functions
	SinFunction (double phase=0.0, double span=1.0, double amplitude=1.0)
	Construct.
virtual	~SinFunction ()
	Destructor.
virtual void	apply (DoubleVector &inputs, DoubleVector &outputs)
	Implement the Sin function.
virtual void	configure (ConfigurationParameters &params, QString prefix)
	Configures the object using a ConfigurationParameters object.
double	frequency ()
	Return the frequency of the sinusoidal wave.
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed.

---

Detailed Description

SinFunction.

Definition at line 140 of file libperiodicfunctions.h.

---

Constructor & Destructor Documentation

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

Construct.

Definition at line 126 of file libperiodicfunctions.cpp.

virtual ~SinFunction

(

)

[inline, virtual]

Destructor.

Definition at line 145 of file libperiodicfunctions.h.

---

Member Function Documentation

void apply	(	DoubleVector &	inputs,
		DoubleVector &	outputs
	)		[virtual]

Implement the Sin function.

Implements PeriodicFunction.

Definition at line 134 of file libperiodicfunctions.cpp.

References DoubleVector::size().

void configure	(	ConfigurationParameters &	params,
		QString	prefix
	)		[virtual]

Configures the object using a ConfigurationParameters object.

Parameters:

params	the configuration parameters object with parameters to use
prefix	the prefix to use to access the object configuration parameters. This is guaranteed to end with the separator character when called by the factory, so you don't need to add one

Reimplemented from PeriodicFunction.

Definition at line 140 of file libperiodicfunctions.cpp.

double frequency

(

)

Return the frequency of the sinusoidal wave.

Parameters:

frequency

is equal to 2*pi_greco/span

Definition at line 130 of file libperiodicfunctions.cpp.

void save	(	ConfigurationParameters &	params,
		QString	prefix
	)		[virtual]

Save the actual status of parameters into the ConfigurationParameters object passed.

Parameters:

params	the configuration parameters object on which save actual parameters
prefix	the prefix to use to access the object configuration parameters.

Reimplemented from PeriodicFunction.

Definition at line 146 of file libperiodicfunctions.cpp.

References ConfigurationParameters::startObjectParameters().

---

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

• nnfw/include/libperiodicfunctions.h
• nnfw/src/libperiodicfunctions.cpp