StepFunction Class Reference

Step Function. More...

Inheritance diagram for StepFunction:

List of all members.

Public Member Functions
	StepFunction (double min=0.0f, double max=1.0f, double threshold=0.0f)
	Construct a step updater.
virtual	~StepFunction ()
	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
	Using the derivate of the sigmoid function!!!
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed.
Public Attributes
double	max
	Maximum value.
double	min
	Minimum value.
double	threshold
	Threshold.

---

Detailed Description

Step Function.

Further Details coming soon ;-)

Definition at line 366 of file liboutputfunctions.h.

---

Constructor & Destructor Documentation

StepFunction	(	double	min = 0.0f,
		double	max = 1.0f,
		double	threshold = 0.0f
	)

Construct a step updater.

Definition at line 425 of file liboutputfunctions.cpp.

References StepFunction::max, StepFunction::min, and StepFunction::threshold.

virtual ~StepFunction

(

)

[inline, virtual]

Destructor.

Definition at line 371 of file liboutputfunctions.h.

---

Member Function Documentation

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

Implement the updating method.

Implements OutputFunction.

Definition at line 432 of file liboutputfunctions.cpp.

References StepFunction::max, StepFunction::min, DoubleVector::size(), and StepFunction::threshold.

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

References ConfigurationParameters::getValue(), StepFunction::max, StepFunction::min, and StepFunction::threshold.

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

Using the derivate of the sigmoid function!!!

Reimplemented from OutputFunction.

Definition at line 439 of file liboutputfunctions.cpp.

References farsa::exp(), 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 482 of file liboutputfunctions.cpp.

References ConfigurationParameters::createParameter(), StepFunction::max, StepFunction::min, ConfigurationParameters::startObjectParameters(), and StepFunction::threshold.

---

Member Data Documentation

double max

Maximum value.

Definition at line 398 of file liboutputfunctions.h.

Referenced by StepFunction::apply(), StepFunction::configure(), StepFunction::save(), and StepFunction::StepFunction().

double min

Minimum value.

Definition at line 396 of file liboutputfunctions.h.

Referenced by StepFunction::apply(), StepFunction::configure(), StepFunction::save(), and StepFunction::StepFunction().

double threshold

Threshold.

Definition at line 400 of file liboutputfunctions.h.

Referenced by StepFunction::apply(), StepFunction::configure(), StepFunction::save(), and StepFunction::StepFunction().

---

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

• nnfw/include/liboutputfunctions.h
• nnfw/src/liboutputfunctions.cpp