connection_monitor_core.h

Go to the documentation of this file.

/* * Copyright (c) 2016 Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
*
* 3. The names of its contributors may not be used to endorse or promote
*    products derived from this software without specific prior written
*    permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* *********************************************************************************************** *
* CARLsim
* created by: (MDR) Micah Richert, (JN) Jayram M. Nageswaran
* maintained by:
* (MA) Mike Avery <averym@uci.edu>
* (MB) Michael Beyeler <mbeyeler@uci.edu>,
* (KDC) Kristofor Carlson <kdcarlso@uci.edu>
* (TSC) Ting-Shuo Chou <tingshuc@uci.edu>
* (HK) Hirak J Kashyap <kashyaph@uci.edu>
*
* CARLsim v1.0: JM, MDR
* CARLsim v2.0/v2.1/v2.2: JM, MDR, MA, MB, KDC
* CARLsim3: MB, KDC, TSC
* CARLsim4: TSC, HK
* CARLsim5: HK, JX, KC
* CARLsim6: LN, JX, KC, KW
*
* CARLsim available from http://socsci.uci.edu/~jkrichma/CARLsim/
* Ver 12/31/2016
*/
#ifndef _CONN_MON_CORE_H_
#define _CONN_MON_CORE_H_


#include <stdio.h>                  // FILE
#include <vector>                   // std::vector
#include <carlsim_definitions.h>    // ALL

class SNN; // forward declaration of SNN class


/*
 * \brief ConnectionMonitor private core implementation
 *
 * Naming convention for methods:
 * - getNum*:       a number metric, returns an int
 * - getTime*:      a time metric, returns long int
 * - getPercent*:   a percentage metric, returns a double
 * - get*:          all the others
 */
class ConnectionMonitorCore {
public: 
    ConnectionMonitorCore(SNN* snn, int monitorId, short int connId, int grpIdPre, int grpIdPost); 

    ~ConnectionMonitorCore();
    

    // +++++ PUBLIC METHODS: +++++++++++++++++++++++++++++++++++++++++++++++//

    std::vector< std::vector<float> > getWeights();

    std::vector< std::vector<float> > getPrevWeights();

    std::vector< std::vector<float> > calcWeightChanges();

    short int getConnectId() { return connId_; }

    FILE* getConnectFileId() { return connFileId_; }

    int getFanIn(int neurPostId);

    int getFanOut(int neurPreId);

    float getMaxWeight(bool getCurrent=false);

    float getMinWeight(bool getCurrent=false);


    int getMonitorId() { return monitorId_; }

    int getNumNeuronsPre() { return nNeurPre_; }

    int getNumNeuronsPost() { return nNeurPost_; }

    int getNumSynapses() { return nSynapses_; }

    int getNumWeightsChanged(double minAbsChanged=1e-5);

    int getNumWeightsInRange(double minVal, double maxVal);

    int getNumWeightsWithValue(double value);

    long int getTimeMsCurrentSnapshot() { return wtTime_; }

    long int getTimeMsLastSnapshot() { return wtTimeLast_; }

    long int getTimeMsSinceLastSnapshot() { return (wtTime_ - wtTimeLast_); }

    int getUpdateTimeIntervalSec() { return connFileTimeIntervalSec_; }

    double getTotalAbsWeightChange();

    void print();

    void printSparse(int neurPostId=ALL, int maxConn=100, int connPerLine=4, bool storeNewSnapshot=true);

    std::vector< std::vector<float> > takeSnapshot();


    // +++++ PUBLIC METHODS THAT SHOULD NOT BE EXPOSED TO INTERFACE +++++++++//

    void clear();

    void init();

    void updateWeight(int preId, int postId, float wt);

    bool updateTime(int simTimeMs);

    void setConnectFileId(FILE* connFileId);

    void setUpdateTimeIntervalSec(int intervalSec);

    void writeConnectFileSnapshot(int simTimeMs, std::vector< std::vector<float> > wts);
    
private:
    bool needToWriteSnapshot();

    void updateStoredWeights();
    
    void writeConnectFileHeader();

    SNN* snn_;                   
    int monitorId_;                 
    short int connId_;              
    int grpIdPre_;                  
    int grpIdPost_;                 
    int nNeurPre_;                  
    int nNeurPost_;                 
    int nSynapses_;                 

    float minWt_;                   
    float maxWt_;                   

    bool isPlastic_; 

    std::vector< std::vector<float> > wtMat_;      
    std::vector< std::vector<float> > wtMatLast_;  
    long long wtTime_;
    long long wtTimeLast_;
    long long wtTimeWrite_;

    bool needToInit_;               
    bool needToWriteFileHeader_;    

    FILE* connFileId_;              
    int connFileSignature_;         
    float connFileVersion_;         
    int connFileTimeIntervalSec_;   

    const FILE* fpInf_;             
    const FILE* fpErr_;             
    const FILE* fpDeb_;             
    const FILE* fpLog_;             
};

#endif