AbstractNeuralDynamics.hpp

Go to the documentation of this file.

// Copyright (c) 2005 - 2014 Marc de Kamps
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//    * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software
//      without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
// USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//      If you use this software in work leading to a scientific publication, you should include a reference there to
//      the 'currently valid reference', which can be found at http://miind.sourceforge.net

#ifndef _CODE_LIBS_GEOMLIB_ABSTRACTNEURALDYNAMICS_H_
#define _CODE_LIBS_GEOMLIB_ABSTRACTNEURALDYNAMICS_H_

#include <vector>
#include <MPILib/include/BasicDefinitions.hpp>
#include "CurrentCompensationParameter.hpp"
#include "OdeParameter.hpp"

namespace GeomLib {



class AbstractNeuralDynamics {
    public:

        AbstractNeuralDynamics
        (
            const OdeParameter&,        
            const CurrentCompensationParameter& = CurrentCompensationParameter(0.,0.) 
        );

        virtual ~AbstractNeuralDynamics() = 0;

        virtual Potential
            EvolvePotential
            (
                Potential,
                MPILib::Time
            ) const = 0;

        virtual AbstractNeuralDynamics* Clone() const  = 0;

        const OdeParameter& Par() const {return _par; }

        virtual MPILib::Time TStep() const = 0;

        virtual MPILib::Time TPeriod() const = 0;

                virtual std::vector<Potential> InterpretationArray() const = 0;

        const CurrentCompensationParameter& ParCur() const { return _par_current; }

    protected:

        const OdeParameter _par;

        const CurrentCompensationParameter _par_current;
    };
}


#endif /* ABSTRACTNEURALDYNAMICS_H_ */