NumModel2LayerNetBC - Two layer feed forward neural network implementation class

User Documentation

Centre for Vision, Speech & Signal Processing

Comments:
Simple neural network class. The network constructed is fully connected, feed-forward and 2-layer (i.e. inputs, hidden-layer, output-layer). At present only the back-propagation training algorithm has been implemented. More algorithms will follow.

Parent Classes:

NumModelBC

Variables:

Methods:

NumModel2LayerNetBC(): Constructs empty instance
NumModel2LayerNetBC(const WeightMatrixC & flw,const NetVectorC & flb,const WeightMatrixC & slw,const NetVectorC & slb): Constructs from matrices etc
NumModel2LayerNetBC(istream & in): Construct from the input stream
NumModel2LayerNetBC(const NumModel2LayerNetBC & in): Constructs a new network from an old network
BodyRefCounterVC & Copy() const: Make a copy of network
const NumModel2LayerNetBC & operator=(const NumModel2LayerNetBC & net): Assignment of big object

Methods required from NumModelC
VectorC Evaluate(const VectorC & input) const: Evaluates Y = f(x)
void Fit(const NumVVDataSetC & data): Train the network
BooleanT Save(ostream & out) const: save the model to stream
void Initialise(const NumVVDataSetC & traindata): Initialise the network structure on a dataset

#include "amma/Num/NumFuncB.hh"

BodyRefCounterVC & Copy() const: Makes a deep copy and is virtual
As the copy constructor but is virtual so can be called from a base class reference.

#include "amma/DP/Process.hh"

VectorC Apply(const VectorC &): Apply operation.
IntT ApplyArray(const SArray1dC<VectorC> & in,SArray1dC<VectorC> & out): Apply operation to an array of elements.
returns the number of elements processed.
BooleanT Save(ostream & out) const: Save to ostream.
const type_info & InputType() const: Get input type.
const type_info & OutputType() const: Get input type.
BooleanT Save(ostream & out) const: Save to ostream.
const type_info & InputType() const: Get input type.
const type_info & OutputType() const: Get input type.
ProcTypeT OpType() const: Operation type lossy/lossless.
BooleanT IsStateless() const: Is operation stateless ?

#include "amma/DP/Entity.hh"

BooleanT Save(ostream & out) const: Save to ostream.
BodyRefCounterVC & Copy() const: Creat a copy of this object.

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Kieron Messer, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

NumModel2LayerNetBC

Two layer feed forward neural network implementation class

include	"amma/Num/NumModel2LayerNetB.hh"
User Level:	Default
Library:	NumModelNeuralNet
Example:	NetTest.cc
Section:	default.Kieron Messer
In Scope:	std

Methods required from NumModelC