zeus::TNeuron Class Reference

#include <Neuron.hpp>

List of all members.

Public Member Functions
	TNeuron (Uint uiID, Float fThreshold, Float fPotential)
	TNeuron ()
	TNeuron (const TNeuron &rNeuron)
TNeuron &	operator= (const TNeuron &rNeuron)
virtual	~TNeuron ()
void	connect (TNeuron &rPostNeuron, Float fWeight=0, TSynapse::EGrowMethod eGrowMethod=TSynapse::etAllwaysGrow)
bool	equals (const TNeuron &rNeuron) const
Int	getAxonSize () const
Int	getInputSize () const
Uint	getID () const
Float	getPotential () const
Float	getThreshold () const
bool	isActive () const
void	updateActivity ()
void	raisePotential (Float fValue)
void	resetPotential ()
void	setThreshold (Float fValue)
void	setActivity (bool bAct)
void	decreaseConnected ()
void	increaseConnected ()
TSynapse *	getSynapse (Int iIndex)
TSynapse *	operator[] (Int iIndex)
bool	operator== (const TNeuron &rNeuron) const
bool	operator!= (const TNeuron &rNeuron) const
Static Protected Attributes
static Uint	m_uiStaticNeuronIDCounter = 0

---

Detailed Description

This class implements a neuron

---

Constructor & Destructor Documentation

zeus::TNeuron::TNeuron	(	Uint	uiID,
		Float	fThreshold,
		Float	fPotential
	)		[inline]

Creates a neuron

zeus::TNeuron::TNeuron

(

)

[inline]

Creates a neuron

zeus::TNeuron::TNeuron

(

const TNeuron &

rNeuron )

[inline]

Copy constructor

virtual zeus::TNeuron::~TNeuron

(

)

[inline, virtual]

increases the connection numbers

---

Member Function Documentation

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

creates a synapse to an other neuron

void zeus::TNeuron::decreaseConnected

(

)

[inline]

decreases the connection numbers

bool zeus::TNeuron::equals

(

const TNeuron &

rNeuron )

const [inline]

Checks if two neurons are equal

Int zeus::TNeuron::getAxonSize

(

)

const [inline]

returns the number of synapses of the axon

Uint zeus::TNeuron::getID

(

)

const [inline]

Returns the ID of the neuron

Int zeus::TNeuron::getInputSize

(

)

const [inline]

returns the number of beeing connected from neurons

Float zeus::TNeuron::getPotential

(

)

const [inline]

returns the potetial of the neuron membrane

TSynapse* zeus::TNeuron::getSynapse

(

Int

iIndex )

[inline]

returns the indexed synapse

Float zeus::TNeuron::getThreshold

(

)

const [inline]

returns the threshold of the neuron membrane

void zeus::TNeuron::increaseConnected

(

)

[inline]

increases the connection numbers

bool zeus::TNeuron::isActive

(

)

const [inline]

checks if the neuron is active

bool zeus::TNeuron::operator!=

(

const TNeuron &

rNeuron )

const [inline]

Checks if two neurons are not equal

TNeuron& zeus::TNeuron::operator=

(

const TNeuron &

rNeuron )

[inline]

Assign operator

bool zeus::TNeuron::operator==

(

const TNeuron &

rNeuron )

const [inline]

Checks if two neurons are equal

TSynapse* zeus::TNeuron::operator[]

(

Int

iIndex )

[inline]

The index operator returns the indexed synapse

void zeus::TNeuron::raisePotential

(

Float

fValue )

[inline]

raises the potential. This method is needed to built the sum

void zeus::TNeuron::resetPotential

(

)

[inline]

set the potential back to zero.

void zeus::TNeuron::setActivity

(

bool

bAct )

[inline]

Activates the neuron

void zeus::TNeuron::setThreshold

(

Float

fValue )

[inline]

set the potential threshold of the membrane.

void zeus::TNeuron::updateActivity

(

)

[inline]

updates the activity of a neuron

---

Member Data Documentation

Uint TNeuron::m_uiStaticNeuronIDCounter = 0 [static, protected]

---

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

• Neuron.hpp
• NeuronalNetwork.cpp