RateFunctor.hpp

Go to the documentation of this file.

// Copyright (c) 2005 - 2009 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 cite
//      the 'currently valid reference', which can be found at http://miind.sourceforge.net


#ifndef MPILIB_ALGORITHMS_RATEFUNCTOR_HPP_
#define MPILIB_ALGORITHMS_RATEFUNCTOR_HPP_

#include <MPILib/include/AlgorithmInterface.hpp>
#include <MPILib/include/TypeDefinitions.hpp>

namespace MPILib {

    typedef MPILib::Rate (*RateFunction)(MPILib::Time);

    inline Rate Nul(Time){ return 0; }


    template <class WeightValue>
    class RateFunctor : public AlgorithmInterface<WeightValue>{
    public:


        RateFunctor(RateFunction);

        virtual ~RateFunctor(){}

        virtual RateFunctor* clone() const;


        virtual void configure(const SimulationRunParameter& simParam);


        virtual void evolveNodeState(const std::vector<Rate>& nodeVector,
                const std::vector<WeightValue>& weightVector, Time time);


        virtual MPILib::Time getCurrentTime() const;

        virtual MPILib::Rate getCurrentRate() const;


        virtual AlgorithmGrid getGrid(NodeId, bool b_state) const;


    private:

        RateFunction _function;
        MPILib::Time _current_time;
        MPILib::Rate _current_rate;

    }; // end of RateFunctor

    typedef RateFunctor<double> D_RateFunctor;

} // end of MPILib

#endif // include guard