Linear equation Function Implements a linear equation y = m*x + b. More...
Public Member Functions | |
LinearFunction () | |
Default constructor. More... | |
LinearFunction (double m, double b) | |
Construct a linear updater. More... | |
virtual | ~LinearFunction () |
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 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 | b |
b More... | |
double | m |
m 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
Linear equation Function Implements a linear equation y = m*x + b.
- Warning
- The old name (before version 1.1.0) of RampFunction was LinearFunction while now LinearFunction express a simple linear equation y=mx+b
Definition at line 324 of file liboutputfunctions.h.
Constructor & Destructor Documentation
LinearFunction | ( | ) |
Default constructor.
Definition at line 380 of file liboutputfunctions.cpp.
References LinearFunction::b, and LinearFunction::m.
LinearFunction | ( | double | m, |
double | b | ||
) |
Construct a linear updater.
Definition at line 386 of file liboutputfunctions.cpp.
References LinearFunction::b, and LinearFunction::m.
|
inlinevirtual |
Destructor.
Definition at line 331 of file liboutputfunctions.h.
Member Function Documentation
|
virtual |
Implement the updating method.
Implements OutputFunction.
Definition at line 392 of file liboutputfunctions.cpp.
References LinearFunction::b, and LinearFunction::m.
|
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 403 of file liboutputfunctions.cpp.
References LinearFunction::b, ConfigurationParameters::getValue(), and LinearFunction::m.
|
virtual |
return the m coefficient
Reimplemented from OutputFunction.
Definition at line 398 of file liboutputfunctions.cpp.
References LinearFunction::m.
|
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 426 of file liboutputfunctions.cpp.
References LinearFunction::b, ConfigurationParameters::createParameter(), LinearFunction::m, and ConfigurationParameters::startObjectParameters().
Member Data Documentation
double b |
b
Definition at line 358 of file liboutputfunctions.h.
Referenced by LinearFunction::apply(), LinearFunction::configure(), LinearFunction::LinearFunction(), and LinearFunction::save().
double m |
m
Definition at line 356 of file liboutputfunctions.h.
Referenced by LinearFunction::apply(), LinearFunction::configure(), LinearFunction::derivate(), LinearFunction::LinearFunction(), and LinearFunction::save().
The documentation for this class was generated from the following files:
- nnfw/include/liboutputfunctions.h
- nnfw/src/liboutputfunctions.cpp