SimpleAllToAllWiringMethod Class Reference

Standard implementation of wiring up two populations of SimObject's. More...

#include <SimpleAllToAllWiringMethod.h>

Inheritance diagram for SimpleAllToAllWiringMethod:

Inheritance graph
[legend]
Collaboration diagram for SimpleAllToAllWiringMethod:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 SimpleAllToAllWiringMethod (SimNetwork *net)
 SimpleAllToAllWiringMethod (SimNetwork &net)
virtual ~SimpleAllToAllWiringMethod ()
virtual unsigned connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, ConnectionIterator &iterator, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))
 Make direct connections between source and dest. population.
virtual SimObject::ID::Vector connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, const SimObjectFactory &connector, ConnectionIterator &iterator, bool collectIDs=false, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))
 Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.
virtual SimObject::ID::Vector connect (const SimObjectPopulation &source, const SimObjectPopulation &destination, ConnObjectFactory &connector, ConnectionIterator &iterator, bool collectIDs=false, bool collectPairs=false, WiringMethod::ConnectPairsVector connectPairs=WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >))
 Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.

Detailed Description

Standard implementation of wiring up two populations of SimObject's.

Not well suited for distributed wiring. Use DistributedSyncWiringMethod if your populations are distributed over many MPI nodes.

Definition at line 20 of file SimpleAllToAllWiringMethod.h.

Constructor & Destructor Documentation

SimpleAllToAllWiringMethod::SimpleAllToAllWiringMethod ( SimNetwork *  net  )  [inline]

Definition at line 23 of file SimpleAllToAllWiringMethod.h.

SimpleAllToAllWiringMethod::SimpleAllToAllWiringMethod ( SimNetwork &  net  )  [inline]

Definition at line 27 of file SimpleAllToAllWiringMethod.h.

virtual SimpleAllToAllWiringMethod::~SimpleAllToAllWiringMethod (  )  [inline, virtual]

Definition at line 31 of file SimpleAllToAllWiringMethod.h.

Member Function Documentation

unsigned SimpleAllToAllWiringMethod::connect ( const SimObjectPopulation &  source,
const SimObjectPopulation &  destination,
ConnectionIterator &  iterator,
bool  collectPairs = false,
WiringMethod::ConnectPairsVector  connectPairs = WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >) 
) [virtual]

Make direct connections between source and dest. population.

Parameters:
source The source population
destination The destination population (can be the same as source population)
iterator The connection iterator to use (e.g. PredicateBasedConnections or RandomConnections ) which determines which connections are made.
collectPairs Flaf which idicates wheter the pairs of ID's of the connected objects souble be collected or not.
connectPairs Vector where the collected connection pairs are written to if collectPairs == true Be aware that the collected pairs are collected on each node of a distributed simulation when using a DistributedSingleThreadNetwork or DistributedMultiThreadNetwork which may lead to a large memory consumption.

Implements WiringMethod.

Definition at line 59 of file SimpleAllToAllWiringMethod.cpp.

References SimNetwork::connect(), SimNetwork::getMainConstructRNGEngine(), SimObjectPopulation::idVector(), ConnectionIterator::init(), SimNetwork::mpi_rank(), WiringMethod::net, ConnectionIterator::next(), ConnectionIterator::reset(), and ConnectionIterator::setRNDEngine().

Here is the call graph for this function:

SimObject::ID::Vector SimpleAllToAllWiringMethod::connect ( const SimObjectPopulation &  source,
const SimObjectPopulation &  destination,
const SimObjectFactory &  connector,
ConnectionIterator &  iterator,
bool  collectIDs = false,
bool  collectPairs = false,
WiringMethod::ConnectPairsVector  connectPairs = WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >) 
) [virtual]

Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.

Parameters:
source The source population
destination The destination population (can be the same as source population)
connector The SimObjectFactory to use to generate connecting objects (e.g. StaticSpikingSynapse)
iterator The connection iterator to use (e.g. PredicateBasedConnections or RandomConnections ) which determines which connections are made.
collectIDs Flag which idicates whether the SimObject::ID's of the generated connector objects should be collected or not.
collectPairs Flaf which idicates wheter the pairs of ID's of the connected objects souble be collected or not.
connectPairs Vector where the collected connection pairs are written to if collectPairs == true Be aware that the collected ID's or indices are collected on each node of a distributed simulation when using a DistributedSingleThreadNetwork or DistributedMultiThreadNetwork which may lead to a large memory consumption.

Implements WiringMethod.

Definition at line 18 of file SimpleAllToAllWiringMethod.cpp.

References SimNetwork::connect(), SimNetwork::getMainConstructRNGEngine(), SimObjectPopulation::idVector(), ConnectionIterator::init(), SimNetwork::mpi_rank(), WiringMethod::net, ConnectionIterator::next(), ConnectionIterator::reset(), and ConnectionIterator::setRNDEngine().

Here is the call graph for this function:

SimObject::ID::Vector SimpleAllToAllWiringMethod::connect ( const SimObjectPopulation &  source,
const SimObjectPopulation &  destination,
ConnObjectFactory &  connector,
ConnectionIterator &  iterator,
bool  collectIDs = false,
bool  collectPairs = false,
WiringMethod::ConnectPairsVector  connectPairs = WiringMethod::ConnectPairsVector(new vector< pair< SimObject::ID, SimObject::ID > >) 
) [virtual]

Make connections between source and dest. population using a SimObjectFactory (usually some synapse) to connect the objects.

Parameters:
source The source population
destination The destination population (can be the same as source population)
connector The SimObjectFactory to use to generate connecting objects (e.g. StaticSpikingSynapse)
iterator The connection iterator to use (e.g. PredicateBasedConnections or RandomConnections ) which determines which connections are made.
collectIDs Flag which idicates whether the SimObject::ID's of the generated connector objects should be collected or not.
collectPairs Flaf which idicates wheter the pairs of ID's of the connected objects souble be collected or not.
connectPairs Vector where the collected connection pairs are written to if collectPairs == true Be aware that the collected ID's or indices are collected on each node of a distributed simulation when using a DistributedSingleThreadNetwork or DistributedMultiThreadNetwork which may lead to a large memory consumption.

Implements WiringMethod.

Definition at line 91 of file SimpleAllToAllWiringMethod.cpp.

References SimNetwork::connect(), ConnectionIterator::getIdx(), SimNetwork::getMainConstructRNGEngine(), SimObjectPopulation::idVector(), ConnObjectFactory::init(), ConnectionIterator::init(), SimNetwork::mpi_rank(), WiringMethod::net, ConnectionIterator::next(), ConnectionIterator::reset(), and ConnectionIterator::setRNDEngine().

Here is the call graph for this function:

The documentation for this class was generated from the following files:
Generated on Wed Jul 9 16:34:53 2008 for PCSIM by  doxygen 1.5.5