WeightMonitor.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 WEIGHTMONITOR_H_
#define WEIGHTMONITOR_H_

#include "auryn_definitions.h"
#include "AurynVector.h"
#include "Monitor.h"
#include "System.h"
#include "SparseConnection.h"
#include <fstream>
#include <iomanip>

namespace auryn {


enum RecordingMode { 
        SINGLE, 
        DATARANGE, 
        ELEMENTLIST, 
        GROUPS 
};

enum PatternMode { ALLTOALL, ASSEMBLIES_ONLY};

class WeightMonitor : protected Monitor
{
protected:
        SparseConnection * src;
        ForwardMatrix * mat;
        RecordingMode recordingmode;
        NeuronID elem_i;
        NeuronID elem_j;
        AurynTime ssize;
        std::vector<AurynLong> * element_list;
        std::vector<NeuronID> group_indices;
        void init(SparseConnection * source, NeuronID i, NeuronID j, string filename, AurynTime interval);

        void record_single_synapses();
        void record_synapse_groups();

        std::vector<type_pattern> * load_patfile( string filename, unsigned int maxpat );
        
public:
        WeightMonitor(SparseConnection * source, string filename, AurynDouble interval=10.0);

        WeightMonitor(SparseConnection * source, ForwardMatrix * m, string filename, AurynDouble interval=10.0);

        WeightMonitor(SparseConnection * source, NeuronID i, NeuronID j, string filename, AurynDouble interval=10.0, RecordingMode mode = SINGLE, StateID z = 0);

        virtual ~WeightMonitor();

        void execute();

        void set_mat(ForwardMatrix * m);

        void add_to_list_by_data_index( AurynLong index, StateID z = 0 );

        void add_to_list( AurynWeight * ptr );

        void add_to_list( NeuronID i, NeuronID j, StateID z = 0 );

        void add_to_list( std::vector<neuron_pair> vec , string label = "");
        
        void add_equally_spaced( NeuronID number, NeuronID z=0 );

        void load_pattern_connections(string filename, unsigned int maxcon = 5, unsigned int maxpat = 10, PatternMode patmod = ALLTOALL);
        void load_pattern_connections(string filename_pre, string filename_post, unsigned int maxcon = 5, unsigned int maxpat = 10, PatternMode patmod = ALLTOALL);

        void load_data_range(AurynLong i, AurynLong j);
};

} 

#endif /*WEIGHTMONITOR_H_*/