PeriodicFunction Class Reference

PeriodicFunction. More...

Inheritance diagram for PeriodicFunction:

List of all members.

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

---

Detailed Description

PeriodicFunction.

Definition at line 37 of file libperiodicfunctions.h.

---

Constructor & Destructor Documentation

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

Construct.

Definition at line 25 of file libperiodicfunctions.cpp.

virtual ~PeriodicFunction

(

)

[inline, virtual]

Destructor.

Definition at line 42 of file libperiodicfunctions.h.

---

Member Function Documentation

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

Implement the Periodic function.

Implements OutputFunction.

Implemented in SawtoothFunction, TriangleFunction, SinFunction, and PseudoGaussFunction.

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

Configures the object using a ConfigurationParameters object.

This sets parameters for the base class, remember to call it in the configure function of child classes.

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

Implements ParameterSettableWithConfigureFunction.

Reimplemented in SawtoothFunction, TriangleFunction, SinFunction, and PseudoGaussFunction.

Definition at line 32 of file libperiodicfunctions.cpp.

References ConfigurationParameters::getValue().

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

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

This saves parameters for the base class, remember to call it in the configure function of child classes

Parameters:

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

Implements ParameterSettable.

Reimplemented in SawtoothFunction, TriangleFunction, SinFunction, and PseudoGaussFunction.

Definition at line 65 of file libperiodicfunctions.cpp.

References ConfigurationParameters::createParameter(), and ConfigurationParameters::startObjectParameters().

---

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

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