alchemist/it.unibo.alchemist.model.interfaces/EuclideanEnvironment

EuclideanEnvironment

interface EuclideanEnvironment<T, P : Position<P>, Vector<P>> : Environment<T, P>

An Euclidean space, where Positions P are valid Vectors, supporting any concentration type T.

Functions

abstract fun addLayer(m: Molecule, l: Layer<T, P>)

abstract fun addNode(node: Node<T>, p: P)

abstract fun addTerminator(terminator: Predicate<Environment<T, P>>)

open fun forEach(p0: Consumer<in Node<T>>)

abstract fun getDimensions(): Int

getDistanceBetweenNodes

abstract fun getDistanceBetweenNodes(n1: Node<T>, n2: Node<T>): Double

abstract fun getIncarnation(): Optional<Incarnation<T, P>>

abstract fun getLayer(m: Molecule): Optional<Layer<T, P>>

abstract fun getLayers(): ListSet<Layer<T, P>>

abstract fun getLinkingRule(): LinkingRule<T, P>

getNeighborhood

abstract fun getNeighborhood(center: Node<T>): Neighborhood<T>

abstract fun getNodeByID(id: Int): Node<T>

abstract fun getNodeCount(): Int

abstract fun getNodes(): ListSet<Node<T>>

getNodesWithinRange

abstract fun getNodesWithinRange(center: P, range: Double): ListSet<Node<T>>

abstract fun getNodesWithinRange(center: Node<T>, range: Double): ListSet<Node<T>>

abstract fun getOffset(): DoubleArray

abstract fun getPosition(node: Node<T>): P

abstract fun getSimulation(): Simulation<T, P>

abstract fun getSize(): DoubleArray

getSizeInDistanceUnits

abstract fun getSizeInDistanceUnits(): DoubleArray

abstract fun isTerminated(): Boolean

abstract operator override fun iterator(): MutableIterator<Node<T>>

abstract fun makePosition(vararg coordinates: Number): P

abstract fun makePosition(vararg coordinates: Double): P

Creates a Position compatible with this environment given its coordinates.

open fun moveNode(node: Node<T>, direction: P)

This method moves a node in the environment toward some direction. If node move is unsupported, it does nothing. Subclasses may override this method if they want to change the way a node moves towards some direction. The current implementation internally calls {@link #moveNodeToPosition(Node, Position2D)}, as such, overriding that method may suffice.

moveNodeToPosition

abstract fun moveNodeToPosition(node: Node<T>, position: P)

abstract fun removeNode(node: Node<T>)

abstract fun setLinkingRule(rule: LinkingRule<T, P>)

abstract fun setSimulation(s: Simulation<T, P>)

open fun spliterator(): Spliterator<Node<T>>

Properties

open val origin: P

Create a position corresponding to the origin of this environment.

Inheritors

Euclidean2DEnvironment

PhysicsEnvironment

EnvironmentWithObstacles

Extensions

startSimulation

fun <T, P : Position<P>, Vector<P>> EuclideanEnvironment<T, P>.startSimulation(onceInitialized: (EuclideanEnvironment<T, P>) -> Unit = { }, atEachStep: (EuclideanEnvironment<T, P>, Reaction<T>?, Time, Long) -> Unit = { _, _, _, _ -> }, whenFinished: (EuclideanEnvironment<T, P>, Time, Long) -> Unit = { _, _, _ -> }, steps: Long = 10000): EuclideanEnvironment<T, P>

Run the simulation this environment owns.