PeriodicFunction Class Reference

PeriodicFunction. More...

Inheritance diagram for PeriodicFunction:

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 Member Functions inherited from OutputFunction
	OutputFunction ()
	Constructor.
virtual	~OutputFunction ()
	Destructor.
double	apply (double input)
	Calculate the outputs of a single neuron.
virtual bool	derivate (const DoubleVector &inputs, const DoubleVector &outputs, DoubleVector &derivates) const
	Compute the derivate of the function represent Given the input of neurons and the corresponding output of neurons, it calculate the derivate.
void	setCluster (Cluster *cl)
	Set the Cluster which it is inserted This is automatically called, and in normal case you don't have to call it directly.
Public Member Functions inherited from ParameterSettableWithConfigureFunction
void	addObserver (RuntimeParameterObserver *obs)
T	getRuntimeParameter (QString paramName)
virtual ParameterSettableUI *	getUIManager ()
	ParameterSettable ()
virtual void	postConfigureInitialization ()
void	removeObserver (RuntimeParameterObserver *obs)
void	setRuntimeParameter (QString paramName, T newvalue)
QString	typeName () const
Public Member Functions inherited from ParameterSettable
void	addObserver (RuntimeParameterObserver *obs)
T	getRuntimeParameter (QString paramName)
void	removeObserver (RuntimeParameterObserver *obs)
void	setRuntimeParameter (QString paramName, T newvalue)
QString	typeName () const

Public Attributes
double	amplitude
double	phase
double	span

Additional Inherited Members
Public Types inherited from ParameterSettableWithConfigureFunction
enum	Property
Static Public Member Functions inherited from ParameterSettableWithConfigureFunction
static void	describe (QString type)
static QString	fullParameterDescriptionPath (QString type, QString param)
static QString	fullSubgroupDescriptionPath (QString type, QString sub)
Static Public Attributes inherited from ParameterSettableWithConfigureFunction
static const double	Infinity
static const int	MaxInteger
static const int	MinInteger
Protected Member Functions inherited from OutputFunction
virtual void	clusterSetted ()
	The method setCluster will call clusterSetted to inform subclasses that the OutputFunction has been inserted into a Cluster.
Static Protected Member Functions inherited from ParameterSettableWithConfigureFunction
static Descriptor	addTypeDescription (QString type, QString shortHelp, QString longHelp=QString(""))
static void	setGraphicalEditor (QString type)
Protected Attributes inherited from OutputFunction
Cluster *	clusterv
	Cluster on which the OutputFunction is inserted.

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 ( )

inlinevirtual

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 PseudoGaussFunction, SinFunction, TriangleFunction, and SawtoothFunction.

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 PseudoGaussFunction, SinFunction, TriangleFunction, and SawtoothFunction.

Definition at line 32 of file libperiodicfunctions.cpp.

References ConfigurationParameters::getValue().

Referenced by SawtoothFunction::configure(), TriangleFunction::configure(), SinFunction::configure(), and PseudoGaussFunction::configure().

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 ParameterSettableWithConfigureFunction.

Reimplemented in PseudoGaussFunction, SinFunction, TriangleFunction, and SawtoothFunction.

Definition at line 65 of file libperiodicfunctions.cpp.

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

Referenced by SawtoothFunction::save(), TriangleFunction::save(), SinFunction::save(), and PseudoGaussFunction::save().

---

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

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