connection_monitor.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014 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>
 *
 * CARLsim available from http://socsci.uci.edu/~jkrichma/CARLsim/
 * Ver 5/14/2015
 */

#ifndef _CONN_MON_H_
#define _CONN_MON_H_

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

class ConnectionMonitorCore; // forward declaration of implementation

class ConnectionMonitor {
 public:
    ConnectionMonitor(ConnectionMonitorCore* connMonCorePtr);

    ~ConnectionMonitor();

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

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

    short int getConnectId();

    int getFanIn(int neurPostId);

    int getFanOut(int neurPreId);

    double getMaxWeight(bool getCurrent=false);

    double getMinWeight(bool getCurrent=false);

    int getNumNeuronsPre();

    int getNumNeuronsPost();

    int getNumSynapses();

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

    int getNumWeightsInRange(double minValue, double maxValue);

    int getNumWeightsWithValue(double value);

    double getPercentWeightsInRange(double minValue, double maxValue);

    double getPercentWeightsWithValue(double value);


    double getPercentWeightsChanged(double minAbsChanged=1e-5);

    int64_t getTimeMsCurrentSnapshot();

    int64_t getTimeMsLastSnapshot();

    int64_t getTimeMsSinceLastSnapshot();

    double getTotalAbsWeightChange();

    void print();

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

    void setUpdateTimeIntervalSec(int intervalSec);

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

private:
    ConnectionMonitorCore* connMonCorePtr_;
};

#endif