Linker Class Reference

Abstract Linker Class. More...

Inheritance diagram for Linker:

List of all members.

Public Member Functions
	Linker (Cluster *from, Cluster *to, QString name="unnamed")
	Construct.
	Linker (ConfigurationParameters &params, QString prefix)
	Constructor.
void	configureFromVector (QString vectorName)
	Configure on which state vector of 'from' Cluster this Linker is attached to.
void	configureToVector (QString vectorName)
	Configure on which state vector of 'to' Cluster this Linker is attached to.
Cluster *	from () const
	Return the Cluster From.
virtual void	randomize (double min, double max)=0
	Randomize the parameters of the Linker The parameters randomized by this method will be specified by sub-classes.
virtual void	save (ConfigurationParameters &params, QString prefix)
	Save the actual status of parameters into the ConfigurationParameters object passed.
virtual unsigned int	size () const =0
	Returns the 'size' of the linker The actual means of 'size' will be specified by sub-classes that implementes concrete linkers.
Cluster *	to () const
	Return the Cluster to.
Static Public Member Functions
static void	describe (QString type)
	Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups.
Protected Member Functions
DoubleVector &	fromVector () const
	Return a reference to the DoubleVector of 'from' on which this is attached to.
DoubleVector &	toVector () const
	Return a reference to the DoubleVector of 'to' on which this is attached to.

---

Detailed Description

Abstract Linker Class.

This define the common interface among Linkers

Definition at line 38 of file linker.h.

---

Constructor & Destructor Documentation

Linker	(	Cluster *	from,
		Cluster *	to,
		QString	name = "unnamed"
	)

Construct.

Definition at line 25 of file linker.cpp.

References Linker::from(), Cluster::getDelegateFor(), and Linker::to().

Linker	(	ConfigurationParameters &	params,
		QString	prefix
	)

Constructor.

Definition at line 35 of file linker.cpp.

References Cluster::getDelegateFor(), ConfigurationParameters::getObjectFromParameter(), and ConfigurationParameters::getValue().

---

Member Function Documentation

void configureFromVector

(

QString

vectorName

)

[inline]

Configure on which state vector of 'from' Cluster this Linker is attached to.

Parameters:

vectorName

is the name assigned to the state vector

Warning:

it raise an exception is the vectorName does not exists

Definition at line 56 of file linker.h.

void configureToVector

(

QString

vectorName

)

[inline]

Configure on which state vector of 'to' Cluster this Linker is attached to.

Parameters:

vectorName

is the name assigned to the state vector

Warning:

it raise an exception is the vectorName does not exists

Definition at line 64 of file linker.h.

void describe

(

QString

type

)

[static]

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

Reimplemented from Updatable.

Definition at line 72 of file linker.cpp.

References ParameterSettable::addTypeDescription(), ParameterSettable::StringDescriptor::def(), ParameterSettable::Descriptor::describeObject(), ParameterSettable::Descriptor::describeString(), ParameterSettable::StringDescriptor::help(), ParameterSettable::ObjectDescriptor::help(), ParameterSettable::IsMandatory, ParameterSettable::ObjectDescriptor::props(), and ParameterSettable::ObjectDescriptor::type().

Cluster* from

(

)

const [inline]

Return the Cluster From.

Definition at line 45 of file linker.h.

Referenced by NeuralNet::addLinker(), MatrixLinker::disconnect(), Linker::Linker(), NeuralNet::removeLinker(), MatrixLinker::setWeight(), and MatrixLinker::weight().

DoubleVector& fromVector

(

)

const [inline, protected]

Return a reference to the DoubleVector of 'from' on which this is attached to.

Definition at line 89 of file linker.h.

Referenced by CopyLinker::size(), NormLinker::update(), DotLinker::update(), and CopyLinker::update().

virtual void randomize	(	double	min,
		double	max
	)		[pure virtual]

Randomize the parameters of the Linker
The parameters randomized by this method will be specified by sub-classes.

Implemented in CopyLinker, and MatrixLinker.

void save	(	ConfigurationParameters &	params,
		QString	prefix
	)		[virtual]

Save the actual status of parameters into the ConfigurationParameters object passed.

This saves the name property, remember to call this in child classes

Parameters:

params	the configuration parameters object on which save actual parameters
prefix	the prefix to use to access the object configuration parameters.

Reimplemented from Updatable.

Reimplemented in CopyLinker, DotLinker, MatrixLinker, and NormLinker.

Definition at line 58 of file linker.cpp.

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

Referenced by NeuralNet::save().

virtual unsigned int size

(

)

const [pure virtual]

Returns the 'size' of the linker
The actual means of 'size' will be specified by sub-classes that implementes concrete linkers.

Implemented in CopyLinker, and MatrixLinker.

Cluster* to

(

)

const [inline]

Return the Cluster to.

Definition at line 49 of file linker.h.

Referenced by NeuralNet::addLinker(), MatrixLinker::disconnect(), Linker::Linker(), NeuralNet::removeLinker(), MatrixLinker::setWeight(), NormLinker::update(), DotLinker::update(), CopyLinker::update(), and MatrixLinker::weight().

DoubleVector& toVector

(

)

const [inline, protected]

Return a reference to the DoubleVector of 'to' on which this is attached to.

Definition at line 93 of file linker.h.

Referenced by CopyLinker::size(), NormLinker::update(), DotLinker::update(), and CopyLinker::update().

---

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

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