Ramp Function. More...
Public Member Functions | |
RampFunction () | |
Default constructor. More... | |
RampFunction (double minX, double maxX, double minY=-1, double maxY=+1) | |
Construct a linear updater. More... | |
virtual | ~RampFunction () |
Destructor. More... | |
virtual void | apply (DoubleVector &inputs, DoubleVector &outputs) |
Implement the updating method. More... | |
virtual void | configure (ConfigurationParameters ¶ms, QString prefix) |
Configures the object using a ConfigurationParameters object. More... | |
virtual bool | derivate (const DoubleVector &x, const DoubleVector &y, DoubleVector &d) const |
return the m coefficient if x is in [minX, maxX] and x(1-x) otherwise More... | |
virtual void | save (ConfigurationParameters ¶ms, 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 | max_x |
maxX More... | |
double | max_y |
maxY More... | |
double | min_x |
minX More... | |
double | min_y |
minY 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
Ramp Function.
- Warning
- The old name (before version 1.1.0) of RampFunction was LinearFunction while now LinearFunction express a simple linear equation y=mx+b
maxY /--------------- / / / minY -------/ minX maxX
Further Details coming soon ;-)
Definition at line 277 of file liboutputfunctions.h.
Constructor & Destructor Documentation
RampFunction | ( | ) |
Default constructor.
Definition at line 283 of file liboutputfunctions.cpp.
References RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, and RampFunction::min_y.
RampFunction | ( | double | minX, |
double | maxX, | ||
double | minY = -1 , |
||
double | maxY = +1 |
||
) |
Construct a linear updater.
Definition at line 291 of file liboutputfunctions.cpp.
References RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, and RampFunction::min_y.
|
inlinevirtual |
Destructor.
Definition at line 284 of file liboutputfunctions.h.
Member Function Documentation
|
virtual |
Implement the updating method.
Implements OutputFunction.
Definition at line 299 of file liboutputfunctions.cpp.
References RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, and RampFunction::min_y.
|
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 328 of file liboutputfunctions.cpp.
References ConfigurationParameters::getValue(), RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, and RampFunction::min_y.
|
virtual |
return the m coefficient if x is in [minX, maxX] and x(1-x) otherwise
Reimplemented from OutputFunction.
Definition at line 315 of file liboutputfunctions.cpp.
References RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, and RampFunction::min_y.
|
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 371 of file liboutputfunctions.cpp.
References ConfigurationParameters::createParameter(), RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, RampFunction::min_y, and ConfigurationParameters::startObjectParameters().
Member Data Documentation
double max_x |
maxX
Definition at line 311 of file liboutputfunctions.h.
Referenced by RampFunction::apply(), RampFunction::configure(), RampFunction::derivate(), RampFunction::RampFunction(), and RampFunction::save().
double max_y |
maxY
Definition at line 315 of file liboutputfunctions.h.
Referenced by RampFunction::apply(), RampFunction::configure(), RampFunction::derivate(), RampFunction::RampFunction(), and RampFunction::save().
double min_x |
minX
Definition at line 309 of file liboutputfunctions.h.
Referenced by RampFunction::apply(), RampFunction::configure(), RampFunction::derivate(), RampFunction::RampFunction(), and RampFunction::save().
double min_y |
minY
Definition at line 313 of file liboutputfunctions.h.
Referenced by RampFunction::apply(), RampFunction::configure(), RampFunction::derivate(), RampFunction::RampFunction(), and RampFunction::save().
The documentation for this class was generated from the following files:
- nnfw/include/liboutputfunctions.h
- nnfw/src/liboutputfunctions.cpp