Ramp Function. More...

Inheritance diagram for RampFunction:

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 Member Functions inherited from OutputFunction
	OutputFunction ()
	Constructor.

virtual	~OutputFunction ()
	Destructor.

double	apply (double input)
	Calculate the outputs of a single neuron.

void	setCluster (Cluster *cl)
	Set the Cluster which it is inserted This is automatically called, and in normal case you don't have to call it directly.

Public Member Functions inherited from ParameterSettableWithConfigureFunction
void	addObserver (RuntimeParameterObserver *obs)

T	getRuntimeParameter (QString paramName)

virtual ParameterSettableUI *	getUIManager ()

	ParameterSettable ()

virtual void	postConfigureInitialization ()

void	removeObserver (RuntimeParameterObserver *obs)

void	setRuntimeParameter (QString paramName, T newvalue)

QString	typeName () const

Public Member Functions inherited from ParameterSettable
void	addObserver (RuntimeParameterObserver *obs)

T	getRuntimeParameter (QString paramName)

void	removeObserver (RuntimeParameterObserver *obs)

void	setRuntimeParameter (QString paramName, T newvalue)

QString	typeName () const

Public Attributes
double	max_x
	maxX

double	max_y
	maxY

double	min_x
	minX

double	min_y
	minY

Additional Inherited Members
Public Types inherited from ParameterSettableWithConfigureFunction
enum	Property

Static Public Member Functions inherited from ParameterSettableWithConfigureFunction
static void	describe (QString type)

static QString	fullParameterDescriptionPath (QString type, QString param)

static QString	fullSubgroupDescriptionPath (QString type, QString sub)

Static Public Attributes inherited from ParameterSettableWithConfigureFunction
static const double	Infinity

static const int	MaxInteger

static const int	MinInteger

Protected Member Functions inherited from OutputFunction
virtual void	clusterSetted ()
	The method setCluster will call clusterSetted to inform subclasses that the OutputFunction has been inserted into a Cluster.

Static Protected Member Functions inherited from ParameterSettableWithConfigureFunction
static Descriptor	addTypeDescription (QString type, QString shortHelp, QString longHelp=QString(""))

static void	setGraphicalEditor (QString type)

Protected Attributes inherited from OutputFunction
Cluster *	clusterv
	Cluster on which the OutputFunction is inserted.

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 ( )

inlinevirtual

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.