Class MultiSourceSPParticle

Implements the (k, l)-SPF algorithm.

Inheritance

object

ParticleAlgorithm

MultiSourceSPParticle

Namespace: AS2.Algos.MultiSourceSP

Assembly: .dll

Syntax

public class MultiSourceSPParticle : ParticleAlgorithm

Constructors

MultiSourceSPParticle(Particle)

Declaration

public MultiSourceSPParticle(Particle p)

Parameters

Type	Name	Description
Particle	p

Fields

augPortalColor

Declaration

private static readonly Color augPortalColor

Field Value

Type	Description
Color

baseColor

Declaration

private static readonly Color baseColor

Field Value

Type	Description
Color

counter

Declaration

private ParticleAttribute<int> counter

Field Value

Type	Description
ParticleAttribute<int>

counter2

Declaration

private ParticleAttribute<int> counter2

Field Value

Type	Description
ParticleAttribute<int>

destColor

Declaration

private static readonly Color destColor

Field Value

Type	Description
Color

doFinalPrune

Declaration

private ParticleAttribute<bool> doFinalPrune

Field Value

Type	Description
ParticleAttribute<bool>

ett

Declaration

private SubETT ett

Field Value

Type	Description
SubETT

inMPrime

Declaration

private ParticleAttribute<bool> inMPrime

Field Value

Type	Description
ParticleAttribute<bool>

instances

Declaration

private MultiSourceSPParticle.Instance[] instances

Field Value

Type	Description
Instance[]

isDest

Declaration

private ParticleAttribute<bool> isDest

Field Value

Type	Description
ParticleAttribute<bool>

isLeader

Declaration

private ParticleAttribute<bool> isLeader

Field Value

Type	Description
ParticleAttribute<bool>

isSelectedCentroid

Declaration

private ParticleAttribute<bool> isSelectedCentroid

Field Value

Type	Description
ParticleAttribute<bool>

isSource

Declaration

private ParticleAttribute<bool> isSource

Field Value

Type	Description
ParticleAttribute<bool>

lastCentroid

Declaration

private ParticleAttribute<bool> lastCentroid

Field Value

Type	Description
ParticleAttribute<bool>

leaderColor

Declaration

private static readonly Color leaderColor

Field Value

Type	Description
Color

leftWinsMerge

Declaration

private ParticleAttribute<bool> leftWinsMerge

Field Value

Type	Description
ParticleAttribute<bool>

mainDir

Declaration

private const Direction mainDir = E

Field Value

Type	Description
Direction

marker1

Declaration

private ParticleAttribute<bool> marker1

Field Value

Type	Description
ParticleAttribute<bool>

marker2

Declaration

private ParticleAttribute<bool> marker2

Field Value

Type	Description
ParticleAttribute<bool>

markerColor

Declaration

private static readonly Color markerColor

Field Value

Type	Description
Color

numInstances

Declaration

private ParticleAttribute<int> numInstances

Field Value

Type	Description
ParticleAttribute<int>

pasc

Declaration

private SubPASC2 pasc

Field Value

Type	Description
SubPASC2

pascParticipant

Declaration

private ParticleAttribute<bool> pascParticipant

Field Value

Type	Description
ParticleAttribute<bool>

phase

Declaration

private ParticleAttribute<MultiSourceSPParticle.Phase> phase

Field Value

Type	Description
ParticleAttribute<MultiSourceSPParticle.Phase>

pruned

Declaration

private ParticleAttribute<bool> pruned

Field Value

Type	Description
ParticleAttribute<bool>

regionColor

Declaration

private ParticleAttribute<bool> regionColor

Field Value

Type	Description
ParticleAttribute<bool>

rootPortal

Declaration

private ParticleAttribute<bool> rootPortal

Field Value

Type	Description
ParticleAttribute<bool>

round

Declaration

private ParticleAttribute<int> round

Field Value

Type	Description
ParticleAttribute<int>

skipMerge

Declaration

private ParticleAttribute<bool> skipMerge

Field Value

Type	Description
ParticleAttribute<bool>

sourceColor

Declaration

private static readonly Color sourceColor

Field Value

Type	Description
Color

sourcePortal

Declaration

private ParticleAttribute<bool> sourcePortal

Field Value

Type	Description
ParticleAttribute<bool>

sourcePortalColor

Declaration

private static readonly Color sourcePortalColor

Field Value

Type	Description
Color

subDecomposition

Declaration

private SubDecomposition subDecomposition

Field Value

Type	Description
SubDecomposition

subPhase

Declaration

private ParticleAttribute<MultiSourceSPParticle.SubPhase> subPhase

Field Value

Type	Description
ParticleAttribute<MultiSourceSPParticle.SubPhase>

subSPFLine

Declaration

private SubSPFLine subSPFLine

Field Value

Type	Description
SubSPFLine

Properties

GenerationMethod

Declaration

public static string GenerationMethod { get; }

Property Value

Type	Description
string

Name

Declaration

public static string Name { get; }

Property Value

Type	Description
string

PinsPerEdge

The number of pins on each edge.

This number must be the same constant for all particles.

Declaration

public override int PinsPerEdge { get; }

Property Value

Type	Description
int

Overrides

ParticleAlgorithm.PinsPerEdge

Methods

ActivateBaseCase()

Declaration

private void ActivateBaseCase()

ActivateBeep()

This is the second part of the main activation logic of the particle. It is called exactly once in each round, after the movements scheduled in ActivateMove() have been executed, and should contain the algorithm code that implements the look-compute-beep cycle.

Inside of this method, particles are allowed to change their pin configuration and send beeps and messages on the updated configuration.

Note that beeps and messages sent in the current round will be readable in both the ActivateMove() and ActivateBeep() calls in the next round.

Declaration

public override void ActivateBeep()

Overrides

ParticleAlgorithm.ActivateBeep()

ActivateFinalPrune()

Declaration

private void ActivateFinalPrune()

ActivateMergingStep()

Declaration

private void ActivateMergingStep()

ActivateMove()

This is one part of the main activation logic of the particle. It is called exactly once in each round and should contain the algorithm code that implements the look-compute-move cycle. After the movements are executed, ActivateBeep() is called within the same round.

Inside of this method, particles are allowed to release bonds, define which bonds should be marked, and schedule movements. Only the last movement operation scheduled in this method will be applied.

Declaration

public override void ActivateMove()

Overrides

ParticleAlgorithm.ActivateMove()

ActivateSetupPhase()

Declaration

private void ActivateSetupPhase()

Active()

Returns a list of indices of all instances that are active based on region color for merging.

Declaration

private List<int> Active()

Returns

Type	Description
List<int>

ActiveInstances()

Returns a list of indices of all instances that are active based on region color.

Declaration

private List<int> ActiveInstances()

Returns

Type	Description
List<int>

AddIgnoreDirs(List<Direction>, int)

Declaration

private void AddIgnoreDirs(List<Direction> ignoreDirs, int i)

Parameters

Type	Name	Description
List<Direction>	ignoreDirs
int	i

AdvanceEnum<T>(ParticleAttribute<T>)

Advances the given enum attribute to the next value. If it is already at the last value, it remains unchanged.

Declaration

private static void AdvanceEnum<T>(ParticleAttribute<T> attr) where T : struct, Enum

Parameters

Type	Name	Description
ParticleAttribute<T>	attr	enum attribute to advance

Type Parameters

Name	Description
T

Init(bool, bool, bool)

Declaration

public void Init(bool isLeader = false, bool isSource = false, bool isDest = false)

Parameters

Type	Name	Description
bool	isLeader
bool	isSource
bool	isDest

IsFinished()

Checks whether this particle has finished its algorithm.

Override this method to return true when a particle is done executing the algorithm. Once all particles in the system are finished, the simulation will stop automatically. When a particle's state results in this method returning true, its activation methods should not change its state any more.

Declaration

public override bool IsFinished()

Returns

Type	Description
bool	true if and only if this particle has finished its algorithm.

Overrides

ParticleAlgorithm.IsFinished()

IsMarker()

Declaration

private bool IsMarker()

Returns

Type	Description
bool

IsOnQPrime()

Checks whether or not this amoebot's portal is in Q'.

Declaration

private bool IsOnQPrime()

Returns

Type	Description
bool	true if and only if this amoebot's portal contains a source or is an augmentation portal.

IsOnQPrime2()

Declaration

private bool IsOnQPrime2()

Returns

Type	Description
bool

Next()

helper function for advancing to next subphase and resetting counters

Declaration

private void Next()

RunColoring(SubPhase, bool)

Declaration

private void RunColoring(MultiSourceSPParticle.SubPhase nextPhase = SubPhase.NONE, bool reset = false)

Parameters

Type	Name	Description
MultiSourceSPParticle.SubPhase	nextPhase
bool	reset

RunDecompositionAlgorithm(SubPhase)

Declaration

private void RunDecompositionAlgorithm(MultiSourceSPParticle.SubPhase nextSubPhase = SubPhase.NONE)

Parameters

Type	Name	Description
MultiSourceSPParticle.SubPhase	nextSubPhase

RunLineAlgorithm()

Declaration

private void RunLineAlgorithm()

RunMPrimeSearch()

Declaration

private void RunMPrimeSearch()

RunMSMergingAlgorithm()

Declaration

private void RunMSMergingAlgorithm()

RunMSMergingAlgorithm2()

Declaration

private void RunMSMergingAlgorithm2()

RunMSPropAlgorithm()

Declaration

private void RunMSPropAlgorithm()

RunMergingAlgorithm()

Declaration

private void RunMergingAlgorithm()

RunPropAlgorithm()

Declaration

private void RunPropAlgorithm()

RunPropPreparation()

Declaration

private void RunPropPreparation()

RunSSSPAlgorithm()

Declaration

private void RunSSSPAlgorithm()

RunSetup()

Declaration

private void RunSetup()

SetColor()

Sets the color of this amoebot according to its current phase and state.

Declaration

private void SetColor()

SetupGlobalCircuit(int)

Sets up a global circuit connecting all amoebots on the partition set with the given Id.

Declaration

private void SetupGlobalCircuit(int partitionSetId = 0)

Parameters

Type	Name	Description
int	partitionSetId	The partition set id for the circuit

SetupGlobalCircuit(int, int)

Declaration

private void SetupGlobalCircuit(int pSet, int offset)

Parameters

Type	Name	Description
int	pSet
int	offset

SetupRegionCircuits(PinConfiguration, Direction, bool)

Sets up two circuits for each region. The partition set IDs will be 2i and 2i + 1 for instance i.

Declaration

private void SetupRegionCircuits(PinConfiguration pc, Direction portalDir, bool connectMarker = false)

Parameters

Type	Name	Description
PinConfiguration	pc	The pin configuration to modify.
Direction	portalDir	The direction of the portal axis.
bool	connectMarker	Whether to connect the two sides of a marker.

SetupSingletonCircuit()

Sets up a singleton circuit on all amoebots.

Declaration

private void SetupSingletonCircuit()

ShowParentTree(ParticleSystem, Particle)

Declaration

[StatusInfo("Show Parent Edge", "Draws the parent edge of all amoebots with respect to the region's primary portal as soon as they are available.", false)]
public static void ShowParentTree(ParticleSystem system, Particle selectedParticle)

Parameters

Type	Name	Description
ParticleSystem	system
Particle	selectedParticle

ShowTree(ParticleSystem, Particle)

Declaration

[StatusInfo("Show Parent Edges", "Draws the parent edges of all amoebots as soon as they are available. Blue edges are with respect to the region's primary portal, red edges with respect to the secondary portal.", false)]
public static void ShowTree(ParticleSystem system, Particle selectedParticle)

Parameters

Type	Name	Description
ParticleSystem	system
Particle	selectedParticle