RampFunction Class Reference

Ramp Function. More...

Inheritance diagram for RampFunction:

List of all members.

Public Member Functions
	RampFunction ()
	Default constructor.
	RampFunction (double minX, double maxX, double minY=-1, double maxY=+1)
	Construct a linear updater.
virtual	~RampFunction ()
	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
	return the m coefficient if x is in [minX, maxX] and x(1-x) otherwise
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed.
Public Attributes
double	max_x
	maxX
double	max_y
	maxY
double	min_x
	minX
double	min_y
	minY

---

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 277 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 285 of file liboutputfunctions.cpp.

References RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, and RampFunction::min_y.

virtual ~RampFunction

(

)

[inline, virtual]

Destructor.

Definition at line 284 of file liboutputfunctions.h.

---

Member Function Documentation

void apply	(	DoubleVector &	inputs,
		DoubleVector &	outputs
	)		[virtual]

Implement the updating method.

Implements OutputFunction.

Definition at line 293 of file liboutputfunctions.cpp.

References RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, RampFunction::min_y, and DoubleVector::size().

void configure	(	ConfigurationParameters &	params,
		QString	prefix
	)		[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 322 of file liboutputfunctions.cpp.

References ConfigurationParameters::getValue(), RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, and RampFunction::min_y.

bool derivate	(	const DoubleVector &	x,
		const DoubleVector &	y,
		DoubleVector &	d
	)		const [virtual]

return the m coefficient if x is in [minX, maxX] and x(1-x) otherwise

Reimplemented from OutputFunction.

Definition at line 309 of file liboutputfunctions.cpp.

References farsa::exp(), RampFunction::max_x, RampFunction::max_y, RampFunction::min_x, RampFunction::min_y, and DoubleVector::size().

void save	(	ConfigurationParameters &	params,
		QString	prefix
	)		[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 365 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