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

Abstract2DEnvironment

abstract class Abstract2DEnvironment<T, P : Position2D<P>> : AbstractEnvironment<T, P> (source)

Models a bidimensional environment.

Parameters

incarnation

the incarnation to be used.

Type Parameters

T

concentration type

P

Position2D type

Properties

currentPosition

open val Node<T>.currentPosition: P

override val dimensions: Int = 2

override val incarnation: Incarnation<T, P>

open override val isTerminated: Boolean

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

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

override var networkModel: NetworkModel<T>

override val nodeCount: Observable<Int>

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

override val offset: DoubleArray

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

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

override var simulation: Simulation<T, P>

simulationOrNull

override var simulationOrNull: Simulation<T, P>?

override 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

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

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

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

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.

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.

allSubNetworksWithHopDistance

fun <T> Environment<T, *>.allSubNetworksWithHopDistance(): Set<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.

open operator override fun contains(node: Node<T>): Boolean

currentPositionOf

open override fun currentPositionOf(node: Node<T>): P

distanceBetween

open override fun distanceBetween(n1: Node<T>, n2: Node<T>): Double

open fun Node<T>.distanceTo(other: Node<T>): Double

farthestReachablePosition

open override fun farthestReachablePosition(node: Node<T>, desired: P): P

Movements are unconstrained: subclasses constraining them override this function, starting from the position that it returns.

isNetworkSegmented

fun <T> Environment<T, *>.isNetworkSegmented(): Boolean

Returns true the network is segmented, false otherwise.

open override fun layerFor(molecule: Molecule): Layer<T, P>?

abstract fun makePosition(coordinates: DoubleArray): P

open fun makePosition(coordinates: List<Number>): P

abstract fun makePosition(vararg coordinates: Number): P

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

Moves node to the farthestReachablePosition towards position, extending the environment to include it.

open fun Node<T>.moveTo(position: P)

open override fun neighborhoodOf(node: Node<T>): Observable<Neighborhood<T>>

networkDiameter

fun Environment<*, *>.networkDiameter(): Double

Returns the diameter of the network in environment units if it is not segmented, and NaN otherwise.

networkDiameterByHopDistance

fun Environment<*, *>.networkDiameterByHopDistance(): Double

Returns the hop-distance diameter of the network if it is not segmented, and NaN otherwise.

fun <T> Environment<T, *>.networkDiameterByHopDistance(node: Node<T>): Double

Computes the network diameter of the segment containing node.

open override fun nodesAround(position: P, range: Double): List<Node<T>>

open override fun nodesAround(node: Node<T>, range: Double): List<Node<T>>

open fun P.nodesInRange(range: Double): List<Node<T>>

open fun Node<T>.nodesInRange(range: Double): List<Node<T>>

open override fun nodeWithId(id: Int): Node<T>

observeLayerValue

open override fun observeLayerValue(molecule: Molecule, node: Node<T>): Observable<T?>

observeNodesAround

open override fun observeNodesAround(position: P, range: Double): ObservableSet<Node<T>>

open override fun observeNodesAround(node: Node<T>, range: Double): ObservableSet<Node<T>>

observeNodesInRange

open fun P.observeNodesInRange(range: Double): ObservableSet<Node<T>>

open fun Node<T>.observeNodesInRange(range: Double): ObservableSet<Node<T>>

open override fun positionOf(node: Node<T>): Observable<P>

open fun Node<T>.remove()

open fun Reaction<T>.remove()

open override fun removeNode(node: Node<T>)

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

open fun DoubleArray.toPosition(): P

open override fun toString(): String

Not used internally. Override as you please.