pygrenade_vx.network.PlacementAlgorithmRuleset

class pygrenade_vx.network.PlacementAlgorithmRuleset

Bases: _pygrenade_vx_network.PlacementAlgorithm

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: _pygrenade_vx_network.PlacementAlgorithmRuleset) -> None

  2. __init__(self: _pygrenade_vx_network.PlacementAlgorithmRuleset, depth_search_first: bool) -> None

Constructs Placement-Algorithm with specified placement pattern. For depth_search_first enabled the neuron is placed in depth first starting from the largest compartment. Elsewise the neuron is placed in breadth first.

  1. __init__(self: _pygrenade_vx_network.PlacementAlgorithmRuleset, arg0: _pygrenade_vx_network.PlacementAlgorithmRuleset) -> None

Methods

__init__(*args, **kwargs)

Overloaded function.

clone(self)

Clone the algorithm.

reset(self)

Reset all members of the algorithm.

run(self, coordinates, neuron, resources)

Executes placement algorithm.
clone(self: _pygrenade_vx_network.PlacementAlgorithmRuleset) → _pygrenade_vx_network.PlacementAlgorithm

Clone the algorithm. Only clones the initial state of the algorithm. New algorithm is in state as after reset(). Since PlacementAlgorithm is the abstract base class the algorithm is passed as a pointer. This allows to pass the algorithm polymorphically to functions.

reset(self: _pygrenade_vx_network.PlacementAlgorithmRuleset) → None

Reset all members of the algorithm. Used during testing.

run(self: _pygrenade_vx_network.PlacementAlgorithmRuleset, coordinates: _pygrenade_vx_network.CoordinateSystem, neuron: _pygrenade_vx_network.Neuron, resources: _pygrenade_vx_network.ResourceManager) → _pygrenade_vx_network.AlgorithmResult

Executes placement algorithm.