creators.h

Go to the documentation of this file.

 
#pragma once
 
#include <knp/core/projection.h>
 
#include <exception>
#include <functional>
#include <optional>
#include <random>
#include <tuple>
 
#include "synapse_generators.h"
#include "synapse_parameters_generators.h"
 
namespace knp::framework::projection
{
 
namespace creators
{
 
template <typename SynapseType>
[[nodiscard]] knp::core::Projection<SynapseType> all_to_all(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid, size_t presynaptic_pop_size,
    size_t postsynaptic_pop_size,
    parameters_generators::SynGen2ParamsType<SynapseType> syn_gen =
        parameters_generators::default_synapse_gen<SynapseType>)
{
    return knp::core::Projection<SynapseType>(
        presynaptic_uid, postsynaptic_uid,
        synapse_generators::all_to_all<SynapseType>(presynaptic_pop_size, postsynaptic_pop_size, syn_gen),
        presynaptic_pop_size * postsynaptic_pop_size);
}
 
 
template <typename SynapseType>
[[nodiscard]] knp::core::Projection<SynapseType> one_to_one(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid, size_t population_size,
    parameters_generators::SynGen1ParamType<SynapseType> syn_gen =
        std::bind(parameters_generators::default_synapse_gen<SynapseType>, std::placeholders::_1, 0))
{
    return knp::core::Projection<SynapseType>(
        presynaptic_uid, postsynaptic_uid, synapse_generators::one_to_one<SynapseType>(population_size, syn_gen),
        population_size);
}
 
 
template <typename SynapseType, template <typename...> class Container>
[[nodiscard]] knp::core::Projection<SynapseType> from_container(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid,
    const Container<typename core::Projection<SynapseType>::Synapse> &container)
{
    return typename knp::core::Projection<SynapseType>(
        presynaptic_uid, postsynaptic_uid, synapse_generators::from_container<SynapseType, Container>(container),
        container.size());
}
 
 
template <typename SynapseType, template <typename, typename, typename...> class Map>
[[nodiscard]] knp::core::Projection<SynapseType> from_map(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid,
    const Map<typename std::tuple<size_t, size_t>, typename knp::core::Projection<SynapseType>::SynapseParameters>
        &synapses_map)
{
    return knp::core::Projection<SynapseType>(
        presynaptic_uid, postsynaptic_uid, synapse_generators::FromMap<SynapseType, Map>(synapses_map),
        synapses_map.size());
}
 
 
template <typename SynapseType>
[[nodiscard]] knp::core::Projection<SynapseType> fixed_probability(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid, size_t presynaptic_pop_size,
    size_t postsynaptic_pop_size, double connection_probability,
    parameters_generators::SynGen2ParamsType<SynapseType> syn_gen =
        parameters_generators::default_synapse_gen<SynapseType>)
{
    const auto proj_size = presynaptic_pop_size * postsynaptic_pop_size;
    auto fp = synapse_generators::FixedProbability<SynapseType>{
        presynaptic_pop_size, postsynaptic_pop_size, connection_probability, syn_gen};
 
    return knp::core::Projection<SynapseType>(presynaptic_uid, postsynaptic_uid, fp, proj_size);
}
 
 
template <typename SynapseType>
[[nodiscard]] knp::core::Projection<SynapseType> index_based(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid, size_t presynaptic_pop_size,
    size_t postsynaptic_pop_size, parameters_generators::SynGenOptional2ParamsType<SynapseType> syn_gen)
{
    const auto proj_size = presynaptic_pop_size * postsynaptic_pop_size;
 
    return knp::core::Projection<SynapseType>(
        presynaptic_uid, postsynaptic_uid,
        synapse_generators::index_based<SynapseType>(presynaptic_pop_size, postsynaptic_pop_size, syn_gen), proj_size);
}
 
 
template <typename SynapseType>
[[nodiscard]] knp::core::Projection<SynapseType> fixed_number_post(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid, size_t presynaptic_pop_size,
    size_t postsynaptic_pop_size, size_t neurons_count,
    parameters_generators::SynGen2ParamsType<SynapseType> syn_gen =
        parameters_generators::default_synapse_gen<SynapseType>)
{
    const auto proj_size = presynaptic_pop_size * neurons_count;
 
    return knp::core::Projection<SynapseType>(
        presynaptic_uid, postsynaptic_uid,
        synapse_generators::FixedNumberPost<SynapseType>(presynaptic_pop_size, postsynaptic_pop_size, syn_gen),
        proj_size);
}
 
 
template <typename SynapseType>
[[nodiscard]] knp::core::Projection<SynapseType> fixed_number_pre(
    const knp::core::UID &presynaptic_uid, const knp::core::UID &postsynaptic_uid, size_t presynaptic_pop_size,
    size_t postsynaptic_pop_size, size_t neurons_count,
    parameters_generators::SynGen2ParamsType<SynapseType> syn_gen =
        parameters_generators::default_synapse_gen<SynapseType>)
{
    const auto proj_size = postsynaptic_pop_size * neurons_count;
 
    return knp::core::Projection<SynapseType>(
        presynaptic_uid, postsynaptic_uid,
        synapse_generators::FixedNumberPre<SynapseType>(presynaptic_pop_size, postsynaptic_pop_size, syn_gen),
        proj_size);
}
 
 
template <typename DestinationSynapseType, typename SourceSynapseType>
[[nodiscard]] knp::core::Projection<DestinationSynapseType> clone_projection(
    const knp::core::Projection<SourceSynapseType> &source_proj,
    parameters_generators::SynGen1ParamType<DestinationSynapseType> syn_gen =
        parameters_generators::default_synapse_gen<DestinationSynapseType>,
    const std::optional<knp::core::UID> &presynaptic_uid = std::nullopt,
    const std::optional<knp::core::UID> &postsynaptic_uid = std::nullopt)
{
    return knp::core::Projection<DestinationSynapseType>(
        presynaptic_uid.value_or(source_proj.get_presynaptic()),
        postsynaptic_uid.value_or(source_proj.get_postsynaptic()),
        synapse_generators::clone_projection<DestinationSynapseType, SourceSynapseType>(source_proj, syn_gen),
        source_proj.size());
}
 
}  // namespace creators
 
}  // namespace knp::framework::projection