Connection.h

Go to the documentation of this file.

/* 
* Copyright 2014-2018 Friedemann Zenke
*
* This file is part of Auryn, a simulation package for plastic
* spiking neural networks.
* 
* Auryn 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.
* 
* Auryn 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 Auryn.  If not, see <http://www.gnu.org/licenses/>.
*
* If you are using Auryn or parts of it for your work please cite:
* Zenke, F. and Gerstner, W., 2014. Limits to high-speed simulations 
* of spiking neural networks using general-purpose computers. 
* Front Neuroinform 8, 76. doi: 10.3389/fninf.2014.00076
*/

#ifndef CONNECTION_H_
#define CONNECTION_H_


#include <string>

#include "auryn_definitions.h"
#include "AurynVector.h"
#include "SpikingGroup.h"
#include "NeuronGroup.h"
#include "Trace.h"

namespace auryn {

class System;

class Connection 
{
private:
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive & ar, const unsigned int version)
        {
                virtual_serialize(ar, version);
        }


        NeuronID m_rows,n_cols;
        std::string connection_name;

protected:
        virtual void virtual_serialize(boost::archive::binary_oarchive & ar, const unsigned int version ) 
        {
                ar & m_rows & n_cols & connection_name;
        }

        virtual void virtual_serialize(boost::archive::binary_iarchive & ar, const unsigned int version ) 
        {
                ar & m_rows & n_cols & connection_name;
        }

        TransmitterType trans;

        AurynStateVector * target_state_vector;

        AurynFloat * target;

        NeuronID number_of_spike_attributes;

        NeuronID spike_attribute_offset;

        void init(TransmitterType transmitter=GLUT);

public:
        SpikingGroup * src;

        NeuronGroup * dst;

        Connection();
        Connection(NeuronID rows, NeuronID cols);
        Connection(SpikingGroup * source, NeuronGroup * destination, TransmitterType transmitter=GLUT, std::string name="Connection");
        virtual ~Connection();

        void set_size(NeuronID i, NeuronID j);

        void set_name(std::string name);

        std::string get_name();

        std::string get_file_name();

        std::string get_log_name();

        AurynStateVector * get_target_vector();

        NeuronID get_m_rows();

        NeuronID get_n_cols();

        TransmitterType get_transmitter();

        void set_target(AurynWeight * ptr);

        void set_target(AurynStateVector * ptr);

        void set_receptor(AurynStateVector * ptr);

        void set_transmitter(AurynStateVector * ptr);

        void set_transmitter(TransmitterType transmitter);

        void set_receptor(string state_name);

        void set_target(string state_name);

        void set_transmitter(string state_name);

        void set_source(SpikingGroup * source);

        SpikingGroup * get_source();

        void set_destination(NeuronGroup * source);

        NeuronGroup * get_destination();

        /* Purely virtual functions */
        virtual AurynWeight get(NeuronID i, NeuronID j) = 0;

        virtual AurynWeight * get_ptr(NeuronID i, NeuronID j) = 0;

        virtual AurynWeight get_data(NeuronID i) = 0;

        virtual void set(NeuronID i, NeuronID j, AurynWeight value) = 0;

        virtual AurynLong get_nonzero() = 0;

        virtual void finalize() = 0;

        virtual void propagate() = 0;

        virtual void evolve();

        void conditional_propagate();


        Trace * get_pre_trace(const AurynDouble tau);

        Trace * get_post_trace(const AurynDouble tau);

        Trace * get_post_state_trace(const string state_name, const AurynDouble tau, const AurynDouble jump_size=0.0);

        virtual void stats(AurynDouble &mean, AurynDouble &std, StateID zid = 0) = 0;

        virtual bool write_to_file(std::string filename) = 0;

        virtual bool load_from_file(std::string filename) = 0;

        void transmit(const NeuronID id, const AurynWeight amount);

        void targeted_transmit(SpikingGroup * target_group, AurynStateVector * target_state, const NeuronID id, const AurynWeight amount);

        void safe_transmit(NeuronID id, AurynWeight amount);

        SpikeContainer * get_pre_spikes();

        SpikeContainer * get_post_spikes();

        void add_number_of_spike_attributes(int x);

        AurynFloat get_spike_attribute(const NeuronID i, const int attribute_id=0);
};

BOOST_SERIALIZATION_ASSUME_ABSTRACT(Connection)


inline void Connection::targeted_transmit(SpikingGroup * target_group, AurynStateVector * target_state, const NeuronID id, const AurynWeight amount) 
{
        const NeuronID localid = target_group->global2rank(id);
        target_state->data[localid]+=amount;
}

inline void Connection::transmit(const NeuronID id, const AurynWeight amount) 
{
        targeted_transmit(dst, target_state_vector, id, amount);
}

}

#endif /*CONNECTION_H_*/