LinearFunction Class Reference

Linear equation Function Implements a linear equation y = m*x + b. More...

Inheritance diagram for LinearFunction:

List of all members.

Public Member Functions
	LinearFunction ()
	Default constructor.
	LinearFunction (double m, double b)
	Construct a linear updater.
virtual	~LinearFunction ()
	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
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed.
Public Attributes
double	b
	b
double	m
	m

---

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

References LinearFunction::b, and LinearFunction::m.

LinearFunction	(	double	m,
		double	b
	)

Construct a linear updater.

Definition at line 380 of file liboutputfunctions.cpp.

References LinearFunction::b, and LinearFunction::m.

virtual ~LinearFunction

(

)

[inline, virtual]

Destructor.

Definition at line 331 of file liboutputfunctions.h.

---

Member Function Documentation

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

Implement the updating method.

Implements OutputFunction.

Definition at line 386 of file liboutputfunctions.cpp.

References LinearFunction::b, LinearFunction::m, and farsa::mul().

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

References LinearFunction::b, ConfigurationParameters::getValue(), and LinearFunction::m.

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

return the m coefficient

Reimplemented from OutputFunction.

Definition at line 390 of file liboutputfunctions.cpp.

References LinearFunction::m, and DoubleVector::setAll().

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 418 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