zeus::TSynapse Class Reference

#include <Neuron.hpp>

List of all members.

Public Types
enum	EGrowMethod { etAllwaysGrow = 0, etKeepSign = 1 }
Public Member Functions
	TSynapse (TNeuron &rPostNeuron, Float fWeight=0, EGrowMethod eGrowMethod=etAllwaysGrow)
bool	equals (const TSynapse &rSynapse) const
TNeuron &	getPostNeuron ()
const TNeuron &	getPostNeuronConst () const
Float	getWeight () const
EGrowMethod	getGrowMethod () const
void	grow (Float fGrowValue)
void	setWeight (Float fWeight)
void	setGrowMethod (EGrowMethod eMethod)
bool	operator== (const TSynapse &rSynapse) const
bool	operator!= (const TSynapse &rSynapse) const
Protected Member Functions
virtual	~TSynapse ()

---

Detailed Description

Synapse class

---

Member Enumeration Documentation

enum zeus::TSynapse::EGrowMethod

Type of growing the weight

Enumerator:

etAllwaysGrow
etKeepSign

---

Constructor & Destructor Documentation

zeus::TSynapse::TSynapse	(	TNeuron &	rPostNeuron,
		Float	fWeight = 0,
		EGrowMethod	eGrowMethod = etAllwaysGrow
	)		[inline]

Creates a synapse

Parameters:

rPostNeuron	: target neuron
fWeight	: weight of the synapse
eGrowMethod	: growing method

Creates a synapse

Parameters:

rPostNeuron	: target neuron
fWeight	: weight of the synapse
etGrowMethod	: growing method

virtual zeus::TSynapse::~TSynapse

(

)

[inline, protected, virtual]

destroys the synapse

---

Member Function Documentation

bool zeus::TSynapse::equals

(

const TSynapse &

rSynapse )

const [inline]

checks if two synapses are equal

EGrowMethod zeus::TSynapse::getGrowMethod

(

)

const [inline]

gets the grow method of the synapse

TNeuron& zeus::TSynapse::getPostNeuron

(

)

[inline]

returns the post neuron

const TNeuron& zeus::TSynapse::getPostNeuronConst

(

)

const [inline]

returns the post neuron

Float zeus::TSynapse::getWeight

(

)

const [inline]

gets the weight of the synapse

void zeus::TSynapse::grow

(

Float

fGrowValue )

[inline]

Grows the weight of the synapse

bool zeus::TSynapse::operator!=

(

const TSynapse &

rSynapse )

const [inline]

checks if two synapses are equal

bool zeus::TSynapse::operator==

(

const TSynapse &

rSynapse )

const [inline]

checks if two synapses are equal

void zeus::TSynapse::setGrowMethod

(

EGrowMethod

eMethod )

[inline]

set the grow method of the synapse

void zeus::TSynapse::setWeight

(

Float

fWeight )

[inline]

sets the weight of the synapse

---

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

• Neuron.hpp