GainFunction Class Reference

GainFunction. More...

Inheritance diagram for GainFunction:

Public Member Functions
	GainFunction (double gain=1.0)
	Construct.
virtual	~GainFunction ()
	Destructor.
virtual void	apply (DoubleVector &inputs, DoubleVector &outputs)
	Implement the Gain function.
virtual void	configure (ConfigurationParameters &params, QString prefix)
	Configures the object using a ConfigurationParameters object.
virtual bool	derivate (const DoubleVector &x, const DoubleVector &y, DoubleVector &d) const
	return always 1 (an explain of why will be coming soon)
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.
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	gainv

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

GainFunction.

GainFunction add a constan value to inputs

Definition at line 111 of file liboutputfunctions.h.

Constructor & Destructor Documentation

GainFunction

(

double

gain = 1.0

)

Construct.

Definition at line 87 of file liboutputfunctions.cpp.

virtual ~GainFunction ( )

inlinevirtual

Destructor.

Definition at line 116 of file liboutputfunctions.h.

Member Function Documentation

void apply ( DoubleVector &  inputs, DoubleVector &  outputs  )

virtual

Implement the Gain function.

Implements OutputFunction.

Definition at line 92 of file liboutputfunctions.cpp.

References DoubleVector::copyValues().

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

Implements ParameterSettableWithConfigureFunction.

Definition at line 102 of file liboutputfunctions.cpp.

References ConfigurationParameters::getValue().

bool derivate ( const DoubleVector &  x, const DoubleVector &  y, DoubleVector &  d  ) const

virtual

return always 1 (an explain of why will be coming soon)

Reimplemented from OutputFunction.

Definition at line 97 of file liboutputfunctions.cpp.

References DoubleVector::setAll().

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.

Implements ParameterSettableWithConfigureFunction.

Definition at line 115 of file liboutputfunctions.cpp.

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

---

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

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