multi layer neural network with configurable activation functions More...

#include <multilayerffnn.h>

Inheritance diagram for MultiLayerFFNN:

Collaboration diagram for MultiLayerFFNN:

Public Member Functions
	MultiLayerFFNN (double eps, const std::vector< Layer > &layers, bool useBypass=false, bool someInternalParams=true)

virtual	~MultiLayerFFNN ()

virtual void	init (unsigned int inputDim, unsigned int outputDim, double unit_map=0.0, RandGen *randGen=0)
	initialisation of the network with the given number of input and output units. More...

virtual const matrix::Matrix	process (const matrix::Matrix &input)
	passive processing of the input More...

virtual const matrix::Matrix	learn (const matrix::Matrix &input, const matrix::Matrix &nom_output, double learnRateFactor=1)
	performs learning and returns the network output before learning (process should be called before) More...

virtual const matrix::Matrix	response (const matrix::Matrix &input) const
	response matrix of neural network at given input More...

virtual const matrix::Matrix	inversion (const matrix::Matrix &input, const matrix::Matrix &xsi) const
	calculates the input shift v to a given output shift xsi via pseudo inversion. More...

virtual unsigned int	getInputDim () const
	returns the number of input neurons More...

virtual unsigned int	getOutputDim () const
	returns the number of output neurons More...

virtual const matrix::Matrix &	getLayerOutput (unsigned int layer) const
	returns activation of the given layer. Layer 0 is the first hidden layer More...

virtual void	damp (double damping)
	damps the weights and the biases by multiplying (1-damping) More...

virtual unsigned int	getLayerNum () const

virtual const Layer &	getLayer (unsigned int layer) const
	layers 0 is the first hidden layer More...

virtual Layer &	getLayer (unsigned int layer)
	layers 0 is the first hidden layer More...

virtual const matrix::Matrix &	getWeights (unsigned int to_layer) const
	weight matrix 0 connects input with the first hidden layer More...

virtual matrix::Matrix &	getWeights (unsigned int to_layer)
	weight matrix 0 connects input with the first hidden layer More...

virtual const matrix::Matrix &	getBias (unsigned int of_layer) const
	Note: layers 0 is the first hidden layer. More...

virtual matrix::Matrix &	getBias (unsigned int of_layer)
	Note: layers 0 is the first hidden layer. More...

bool	store (FILE *f) const
	stores the layer binary into file stream More...

bool	restore (FILE *f)
	restores the layer binary from file stream More...

bool	write (FILE *f) const
	writes the layer ASCII into file stream (not in the storable interface) More...

virtual iparamkeylist	getInternalParamNames () const
	The list of the names of all internal parameters given by getInternalParams(). More...

virtual iparamvallist	getInternalParams () const

virtual ilayerlist	getStructuralLayers () const
	Specifies which parameter vector forms a structural layer (in terms of a neural network) The ordering is important. More...

virtual iconnectionlist	getStructuralConnections () const
	Specifies which parameter matrix forms a connection between layers (in terms of a neural network) The orderning is not important. More...

virtual void	setSomeInternalParams (bool someInternalParams)

virtual std::vector < ActivationFunction >	setActivationFunction (ActivationFunction actfun)
	sets the activation function (and derivative and inversion too) for ALL layers! More...

virtual void	setActivationFunctions (std::vector< ActivationFunction > actfunList)
	sets the activation functions (and derivative and inversion too) for all layers. More...

Public Member Functions inherited from FeedForwardNN
	FeedForwardNN (const std::string &name, const std::string &revision)

virtual	~FeedForwardNN ()

Public Member Functions inherited from InvertableModel
	InvertableModel (const std::string &name, const std::string &revision)

virtual	~InvertableModel ()

Public Member Functions inherited from AbstractModel
	AbstractModel (const std::string &name, const std::string &revision)

virtual	~AbstractModel ()

Public Member Functions inherited from Configurable
	Configurable ()

	Configurable (const std::string &name, const std::string &revision)
	intialise with name and revision (use "$ID$") More...

virtual	~Configurable ()

virtual void	notifyOnChange (const paramkey &key)
	Is called when a parameter was changes via setParam(). More...

virtual void	addParameter (const paramkey &key, paramval *val, paramval minBound, paramval maxBound, const paramdescr &descr=paramdescr())
	This is the new style for adding configurable parameters. More...

virtual void	addParameter (const paramkey &key, paramval *val, const paramdescr &descr=paramdescr())
	See addParameter(const paramkey& key, paramval* val, paramval minBound, paramval maxBound, const paramdescr& descr) More...

virtual void	addParameter (const paramkey &key, parambool *val, const paramdescr &descr=paramdescr())
	See addParameter(const paramkey& key, paramval* val) but for bool values. More...

virtual void	addParameter (const paramkey &key, paramint *val, paramint minBound, paramint maxBound, const paramdescr &descr=paramdescr())
	See addParameter(const paramkey& key, paramval* val) but for int values. More...

virtual void	addParameter (const paramkey &key, paramint *val, const paramdescr &descr=paramdescr())

virtual void	addParameterDef (const paramkey &key, paramval *val, paramval def, paramval minBound, paramval maxBound, const paramdescr &descr=paramdescr())
	This function is only provided for convenience. More...

virtual void	addParameterDef (const paramkey &key, paramval *val, paramval def, const paramdescr &descr=paramdescr())

virtual void	addParameterDef (const paramkey &key, parambool *val, parambool def, const paramdescr &descr=paramdescr())
	See addParameterDef(const paramkey&, paramval*, paramval) More...

virtual void	addParameterDef (const paramkey &key, paramint *val, paramint def, paramint minBound, paramint maxBound, const paramdescr &descr=paramdescr())
	See addParameterDef(const paramkey&, paramval*, paramval) More...

virtual void	addParameterDef (const paramkey &key, paramint *val, paramint def, const paramdescr &descr=paramdescr())

virtual void	setParamDescr (const paramkey &key, const paramdescr &descr, bool traverseChildren=true)
	sets a description for the given parameter More...

int	getId () const
	return the id of the configurable objects, which is created by random on initialisation More...

virtual paramkey	getName () const
	return the name of the object More...

virtual paramkey	getRevision () const
	returns the revision of the object More...

virtual void	setName (const paramkey &name, bool callSetNameOfInspectable=true)
	Sets the name of the configurable. More...

virtual void	setRevision (const paramkey &revision)
	sets the revision Hint: { return "$ID$"; } More...

virtual paramval	getParam (const paramkey &key, bool traverseChildren=true) const
	returns the value of the requested parameter or 0 (+ error message to stderr) if unknown. More...

virtual bool	hasParam (const paramkey &key, bool traverseChildren=true) const
	Returns if the requested parameter is part of the configurable or their children. More...

virtual bool	setParam (const paramkey &key, paramval val, bool traverseChildren=true)
	sets the value of the given parameter or does nothing if unknown. More...

virtual void	setParamBounds (const paramkey &key, paramval minBound, paramval maxBound, bool traverseChildren=true)
	Sets the bounds (minBound and maxBound) of the given parameter. More...

virtual void	setParamBounds (const paramkey &key, paramint minBound, paramint maxBound, bool traverseChildren=true)

virtual void	setParamBounds (const paramkey &key, paramvalBounds bounds, bool traverseChildren=true)

virtual void	setParamBounds (const paramkey &key, paramintBounds bounds, bool traverseChildren=true)

virtual paramlist	getParamList () const
	The list of all parameters with there value as allocated lists. More...

virtual std::list< paramkey >	getAllParamNames (bool traverseChildren=true)
	returns all names that are configureable More...

virtual parammap	getParamValMap () const

virtual paramintmap	getParamIntMap () const

virtual paramboolmap	getParamBoolMap () const

virtual paramdescr	getParamDescr (const paramkey &key, bool traverseChildren=true) const
	returns the description for the given parameter More...

virtual paramvalBounds	getParamvalBounds (const paramkey &key, bool traverseChildren=true) const

virtual paramintBounds	getParamintBounds (const paramkey &key, bool traverseChildren=true) const

virtual bool	hasParamDescr (const paramkey &key, bool traverseChildren=true) const

virtual bool	hasParamvalBounds (const paramkey &key, bool traverseChildren=true) const

virtual bool	hasParamintBounds (const paramkey &key, bool traverseChildren=true) const

virtual bool	storeCfg (const char *filenamestem, const std::list< std::string > &comments=std::list< std::string >())
	stores the key values paires into the file : filenamestem.cfg including the comments given in the list More...

virtual bool	restoreCfg (const char *filenamestem)
	restores the key values paires from the file : filenamestem.cfg More...

void	print (FILE f, const char prefix, int columns=90, bool traverseChildren=true) const
	prints the keys, values and descriptions to the file. Each line is prefixed More...

bool	parse (FILE f, const char prefix=0, bool traverseChildren=true)
	parses the configuration from the given file More...

virtual void	addConfigurable (Configurable *conf)
	Adds a configurable as a child object. More...

virtual void	removeConfigurable (Configurable *conf)
	Removes a configurable as a child object. More...

virtual const configurableList &	getConfigurables () const
	Returns the list containing all configurable children. More...

virtual void	configurableChanged ()
	Indicates that the configurable itself or the configurable children attached to this configurable have changed. More...

Public Member Functions inherited from BackCaller
	BackCaller ()

virtual	~BackCaller ()

virtual void	addCallbackable (Callbackable *callbackableInstance, CallbackableType type=BackCaller::DEFAULT_CALLBACKABLE_TYPE)
	Adds a Callbackable instance to this caller instance. More...

virtual void	removeCallbackable (Callbackable *callbackableInstance, CallbackableType type=BackCaller::DEFAULT_CALLBACKABLE_TYPE)
	Removes a Callbackable instance from this caller instance. More...

virtual void	removeAllCallbackables (CallbackableType type)
	Removes all Callbackable instances from this caller instance. More...

virtual void	callBack (CallbackableType type=BackCaller::DEFAULT_CALLBACKABLE_TYPE)
	Calls all registered callbackable classes of the determined type. More...

virtual void	callBackQMP (CallbackableType type=BackCaller::DEFAULT_CALLBACKABLE_TYPE)
	Calls all registered callbackable classes of the determined type. More...

Public Member Functions inherited from Storeable
virtual	~Storeable ()

bool	storeToFile (const char *filename) const
	Provided for convenience. More...

bool	restoreFromFile (const char *filename)
	Provided for convenience. More...

Public Member Functions inherited from Inspectable
	Inspectable (const iparamkey &name="")
	TYPEDEFS END. More...

virtual	~Inspectable ()

virtual iparamvalptrlist	getInternalParamsPtr () const
	be careful: matrices will be ignored More...

virtual void	addInspectableValue (const iparamkey &key, iparamval const *val, const std::string &descr=std::string())
	This is the new style for adding inspectable values. More...

virtual void	addInspectableMatrix (const iparamkey &key, const matrix::Matrix *m, bool only4x4AndDiag=true, const std::string &descr=std::string())
	This is the new style for adding inspectable values. More...

virtual void	addInspectableDescription (const iparamkey &key, const std::string &descr)
	adds a description for the given parameter using info-lines The line will start (appart from the #I) with a D for description followed by the key end then followed by the string. More...

virtual void	addInfoLine (std::string infoLine)
	Adds an info line to this inspectable instance. More...

virtual void	addInfoLines (std::list< std::string > infoLineList)
	Adds a bunch of infolines with addInfoLine to this inspectable instance. More...

virtual void	removeInfoLines ()
	Removes all infolines from this inspectable instance. More...

virtual const infoLinesList &	getInfoLines () const
	Returns all infolines added to this inspectable instance. More...

virtual void	addInspectable (Inspectable *insp)
	Adds an inspectable as a child object. More...

virtual void	removeInspectable (Inspectable *insp)
	Removes an inspectable as a child object. More...

virtual void	setNameOfInspectable (const iparamkey &name)
	set the name of the inspectable More...

virtual const iparamkey	getNameOfInspectable () const
	return the name of the inspectable, getName() would conflict with Configurable::getName() too often More...

virtual const inspectableList &	getInspectables () const
	Returns the list containing all inspectable children. More...

Public Attributes
double	eps
	learning rate More...

Protected Attributes
std::vector< Layer >	layers

std::vector< matrix::Matrix >	weights

std::vector< matrix::Matrix >	bias

std::vector< matrix::Matrix >	smallids

bool	useBypass

matrix::Matrix	bypassWeights

bool	someInternalParams

matrix::Matrix	input

std::vector< matrix::Matrix >	ys

std::vector< matrix::Matrix >	zs

double	lambda

bool	initialised

Protected Attributes inherited from Inspectable
iparamkey	name

iparampairlist	mapOfValues

imatrixpairlist	mapOfMatrices

infoLinesList	infoLineStringList

Additional Inherited Members
Public Types inherited from Configurable
typedef std::string	paramkey

typedef std::string	paramdescr

typedef double	paramval

typedef std::list< std::pair < paramkey, paramval > >	paramlist

typedef std::map< paramkey, paramval * >	parammap

typedef bool	parambool

typedef std::list< std::pair < paramkey, parambool > >	paramboollist

typedef std::map< paramkey, parambool * >	paramboolmap

typedef int	paramint

typedef std::list< std::pair < paramkey, paramint > >	paramintlist

typedef std::map< paramkey, paramint * >	paramintmap

typedef std::map< paramkey, paramdescr >	paramdescrmap

typedef std::pair< paramval, paramval >	paramvalBounds

typedef std::map< paramkey, paramvalBounds >	paramvalBoundsMap

typedef std::pair< paramint, paramint >	paramintBounds

typedef std::map< paramkey, paramintBounds >	paramintBoundsMap

typedef std::pair< paramkey, paramval * >	paramvalpair

typedef std::pair< paramkey, parambool * >	paramboolpair

typedef std::pair< paramkey, paramint * >	paramintpair

typedef std::vector < Configurable * >	configurableList

Public Types inherited from BackCaller
typedef unsigned long	CallbackableType

Public Types inherited from Inspectable
typedef std::string	iparamkey

typedef double	iparamval

typedef std::pair< iparamkey, iparamval const * >	iparampair

typedef std::pair< iparamkey, std::pair< const matrix::Matrix *, bool > >	imatrixpair

typedef std::list< iparamkey >	iparamkeylist

typedef std::list< std::string >	infoLinesList

typedef std::list< iparamval >	iparamvallist

typedef std::list< iparamval const * >	iparamvalptrlist

typedef std::list< iparampair >	iparampairlist

typedef std::list< imatrixpair >	imatrixpairlist

typedef struct Inspectable::ILayer	ILayer

typedef struct Inspectable::IConnection	IConnection

typedef std::list< ILayer >	ilayerlist

typedef std::list< IConnection >	iconnectionlist

typedef std::list< const Inspectable * >	inspectableList

Static Public Member Functions inherited from FeedForwardNN
static double	linear (double z)

static double	dlinear (double)

static double	invlinear (double z, double xsi)

static double	tanh (double z)

static double	dtanh (double z)

static double	invtanh (double z, double xsi)

static double	tanhc (double z)

static double	dtanhc (double z)

static double	tanhr (double z)

static double	dtanhr (double z)

static double	sigmoid (double z)

static double	dsigmoid (double z)

static double	invsigmoid (double z, double xsi)

Static Public Attributes inherited from Configurable
static const CallbackableType	CALLBACK_CONFIGURABLE_CHANGED = 11

Static Public Attributes inherited from BackCaller
static const CallbackableType	DEFAULT_CALLBACKABLE_TYPE = 0
	This is the default Callbackable type. More...

Protected Member Functions inherited from Configurable
void	copyParameters (const Configurable &, bool traverseChildren=true)
	copies the internal params of the given configurable More...

void	printdescr (FILE f, const char prefix, const paramkey &key, int columns, int indent) const

Detailed Description

multi layer neural network with configurable activation functions

Constructor & Destructor Documentation

MultiLayerFFNN	(	double	eps,
		const std::vector< Layer > &	layers,
		bool	useBypass = `false`,
		bool	someInternalParams = `true`
	)

Parameters

eps	learning rate
layers	Layer description (the input layer is not specified (always linear))
useBypass	if true, then a connection from input to output layer is included
someInternalParams	if true then only a few parameters are send to plotting

virtual ~MultiLayerFFNN ( )

inlinevirtual

Member Function Documentation

void damp ( double damping )

virtual

damps the weights and the biases by multiplying (1-damping)

Implements FeedForwardNN.

Reimplemented in Elman.

virtual const matrix::Matrix& getBias ( unsigned int of_layer ) const

inlinevirtual

Note: layers 0 is the first hidden layer.

virtual matrix::Matrix& getBias ( unsigned int of_layer )

inlinevirtual

Note: layers 0 is the first hidden layer.

virtual unsigned int getInputDim ( ) const

inlinevirtual

returns the number of input neurons

Implements AbstractModel.

Inspectable::iparamkeylist getInternalParamNames ( ) const

virtual

The list of the names of all internal parameters given by getInternalParams().

The naming convention is "v[i]" for vectors and "A[i][j]" for matrices, where i, j start at 0.

Returns: : list of keys

Reimplemented from Inspectable.

Reimplemented in Elman.

Inspectable::iparamvallist getInternalParams ( ) const

virtual

Returns: : list of values

Reimplemented from Inspectable.

Reimplemented in Elman.

virtual const Layer& getLayer ( unsigned int layer ) const

inlinevirtual

layers 0 is the first hidden layer

virtual Layer& getLayer ( unsigned int layer )

inlinevirtual

layers 0 is the first hidden layer

virtual unsigned int getLayerNum ( ) const

inlinevirtual

virtual const matrix::Matrix& getLayerOutput ( unsigned int layer ) const

inlinevirtual

returns activation of the given layer. Layer 0 is the first hidden layer

virtual unsigned int getOutputDim ( ) const

inlinevirtual

returns the number of output neurons

Implements AbstractModel.

Inspectable::iconnectionlist getStructuralConnections ( ) const

virtual

Specifies which parameter matrix forms a connection between layers (in terms of a neural network) The orderning is not important.

Returns: : list of layer names with dimension

Reimplemented from Inspectable.

Reimplemented in Elman.

Inspectable::ilayerlist getStructuralLayers ( ) const

virtual

Specifies which parameter vector forms a structural layer (in terms of a neural network) The ordering is important.

The first entry is the input layer and so on.

Returns: : list of layer names with dimension

Reimplemented from Inspectable.

Reimplemented in Elman.

virtual const matrix::Matrix& getWeights ( unsigned int to_layer ) const

inlinevirtual

weight matrix 0 connects input with the first hidden layer

virtual matrix::Matrix& getWeights ( unsigned int to_layer )

inlinevirtual

weight matrix 0 connects input with the first hidden layer

void init	(	unsigned int	inputDim,
		unsigned int	outputDim,
		double	unit_map = `0.0`,
		RandGen *	randGen = `0`
	)

virtual

initialisation of the network with the given number of input and output units.

The dimensionality of the ouputlayer is automatically adjusted.

Parameters

unit_map	defines the approximate response of the network after initialisation (if unit_map=1 the weights are unit matrices).
randGen	pointer to random generator, if 0 an new one is used

Implements AbstractModel.

Reimplemented in Elman.

const Matrix inversion	(	const matrix::Matrix &	input,
		const matrix::Matrix &	xsi
	)		const

virtual

calculates the input shift v to a given output shift xsi via pseudo inversion.

$o+\xi = \psi(i+v)$

The result is a vector of dimension inputdim. ATTENTION: input is ignored! use process before!

Implements InvertableModel.

const Matrix learn	(	const matrix::Matrix &	input,
		const matrix::Matrix &	nom_output,
		double	learnRateFactor = `1`
	)

virtual

performs learning and returns the network output before learning (process should be called before)

Implements AbstractModel.

Reimplemented in Elman.

const Matrix process ( const matrix::Matrix & input )

virtual

passive processing of the input

Implements AbstractModel.

Reimplemented in Elman.

const Matrix response ( const matrix::Matrix & input ) const

virtual

response matrix of neural network at given input

$J_ij = \frac{\partial y_i}{\partial x_j}$

$J = G_n' W_n G_{n-1}' W_{n-1} ... G_1' W_1$

with $W_n$ is the weight matrix of layer n and $ G'$ is a diagonal matrix with $ G'_ii = g'_i $ as values on the diagonal. ATTENTION: input is ignored! use process before!

Implements InvertableModel.

bool restore ( FILE * f )

virtual

restores the layer binary from file stream

Implements Storeable.

std::vector< ActivationFunction > setActivationFunction ( ActivationFunction actfun )

virtual

sets the activation function (and derivative and inversion too) for ALL layers!

Parameters

actfun the activation function to be used

Returns: the activation functions which where used until now

void setActivationFunctions ( std::vector< ActivationFunction > actfunList )

virtual

sets the activation functions (and derivative and inversion too) for all layers.

Note: : normally you call setActivationFunction() first and get a list of the used activation functions, which are set back with this function

Parameters

actfunList the list of actfuns to be used

virtual void setSomeInternalParams ( bool someInternalParams )

inlinevirtual

bool store ( FILE * f ) const

virtual

stores the layer binary into file stream

Implements Storeable.

bool write ( FILE * f ) const

writes the layer ASCII into file stream (not in the storable interface)

Member Data Documentation

std::vector<matrix::Matrix> bias

protected

matrix::Matrix bypassWeights

protected

double eps

learning rate

bool initialised

protected

matrix::Matrix input

protected

double lambda

protected

std::vector<Layer> layers

protected

std::vector<matrix::Matrix> smallids

protected

bool someInternalParams

protected

bool useBypass

protected

std::vector<matrix::Matrix> weights

protected

std::vector<matrix::Matrix> ys

protected

std::vector<matrix::Matrix> zs

protected

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

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation