Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Functor Class Reference

Base class for sequential computations. Optional scaling utilities. More...

#include <Functor.h>

Inheritance diagram for Functor:
Inheritance graph
[legend]
Collaboration diagram for Functor:
Collaboration graph
[legend]

Public Member Functions

void setScale (double scale, double bias=0.0)
 
virtual void updateBean () const override
 Called after setParameters()
 
- Public Member Functions inherited from BeanLike
virtual const std::string & getName () const
 Return the name of an instance.
 
virtual const std::string & getDescription () const
 Return a brief description.
 
bool hasParameters () const
 
template<class F >
getParameter (const std::string &p) const
 Gets a single parameter.
 
const ReferenceMapgetParameters () const
 
ReferenceMapgetParameters ()
 
template<class F >
void setParametersFromEntries (const F &args)
 
void setParameters (std::initializer_list< Variable::init_pair_t > args)
 Grants access to (if above hidden)
 
virtual void setParameters (const std::string &p, char assignmentSymbol='=', char separatorSymbol=0)
 Sets comma-separated parameters in a predetermined order "a,b,c" or by specifing them "b=2". More...
 
template<class T >
void setParameters (const std::map< std::string, T > &args)
 Set parameters.
 
template<class T >
void setParameters (const SmartMap< T > &args)
 Set parameters.
 
void setParameter (const std::string &p, const Castable &value)
 Sets a single parameter.
 
template<class T >
void setParameter (const std::string &p, const VariableT< T > &value)
 
template<class F >
void setParameter (const std::string &p, const F &value)
 Sets a single parameter. More...
 
template<class F >
void setParameter (const std::string &p, std::initializer_list< F > value)
 Sets a single parameter.
 
BeanLikeoperator= (const BeanLike &b)
 
virtual std::ostream & toStream (std::ostream &ostr, bool compact=true) const
 
 BeanLike (const BeanLike &b)
 
 BeanLike (const std::string &name, const std::string &description="")
 

Protected Member Functions

 Functor (const std::string &name, const std::string &description="", double scale=1.0, double bias=0.0)
 
 Functor (const Functor &fct)
 
virtual void updateScale () const
 
- Protected Member Functions inherited from BeanLike
virtual void storeLastArguments (const std::string &p)
 Called after setParameters()
 

Protected Attributes

double scale
 Relative scale, typically 1. Optional.
 
double bias
 "Relative" bias, typically 0. Optional.
 
double scaleFinal
 Scaling factor after encodings of src and dst images are known.
 
double biasFinal
 Scaling factor after encodings of src and dst images are known.
 
- Protected Attributes inherited from BeanLike
const std::string name
 
const std::string description
 
ReferenceMap parameters
 

Detailed Description

Base class for sequential computations. Optional scaling utilities.


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