ScaleFunction Class Reference

ScaleFunction. More...

Inheritance diagram for ScaleFunction:

Public Member Functions
	ScaleFunction (double rate=1.0)
	Construct. More...
virtual	~ScaleFunction ()
	Destructor. More...
virtual void	apply (DoubleVector &inputs, DoubleVector &outputs)
	Implement the identity function. More...
virtual void	configure (ConfigurationParameters &params, QString prefix)
	Configures the object using a ConfigurationParameters object. More...
virtual bool	derivate (const DoubleVector &x, const DoubleVector &y, DoubleVector &d) const
	return always the rate (an explain of why will be coming soon) More...
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed. More...
Public Member Functions inherited from OutputFunction
	OutputFunction ()
	Constructor. More...
virtual	~OutputFunction ()
	Destructor. More...
double	apply (double input)
	Calculate the outputs of a single neuron. More...
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. More...
Public Member Functions inherited from ParameterSettable
void	addObserver (RuntimeParameterObserver *obs)
T	getRuntimeParameter (QString paramName)
virtual ParameterSettableUI *	getUIManager ()
virtual void	postConfigureInitialization ()
void	removeObserver (RuntimeParameterObserver *obs)
void	setRuntimeParameter (QString paramName, T newvalue)
QString	typeName () const

Public Attributes
double	rate
Public Attributes inherited from ParameterSettable
	AllowMultiple
	Default
	IsList
	IsMandatory

Additional Inherited Members
Public Types inherited from ParameterSettable
enum	Property
Static Public Member Functions inherited from ParameterSettable
static void	describe (QString type)
static QString	fullParameterDescriptionPath (QString type, QString param)
static QString	fullSubgroupDescriptionPath (QString type, QString sub)
Static Public Attributes inherited from ParameterSettable
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. More...
Protected Member Functions inherited from ParameterSettable
void	notifyChangesToParam (QString paramName)
Static Protected Member Functions inherited from ParameterSettable
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. More...

Detailed Description

ScaleFunction.

ScaleFunction scales the inputs vector to the outputs

Definition at line 75 of file liboutputfunctions.h.

Constructor & Destructor Documentation

ScaleFunction

(

double

rate = 1.0

)

Construct.

Definition at line 56 of file liboutputfunctions.cpp.

virtual ~ScaleFunction ( )

inlinevirtual

Destructor.

Definition at line 80 of file liboutputfunctions.h.

Member Function Documentation

void apply ( DoubleVector &  inputs, DoubleVector &  outputs  )

virtual

Implement the identity function.

Implements OutputFunction.

Definition at line 61 of file liboutputfunctions.cpp.

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 70 of file liboutputfunctions.cpp.

References ConfigurationParameters::getValue().

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

virtual

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

Reimplemented from OutputFunction.

Definition at line 65 of file liboutputfunctions.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.

Implements ParameterSettable.

Definition at line 83 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