nmpi.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_NMPI_HPP
#define CYPRESS_BACKEND_NMPI_HPP

#include <memory>
#include <stdexcept>
#include <string>
#include <vector>

#include <cypress/backend/pynn/pynn.hpp>
#include <cypress/core/backend.hpp>

namespace cypress {

// Forward declarations
class PyNN_;

class NMPI : public Backend {
private:
    std::unique_ptr<Backend> m_pynn;

    void do_run(NetworkBase &network, Real duration) const override;

    void init(
        std::unique_ptr<Backend> pynn, int &argc, const char *argv[],
        const std::vector<std::string> &files = std::vector<std::string>(),
        bool scan_args = true);

    void init_bs(
        const std::string &bs_backend, int &argc, const char *argv[],
        Json setup,
        const std::vector<std::string> &files = std::vector<std::string>(),
        bool scan_args = true);

public:
    class NoNMPIPlatform : public std::runtime_error {
    public:
        using std::runtime_error::runtime_error;
    };

    class InvalidCommandLine : public std::runtime_error {
    public:
        using std::runtime_error::runtime_error;
    };

    NMPI(std::unique_ptr<Backend> pynn, int &argc, const char *argv[],
         const std::vector<std::string> &files = std::vector<std::string>(),
         bool scan_args = true);

    NMPI(const std::string &pynn_backend, int &argc, const char *argv[],
         const std::vector<std::string> &files = std::vector<std::string>(),
         bool scan_args = true);

    ~NMPI() override;

    std::unordered_set<const NeuronType *> supported_neuron_types()
        const override;

    std::string name() const override;

    static bool check_args(int argc, const char *argv[]);
};
}  // namespace cypress

#endif /* CYPRESS_BACKEND_NMPI_HPP */