SparseMsg.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment.
**           Copyright (C) 2003-2009 Upinder S. Bhalla. and NCBS
** It is made available under the terms of the
** GNU Lesser General Public License version 2.1
** See the file COPYING.LIB for the full notice.
**********************************************************************/

#ifndef _SPARSE_MSG_H
#define _SPARSE_MSG_H

#include "../randnum/RNG.h"

class SparseMsg: public Msg
{
    friend unsigned int Msg::initMsgManagers(); // for initializing Id.

public:

    SparseMsg( Element* e1, Element* e2, unsigned int msgIndex );
    ~SparseMsg();

    Eref firstTgt( const Eref& src ) const;

    void sources( vector< vector< Eref > >& v ) const;
    void targets( vector< vector< Eref > >& v ) const;

    unsigned int randomConnect( double probability );

    Id managerId() const;

    ObjId findOtherEnd( ObjId end ) const;

    Msg* copy( Id origSrc, Id newSrc, Id newTgt,
               FuncId fid, unsigned int b, unsigned int n ) const;

    void setMatrix( const SparseMatrix< unsigned int >& m );

    SparseMatrix< unsigned int >& getMatrix();

    // Uses default addToQ function.

    // Here we define the Element interface functions for SparseMsg
    void setRandomConnectivity( double probability, long seed );
    double getProbability() const;
    void setProbability( double value );

    vector< unsigned int > getMatrixEntry() const;
    vector< unsigned int > getColIndex() const;
    vector< unsigned int > getRowStart() const;

    unsigned long getSeed() const;
    void setSeed( unsigned long value );

    vector< unsigned int > getEntryPairs() const;
    void setEntryPairs( vector< unsigned int > entries );

    void setEntry( unsigned int row, unsigned int column,
                   unsigned int value );

    void unsetEntry( unsigned int row, unsigned int column );

    // Still need to implement array field gets.
    unsigned int getNumRows() const;
    unsigned int getNumColumns() const;
    unsigned int getNumEntries() const;
    void clear();
    void transpose();

    void pairFill( vector< unsigned int > src,
                   vector< unsigned int> dest );

    void tripletFill( vector< unsigned int > src,
                      vector< unsigned int> dest,
                      vector< unsigned int > field );

    void tripletFill1( vector< unsigned int > entries );

    void updateAfterFill();

    static unsigned int numMsg();
    static char* lookupMsg( unsigned int index );

    static const Cinfo* initCinfo();

private:
    SparseMatrix< unsigned int > matrix_;
    unsigned int numThreads_; // Number of threads to partition
    unsigned int nrows_; // The original size of the matrix.
    double p_;
    static Id managerId_; // The Element that manages Sparse Msgs.
    static vector< SparseMsg* > msg_;

    // RNG.
    unsigned long seed_;
    moose::MOOSE_RANDOM_DEVICE rd_;
    moose::MOOSE_RNG_DEFAULT_ENGINE rng_;
    moose::MOOSE_UNIFORM_DISTRIBUTION<double> dist_;
};

#endif // _SPARSE_MSG_H