backend.hpp

Go to the documentation of this file.

/*
 *  Cypress -- C++ Spiking Neural Network Simulation Framework
 *  Copyright (C) 2016  Andreas Stöckel
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef CYPRESS_BACKEND_HPP
#define CYPRESS_BACKEND_HPP

#include <string>
#include <unordered_set>

#include <cypress/core/types.hpp>

namespace cypress {

/*
 * Forward declarations
 */
class NetworkBase;
class NeuronType;

class Backend {
protected:
    virtual void do_run(NetworkBase &network, Real duration) const = 0;

public:
    void run(NetworkBase &network, Real duration = 0.0) const;

    virtual std::unordered_set<const NeuronType *> supported_neuron_types()
        const = 0;

    virtual std::string name() const = 0;

    virtual ~Backend();
};
}

#endif /* CYPRESS_BACKEND_HPP */