alchemist-implementationbase/it.unibo.alchemist.model.environments/AbstractEnvironment

AbstractEnvironment

abstract class AbstractEnvironment<T, P : Position<P>> : Environment<T, P> (source)

Base implementation of an Environment: it owns the ordered node list, node positions and neighborhoods, the environment-hosted reactions, the layers associated during setup, and live range queries over node positions. Subclasses define the geometry, through computeActualInsertionPosition and node movement, and may react to node addition and removal through nodeAdded and nodeRemoved.

Type Parameters

concentration type

position type

Inheritors

Abstract2DEnvironment

EmptyEnvironment

Properties

currentPosition

open val Node<T>.currentPosition: P

dimensions

abstract val dimensions: Int

incarnation

override val incarnation: Incarnation<T, P>

isTerminated

open override val isTerminated: Boolean

layers

override val layers: Map<Molecule, Layer<T, P>>

neighborhood

open val Node<T>.neighborhood: Observable<Neighborhood<T>>

networkModel

override var networkModel: NetworkModel<T>

nodeCount

override val nodeCount: Observable<Int>

nodes

open override val nodes: ObservableList<Node<T>>

offset

abstract val offset: DoubleArray

position

open val Node<T>.position: Observable<P>

reactions

open override val reactions: ObservableList<Reaction<T>>

simulation

override var simulation: Simulation<T, P>

simulationOrNull

override var simulationOrNull: Simulation<T, P>?

size

abstract val size: DoubleArray

sizeInDistanceUnits

open override val sizeInDistanceUnits: DoubleArray

Override this property if units measuring distance do not match with units used for coordinates. For instance, if your space is non-Euclidean, or if you are using polar coordinates. A notable example is using geographical latitude-longitude as y-x coordinates and meters as distance measure.

Functions

addLayer

open override fun addLayer(molecule: Molecule, layer: Layer<T, P>)

addNode

open override fun addNode(node: Node<T>, position: P): Boolean

addReaction

open override fun addReaction(reaction: Reaction<T>)

addTerminator

open fun addTerminator(terminator: (Environment<T, P>) -> Boolean)

open override fun addTerminator(terminator: TerminationPredicate<T, P>)

Adds to the simulation a predicate that determines whether a simulation should be terminated.

allShortestHopPaths

fun <T> Environment<T, *>.allShortestHopPaths(): SymmetricMatrix<Double>

Calculates the shortest paths using the Floyd-Warshall algorithm calculating the Hop Distance between nodes.

allSubNetworks

fun <T> Environment<T, *>.allSubNetworks(computeDistance: (Node<T>, Node<T>) -> Double = environmentMetricDistance()): Set<Network<T>>

Computes the diameter of all subnetworks in the environment. The diameter is the longest shortest path between any two nodes. Returns a Map containing the subnetwork related to each Node of the environment.

allSubNetworksByNode

fun <T> Environment<T, *>.allSubNetworksByNode(computeDistance: (Node<T>, Node<T>) -> Double = environmentMetricDistance()): Map<Node<T>, Network<T>>

Computes the diameter of all subnetworks in the environment. The diameter is the longest shortest path between any two nodes. Returns a Map mapping each node to the subnetwork it belongs to.

allSubNetworksByNodeWithHopDistance

fun <T> Environment<T, *>.allSubNetworksByNodeWithHopDistance(): Map<Node<T>, Network<T>>

Computes the diameter of all subnetworks in the environment. The diameter is the longest shortest path between any two nodes, evaluated using the allShortestHopPaths method. Returns a Set containing the subnetworks.