org.simbrain.network.connections

Class OneToOne

java.lang.Object

org.simbrain.network.connections.OneToOne

All Implemented Interfaces:

ConnectNeurons

public class OneToOne
extends java.lang.Object
implements ConnectNeurons

Connect each source neuron to a single target.

Author:

Jeff Yoshimi, Zach Tosi

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BIDIRECT_PREF
static OrientationComparator	DEFAULT_ORIENTATION

Constructor Summary

Constructors

Constructor and Description
OneToOne()

Method Summary

Modifier and Type	Method and Description
void	connectNeurons(SynapseGroup synGroup) Apply connection to a synapse group using specified parameters.
java.util.List<Synapse>	connectOneToOne(java.util.List<Neuron> sourceNeurons, java.util.List<Neuron> targetNeurons) Use this connection object to make connections.
static java.util.List<Synapse>	connectOneToOne(java.util.List<Neuron> sourceNeurons, java.util.List<Neuron> targetNeurons, boolean useBidirectionalConnections, boolean looseSynapses)
OrientationComparator	getConnectOrientation()
static java.lang.String	getName() Returns a short name for this connection type, used in combo boxes.
static OrientationComparator[]	getOrientationTypes() Used for populating combo box with orientation types.
boolean	isUseBidirectionalConnections()
void	setConnectOrientation(OrientationComparator connectOrientation)
void	setUseBidirectionalConnections(boolean useBidirectionalConnections)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BIDIRECT_PREF

public static boolean DEFAULT_BIDIRECT_PREF

DEFAULT_ORIENTATION

public static OrientationComparator DEFAULT_ORIENTATION

Constructor Detail

OneToOne

public OneToOne()

Method Detail

connectOneToOne

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

Use this connection object to make connections.

Parameters:

sourceNeurons - the starting neurons

targetNeurons - the targeted neurons

Returns:

the new synapses

connectNeurons

public void connectNeurons(SynapseGroup synGroup)

Apply connection to a synapse group using specified parameters. Source and target neuron groups must have the same number of neurons. A synapse is created such that every source neuron is connected to exactly one target neuron (and vice versa if connections are bidirectional).

Specified by:

connectNeurons in interface ConnectNeurons

Parameters:

synGroup - synapse group

connectOneToOne

public static java.util.List<Synapse> connectOneToOne(java.util.List<Neuron> sourceNeurons,
                                                      java.util.List<Neuron> targetNeurons,
                                                      boolean useBidirectionalConnections,
                                                      boolean looseSynapses)

Parameters:

sourceNeurons - the starting neurons

targetNeurons - the targeted neurons

useBidirectionalConnections - the useBidirectionalConnections to set

looseSynapses - whether loose synapses are being connected

Returns:

array of synpases

isUseBidirectionalConnections

public boolean isUseBidirectionalConnections()

Returns:

the useBidirectionalConnections

setUseBidirectionalConnections

public void setUseBidirectionalConnections(boolean useBidirectionalConnections)

Parameters:

useBidirectionalConnections - the useBidirectionalConnections to set

getConnectOrientation

public OrientationComparator getConnectOrientation()

Returns:

the connectOrientation

setConnectOrientation

public void setConnectOrientation(OrientationComparator connectOrientation)

Parameters:

connectOrientation - the connectOrientation to set

getOrientationTypes

public static OrientationComparator[] getOrientationTypes()

Used for populating combo box with orientation types.

Returns:

Array of connection types.

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