conn_builder.h

Go to the documentation of this file.

/*
 *  conn_builder.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST 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 NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef CONN_BUILDER_H
#define CONN_BUILDER_H

#include <map>
#include <vector>

#include "dictdatum.h"
#include "gid_collection.h"
#include "lockptr.h"
#include "sliexceptions.h"

#include "gslrandomgen.h"

namespace nest {

  class Network;
  class Node;
  class ConnParameter;

  class ConnBuilder
  {
  public:

    virtual void connect();

    ConnBuilder(Network&,
        const GIDCollection&, const GIDCollection&, 
        const DictionaryDatum&, const DictionaryDatum&);
    virtual ~ConnBuilder();

  protected:

    virtual void connect_() =0;

    void single_connect_(index, Node&, thread, librandom::RngPtr&);

    Network& net_;

    const GIDCollection& sources_;
    const GIDCollection& targets_;

    bool autapses_;
    bool multapses_;

    std::vector<lockPTR<WrappedThreadException> > exceptions_raised_;

  private:
    typedef std::map<Name, ConnParameter*> ConnParameterMap;

    index synapse_model_;

    bool default_weight_and_delay_;
    
    bool default_weight_;
    
    // null-pointer indicates that default be used
    ConnParameter* weight_;
    ConnParameter* delay_;

    ConnParameterMap synapse_params_;

    std::vector<DictionaryDatum> param_dicts_;

    // check for synapse specific errors or warnings
    // This is a temporary function which should be removed once all parameter types work with Connect. 
    // The remaining error and warnings should then be handled within the synapse model.
    void check_synapse_params_(std::string, const DictionaryDatum& );
  };

  class OneToOneBuilder : public ConnBuilder
  {
  public:
  OneToOneBuilder(Network& net,
          const GIDCollection& sources, 
          const GIDCollection& targets, 
          const DictionaryDatum& conn_spec,
          const DictionaryDatum& syn_spec)
    : ConnBuilder(net, sources, targets, conn_spec, syn_spec)
    {}

  protected:
    void connect_();
  };

  class AllToAllBuilder : public ConnBuilder
  {
  public:
  AllToAllBuilder(Network& net,
          const GIDCollection& sources, 
          const GIDCollection& targets, 
          const DictionaryDatum& conn_spec,
          const DictionaryDatum& syn_spec)
    : ConnBuilder(net, sources, targets, conn_spec, syn_spec)
    {}

  protected:
    void connect_();
  };


  class FixedInDegreeBuilder : public ConnBuilder
  {
  public:
    FixedInDegreeBuilder(Network&,
             const GIDCollection&, 
             const GIDCollection&, 
             const DictionaryDatum&,
             const DictionaryDatum&);

  protected:
    void connect_();

  private:
    long indegree_;   
  };

  class FixedOutDegreeBuilder : public ConnBuilder
  {
  public:
    FixedOutDegreeBuilder(Network&,
              const GIDCollection&, 
              const GIDCollection&, 
              const DictionaryDatum&,
              const DictionaryDatum&);

  protected:
    void connect_();

  private:
    long outdegree_;   
  };

  class FixedTotalNumberBuilder : public ConnBuilder
  {
  public:
    FixedTotalNumberBuilder(Network&,
                const GIDCollection&, 
                const GIDCollection&, 
                const DictionaryDatum&,
                const DictionaryDatum&);

  protected:
    void connect_();

  private:
    long N_;   
  };

  class BernoulliBuilder : public ConnBuilder
  {
  public:
    BernoulliBuilder(Network&,
             const GIDCollection&, 
             const GIDCollection&, 
             const DictionaryDatum&,
             const DictionaryDatum&);

  protected:
    void connect_();

  private:
    double p_;   
  };

  
}  // namespace nest

#endif