Step Function. More...

Inheritance diagram for StepFunction:

Public Member Functions

 StepFunction (double min=0.0f, double max=1.0f, double threshold=0.0f)
 Construct a step updater.
 
virtual ~StepFunction ()
 Destructor.
 
virtual void apply (DoubleVector &inputs, DoubleVector &outputs)
 Implement the updating method.
 
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
 Using the derivate of the sigmoid function!!!
 
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)
 
getRuntimeParameter (QString paramName)
 
virtual ParameterSettableUIgetUIManager ()
 
 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)
 
getRuntimeParameter (QString paramName)
 
void removeObserver (RuntimeParameterObserver *obs)
 
void setRuntimeParameter (QString paramName, T newvalue)
 
QString typeName () const
 

Public Attributes

double max
 Maximum value.
 
double min
 Minimum value.
 
double threshold
 Threshold.
 

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
Clusterclusterv
 Cluster on which the OutputFunction is inserted.
 

Detailed Description

Step Function.

Further Details coming soon ;-)

Definition at line 366 of file liboutputfunctions.h.

Constructor & Destructor Documentation

StepFunction ( double  min = 0.0f,
double  max = 1.0f,
double  threshold = 0.0f 
)

Construct a step updater.

Definition at line 425 of file liboutputfunctions.cpp.

References StepFunction::max, StepFunction::min, and StepFunction::threshold.

virtual ~StepFunction ( )
inlinevirtual

Destructor.

Definition at line 371 of file liboutputfunctions.h.

Member Function Documentation

void apply ( DoubleVector inputs,
DoubleVector outputs 
)
virtual

Implement the updating method.

Implements OutputFunction.

Definition at line 432 of file liboutputfunctions.cpp.

References StepFunction::max, StepFunction::min, DoubleVector::size(), and StepFunction::threshold.

void configure ( ConfigurationParameters params,
QString  prefix 
)
virtual

Configures the object using a ConfigurationParameters object.

Parameters
paramsthe configuration parameters object with parameters to use
prefixthe 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 449 of file liboutputfunctions.cpp.

References ConfigurationParameters::getValue(), StepFunction::max, StepFunction::min, and StepFunction::threshold.

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

Using the derivate of the sigmoid function!!!

Reimplemented from OutputFunction.

Definition at line 439 of file liboutputfunctions.cpp.

References farsa::exp(), and DoubleVector::size().

void save ( ConfigurationParameters params,
QString  prefix 
)
virtual

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

Parameters
paramsthe configuration parameters object on which save actual parameters
prefixthe prefix to use to access the object configuration parameters.

Implements ParameterSettableWithConfigureFunction.

Definition at line 482 of file liboutputfunctions.cpp.

References ConfigurationParameters::createParameter(), StepFunction::max, StepFunction::min, ConfigurationParameters::startObjectParameters(), and StepFunction::threshold.

Member Data Documentation

double max
double min
double threshold

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