DDECluster Class Reference

DDECluster Class. More...

Inheritance diagram for DDECluster:

List of all members.

Public Member Functions
	DDECluster (const DoubleVector &coeff, unsigned int numNeurons, QString name="unnamed")
	Construct a DDECluster setting coefficients as specified.
	DDECluster (ConfigurationParameters &params, QString prefix)
	Constructor.
virtual	~DDECluster ()
	Destructor.
const DoubleVector	getCoeff ()
	Return coeffiecients.
void	randomize (double, double)
	Randomize Nothing ;-)
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed.
void	setCoeff (const DoubleVector &coef)
	Set the coeffiecients.
void	update ()
	Update the outputs of neurons.
Static Public Member Functions
static void	describe (QString type)
	Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups.

---

Detailed Description

DDECluster Class.

In this cluster the input/output relation is governed by a Discrete Differential Equation

Motivation

Create a Cluster where the outputs dependes on previous value, or in other words on derivative of outputs

Description

This Cluster calculate the outputs accordlying with follow equation:
y(t) <- a0 + a1*f(x) + a2*x(t) + a3*y(t-1) + a4*y'(t-1) + a5*y''(t-1) + a6*y'''(t-1) + ...
NOTE: A simply leaky-integrator is possible by settings coefficients in the following way:
a0 <- 0.0 ; a1 <- delta ; a2 <- 0.0 ; a3 <- 1.0-delta
getting::
y(t) <- (delta)*f(x) + (1.0-delta)*y(t-1)

Warnings

Definition at line 45 of file ddecluster.h.

---

Constructor & Destructor Documentation

DDECluster	(	const DoubleVector &	coeff,
		unsigned int	numNeurons,
		QString	name = "unnamed"
	)

Construct a DDECluster setting coefficients as specified.

Definition at line 24 of file ddecluster.cpp.

References DDECluster::setCoeff().

DDECluster	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

Definition at line 29 of file ddecluster.cpp.

References ConfigurationParameters::getValue(), and DoubleVector::resize().

~DDECluster

(

)

[virtual]

Destructor.

Definition at line 46 of file ddecluster.cpp.

---

Member Function Documentation

void describe

(

QString

type

)

[static]

Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups.

Reimplemented from Cluster.

Definition at line 148 of file ddecluster.cpp.

References ParameterSettable::addTypeDescription(), ParameterSettable::RealDescriptor::def(), ParameterSettable::Descriptor::describeReal(), ParameterSettable::RealDescriptor::help(), ParameterSettable::IsList, ParameterSettable::IsMandatory, and ParameterSettable::RealDescriptor::props().

const DoubleVector getCoeff

(

)

[inline]

Return coeffiecients.

Definition at line 56 of file ddecluster.h.

void randomize	(	double	,
		double
	)		[inline, virtual]

Randomize Nothing ;-)

Implements Cluster.

Definition at line 62 of file ddecluster.h.

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.

Reimplemented from Cluster.

Definition at line 136 of file ddecluster.cpp.

References ConfigurationParameters::createParameter(), DoubleVector::size(), and ConfigurationParameters::startObjectParameters().

void setCoeff

(

const DoubleVector &

coef

)

Set the coeffiecients.

Definition at line 50 of file ddecluster.cpp.

References Cluster::numNeurons(), and DoubleVector::size().

Referenced by DDECluster::DDECluster().

void update

(

)

[virtual]

Update the outputs of neurons.

Implements Updatable.

Definition at line 59 of file ddecluster.cpp.

References OutputFunction::apply(), DoubleVector::copyValues(), Cluster::inputs(), Cluster::outFunction(), Cluster::outputs(), DoubleVector::setAll(), Cluster::setNeedReset(), DoubleVector::size(), and DoubleVector::zeroing().

---

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

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