org.simbrain.network.connections

Class AllToAll

java.lang.Object

org.simbrain.network.connections.AllToAll

All Implemented Interfaces:

ConnectNeurons

public class AllToAll
extends java.lang.Object
implements ConnectNeurons

Connect every source neuron to every target neuron.

Author:

Zach Tosi, Jeff Yoshimi

Constructor Summary

Constructors

Constructor and Description
AllToAll() Construct to all to all connector.
AllToAll(boolean allowSelfConnect) Construct all to all connection object.

Method Summary

Modifier and Type	Method and Description
java.util.List<Synapse>	connectAllToAll(java.util.List<Neuron> sourceNeurons, java.util.List<Neuron> targetNeurons) Connect all to all using underlying connection object to store parameters.
static java.util.List<Synapse>	connectAllToAll(java.util.List<Neuron> sourceNeurons, java.util.List<Neuron> targetNeurons, boolean recurrent, boolean allowSelfConnection, boolean looseSynapses) Connects every source neuron to every target neuron.
void	connectNeurons(SynapseGroup synGroup) Connects neurons such that every source neuron is connected to every target neuron.
static java.lang.String	getName() Returns a short name for this connection type, used in combo boxes.
boolean	isSelfConnectionAllowed()
void	setSelfConnectionAllowed(boolean allowSelfConnect) Set whether or not self connections are allowed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AllToAll

public AllToAll()

Construct to all to all connector.

AllToAll

public AllToAll(boolean allowSelfConnect)

Construct all to all connection object.

Parameters:

allowSelfConnect - whether to allow self connections or not

Method Detail

getName

public static java.lang.String getName()

Returns a short name for this connection type, used in combo boxes.

Returns:

the name for this connection type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

connectAllToAll

public java.util.List<Synapse> connectAllToAll(java.util.List<Neuron> sourceNeurons,
                                               java.util.List<Neuron> targetNeurons)

Connect all to all using underlying connection object to store parameters. Used by quick connect.

Parameters:

sourceNeurons - the source neurons

targetNeurons - the target neurons

Returns:

the new synapses

connectAllToAll

public static java.util.List<Synapse> connectAllToAll(java.util.List<Neuron> sourceNeurons,
                                                      java.util.List<Neuron> targetNeurons,
                                                      boolean recurrent,
                                                      boolean allowSelfConnection,
                                                      boolean looseSynapses)

Connects every source neuron to every target neuron. The only exception being that if the source and target neuron lists are the same, then no connection will be made between a neuron and itself if self connections aren't allowed. Will produce n^2 synapses if self connections are allowed and n(n-1) if they are not.

Parameters:

sourceNeurons - the source neurons

targetNeurons - the target neurons

recurrent - whether the source and target neurons overlap. Some classes know ahead of time if the connection will be recurrent and knowing this allows a slight performance improvement.

allowSelfConnection - whether to allow self-connections

looseSynapses - whether the synapses being connected are loose or in a synapse group

Returns:

the synapses created.

connectNeurons

public void connectNeurons(SynapseGroup synGroup)

Connects neurons such that every source neuron is connected to every target neuron. The only exception to this case is if the source neuron group is the target neuron group and self-connections are not allowed.

Specified by:

connectNeurons in interface ConnectNeurons

Parameters:

synGroup - the synapse group to which the synapses created by this connection class will be added.

isSelfConnectionAllowed

public boolean isSelfConnectionAllowed()

Returns:

if neurons are allowed to connect to themselves i.e. a synapse where the source and target neuron are the same neuron is allowed.

setSelfConnectionAllowed

public void setSelfConnectionAllowed(boolean allowSelfConnect)

Set whether or not self connections are allowed.

Parameters:

allowSelfConnect - Neurons are allowed to connect to themselves.