network_base.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_CORE_NETWORK_BASE_HPP
#define CYPRESS_CORE_NETWORK_BASE_HPP

#include <memory>
#include <string>
#include <unordered_set>
#include <vector>

#include <cypress/core/connector.hpp>
#include <cypress/core/data.hpp>
#include <cypress/core/neurons_base.hpp>
#include <cypress/core/types.hpp>
#include <cypress/util/json.hpp>

namespace cypress {

/*
 * Forward declarations
 */
namespace internal {
class NetworkData;
}

class Backend;
class NetworkBase;
class PopulationBase;
class PopulationViewBase;
class NeuronBase;
class Logger;

template <typename Impl, typename Accessor>
class PopulationMixin;

template <typename Impl, typename Accessor, typename Params, typename Signals>
class DataMixin;

template <typename Impl, typename Accessor>
class ConnectableMixin;

struct NetworkRuntime {
    Real total;

    Real sim;

    Real initialize;

    Real finalize;

    Real sim_pure;

    Real duration = 0;
};

class NetworkBase {
private:
    std::shared_ptr<internal::NetworkData> m_impl;

protected:
    template <typename Impl, typename Accessor>
    friend class PopulationMixin;

    template <typename Impl, typename Accessor, typename Params,
              typename Signals>
    friend class DataMixin;

    template <typename Impl, typename Accessor>
    friend class ConnectableMixin;

    void connect(PopulationIndex pid_src, NeuronIndex nid_src0,
                 NeuronIndex nid_src1, PopulationIndex pid_tar,
                 NeuronIndex nid_tar0, NeuronIndex nid_tar1,
                 std::unique_ptr<Connector> connector, const char *name = "");

    PopulationIndex create_population_index(size_t size, const NeuronType &type,
                                            const NeuronParameters &params,
                                            const NeuronSignals &signals,
                                            const std::string &name);

public:
    NetworkBase();

    NetworkBase(std::shared_ptr<internal::NetworkData> impl) : m_impl(impl) {}

    ~NetworkBase();

    Logger &logger() const;

    void logger(Logger &logger);

    std::shared_ptr<PopulationData> population_data(PopulationIndex pid);

    std::shared_ptr<const PopulationData> population_data(
        PopulationIndex pid) const;

    bool operator==(const NetworkBase &o) const { return m_impl == o.m_impl; }

    bool operator!=(const NetworkBase &o) const { return m_impl != o.m_impl; }

    NetworkBase clone() const;

    size_t population_count() const;

    size_t population_count(const NeuronType &type) const;

    template <typename T>
    size_t population_count() const
    {
        return population_count(T::inst());
    }

    size_t neuron_count() const;

    size_t neuron_count(const NeuronType &type) const;

    template <typename T>
    size_t neuron_count() const
    {
        return neuron_count(T::inst());
    }

    PopulationBase population(PopulationIndex pid);

    const PopulationBase population(PopulationIndex pid) const;

    PopulationBase operator[](PopulationIndex pid);

    const PopulationBase operator[](PopulationIndex pid) const;

    const std::vector<PopulationBase> populations(
        const std::string &name = std::string(),
        const NeuronType &type = NullNeuron::inst()) const;

    const std::vector<PopulationBase> populations(const NeuronType &type) const;

    PopulationBase population(const std::string &name = std::string());

    const std::vector<ConnectionDescriptor> &connections() const;
    
    const ConnectionDescriptor &connection(std::string name) const;
    
    
    void update_connection(std::unique_ptr<Connector> connector, const char *name);

    static std::unique_ptr<Backend> make_backend(std::string backend_id,
                                                 int argc = 0,
                                                 const char *argv[] = nullptr,
                                                 Json setup = Json());

    bool use_lossy_trafos() const;

    void use_lossy_trafos(bool use_lossy) const;

    const std::unordered_set<std::string> &disabled_trafo_ids() const;

    std::unordered_set<std::string> &disabled_trafo_ids();

    void run(const Backend &backend, Real duration = 0.0);

    void run(const std::string &backend_id, Real duration = 0.0, int argc = 0,
             const char *argv[] = nullptr);

    Real duration() const;

    NetworkRuntime runtime() const;

    void runtime(const NetworkRuntime &runtime);
};
}

#endif /* CYPRESS_CORE_NETWORK_BASE_HPP */