ScaledSigmoidFunction Class Reference

ScaledSigmoid Function. More...

Inheritance diagram for ScaledSigmoidFunction:

Public Member Functions
	ScaledSigmoidFunction (double l=1.0, double min=-1.0, double max=+1.0)
	Construct a scaled sigmoid updater with parameter l. More...
virtual	~ScaledSigmoidFunction ()
	Destructor. More...
virtual void	apply (DoubleVector &inputs, DoubleVector &outputs)
	Implement the updating method. 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 the approximation commonly used in backpropagation learning: x(1-x) 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	lambda
	lambda is the slope of the curve More...
double	max
	max is the y value when x -> +infinite More...
double	min
	min is the y value when x -> -infinite More...
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

ScaledSigmoid Function.

lambda is the slope of the curve
min is the y value when x -> -infinite
max is the y value when x -> +infinite
(max-min) is the y value when x == 0

Definition at line 224 of file liboutputfunctions.h.

Constructor & Destructor Documentation

ScaledSigmoidFunction	(	double	l = 1.0,
		double	min = -1.0,
		double	max = +1.0
	)

Construct a scaled sigmoid updater with parameter l.

Definition at line 216 of file liboutputfunctions.cpp.

References ScaledSigmoidFunction::lambda, ScaledSigmoidFunction::max, and ScaledSigmoidFunction::min.

virtual ~ScaledSigmoidFunction ( )

inlinevirtual

Destructor.

Definition at line 229 of file liboutputfunctions.h.

Member Function Documentation

void apply ( DoubleVector &  inputs, DoubleVector &  outputs  )

virtual

Implement the updating method.

Implements OutputFunction.

Definition at line 223 of file liboutputfunctions.cpp.

References ScaledSigmoidFunction::lambda, ScaledSigmoidFunction::max, and ScaledSigmoidFunction::min.

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

References ConfigurationParameters::getValue(), ScaledSigmoidFunction::lambda, ScaledSigmoidFunction::max, and ScaledSigmoidFunction::min.

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

virtual

return the approximation commonly used in backpropagation learning: x(1-x)

Reimplemented from OutputFunction.

Definition at line 234 of file liboutputfunctions.cpp.

References ScaledSigmoidFunction::lambda.

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

References ConfigurationParameters::createParameter(), ScaledSigmoidFunction::lambda, ScaledSigmoidFunction::max, ScaledSigmoidFunction::min, and ConfigurationParameters::startObjectParameters().

Member Data Documentation

double lambda

lambda is the slope of the curve

Definition at line 254 of file liboutputfunctions.h.

Referenced by ScaledSigmoidFunction::apply(), ScaledSigmoidFunction::configure(), ScaledSigmoidFunction::derivate(), ScaledSigmoidFunction::save(), and ScaledSigmoidFunction::ScaledSigmoidFunction().

double max

max is the y value when x -> +infinite

Definition at line 258 of file liboutputfunctions.h.

Referenced by ScaledSigmoidFunction::apply(), ScaledSigmoidFunction::configure(), ScaledSigmoidFunction::save(), and ScaledSigmoidFunction::ScaledSigmoidFunction().

double min

min is the y value when x -> -infinite

Definition at line 256 of file liboutputfunctions.h.

Referenced by ScaledSigmoidFunction::apply(), ScaledSigmoidFunction::configure(), ScaledSigmoidFunction::save(), and ScaledSigmoidFunction::ScaledSigmoidFunction().

---

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

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