The NullScaler is a scaler that does nothing, the output of the transform function is equal to its input. More...
#include <IScaler.h>
Inheritance diagram for iCub::learningmachine::NullScaler:
Public Member Functions | |
| NullScaler () | |
| Constructor. More... | |
| virtual double | transform (double val) |
| Transforms a single sample value according to the state of the scaler. More... | |
| virtual double | unTransform (double val) |
| Untransforms a single sample value according to the state of the scaler. More... | |
| virtual NullScaler * | clone () |
| Asks the scaler to return a new object of its type. More... | |
| Public Member Functions inherited from iCub::learningmachine::IScaler | |
| IScaler (double s=1., double o=0.) | |
| Constructor. More... | |
| virtual | ~IScaler () |
| Destructor (empty). More... | |
| virtual void | update (double val) |
| Feeds a single sample into the scaler, so that it can use this sample to update the offset and scale. More... | |
| virtual std::string | getInfo () |
| Asks the learning machine to return a string containing statistics on its operation so far. More... | |
| std::string | getName () const |
| Retrieve the name of this scaler. More... | |
| void | setName (std::string name) |
| Set the name of this machine learning technique. More... | |
| virtual void | setUpdateEnabled (bool u) |
| Mutator for the update state. More... | |
| virtual bool | getUpdateEnabled () |
| Accessor for the update state. More... | |
| virtual std::string | toString () |
| Asks the scaler to return a string serialization. More... | |
| virtual bool | fromString (const std::string &str) |
| Asks the scaler to initialize from a string serialization. More... | |
| virtual bool | configure (yarp::os::Searchable &config) |
Additional Inherited Members | |
| Protected Member Functions inherited from iCub::learningmachine::IScaler | |
| virtual void | writeBottle (yarp::os::Bottle &bot) |
| Writes a serialization of the scaler into a bottle. More... | |
| virtual void | readBottle (yarp::os::Bottle &bot) |
| Unserializes a scaler from a bottle. More... | |
| Protected Attributes inherited from iCub::learningmachine::IScaler | |
| double | offset |
| The offset for the linear transformation. More... | |
| double | scale |
| The scale for the linear transformation. More... | |
| std::string | name |
| The name of this type of scaler. More... | |
| bool | updateEnabled |
| Boolean indicating whether the scaler has to update each sample. More... | |
Detailed Description
The NullScaler is a scaler that does nothing, the output of the transform function is equal to its input.
The use is so that the ScaleTransformer can 'disable' transformation on certain inputs.
Constructor & Destructor Documentation
◆ NullScaler()
|
inline |
Member Function Documentation
◆ clone()
|
inlinevirtual |
Asks the scaler to return a new object of its type.
- Returns
- a fresh instance of the specified type
Implements iCub::learningmachine::IScaler.
◆ transform()
|
inlinevirtual |
Transforms a single sample value according to the state of the scaler.
This state is usually made up out of a desired offset and scale.
- Parameters
-
val the sample
- Returns
- the resulting, transformed sample
Reimplemented from iCub::learningmachine::IScaler.
◆ unTransform()
|
inlinevirtual |
Untransforms a single sample value according to the state of the scaler.
This operation is the inverse of the transform operation.
- Parameters
-
val the sample
- Returns
- the resulting, transformed sample
Reimplemented from iCub::learningmachine::IScaler.
The documentation for this class was generated from the following file:
- icub-main/src/libraries/learningMachine/include/iCub/learningMachine/IScaler.h
