Neuron.h

Go to the documentation of this file.

/************************************************************************
* Verve                                                                 *
* Copyright (C) 2004-2006                                               *
* Tyler Streeter  tylerstreeter@gmail.com                               *
* All rights reserved.                                                  *
* Web: http://verve-agents.sourceforge.net                              *
*                                                                       *
* This library is free software; you can redistribute it and/or         *
* modify it under the terms of EITHER:                                  *
*   (1) The GNU Lesser General Public License as published by the Free  *
*       Software Foundation; either version 2.1 of the License, or (at  *
*       your option) any later version. The text of the GNU Lesser      *
*       General Public License is included with this library in the     *
*       file license-LGPL.txt.                                          *
*   (2) The BSD-style license that is included with this library in     *
*       the file license-BSD.txt.                                       *
*                                                                       *
* This library is distributed in the hope that it will be useful,       *
* but WITHOUT ANY WARRANTY; without even the implied warranty of        *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the files    *
* license-LGPL.txt and license-BSD.txt for more details.                *
************************************************************************/

#ifndef VERVE_NEURON_H
#define VERVE_NEURON_H

#include "Globals.h"

namespace verve
{
        class Connection;

        class Neuron
        {
        public:
                VERVE_DECL Neuron(unsigned int id);

                VERVE_DECL virtual ~Neuron();

                VERVE_DECL virtual void VERVE_CALL resetShortTermMemory();

                VERVE_DECL virtual void VERVE_CALL setFiringRate(real value);

                VERVE_DECL virtual real VERVE_CALL getFiringRate()const;

                VERVE_DECL virtual void VERVE_CALL addToSynapticInputSum(real delta);

                VERVE_DECL virtual void VERVE_CALL updateFiringRateLinear();

                VERVE_DECL virtual void VERVE_CALL 
                        updateFiringRateLinearBoundedNegOneToOne();

                VERVE_DECL virtual void VERVE_CALL 
                        updateFiringRateLinearBoundedZeroToOne();

                VERVE_DECL virtual void VERVE_CALL updateFiringRateSigmoid();

                VERVE_DECL virtual void VERVE_CALL addDendrite(Connection* c);

                VERVE_DECL virtual unsigned int VERVE_CALL getNumDendrites()const;

                VERVE_DECL virtual Connection* VERVE_CALL getDendrite(unsigned int i);

                VERVE_DECL virtual void VERVE_CALL addAxon(Connection* c);

                VERVE_DECL virtual unsigned int VERVE_CALL getNumAxons()const;

                VERVE_DECL virtual Connection* VERVE_CALL getAxon(unsigned int i);

                VERVE_DECL virtual int VERVE_CALL getID()const;

                VERVE_DECL virtual void VERVE_CALL normalizeInputWeights();

        protected:
                unsigned int mID;

                real mFiringRate;

                real mSynapticInputSum;

                std::vector<Connection*> mDendrites;

                std::vector<Connection*> mAxons;
        };
}

#endif

---