This method allows to know which are the smallest coordinates represented. Return an array of length dimensions containing the smallest coordinates for each dimension.

getPosition

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

Calculates the position of a node.

getSimulation

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

Return the current Simulation, if present, or throws an IllegalStateException otherwise.

getSimulationOrNull

open fun getSimulationOrNull(): Simulation<T, P>

Return the current Simulation, if present, or null otherwise.

getSize

abstract fun getSize(): Array<Double>

The size of the environment as an array of length getDimensions(). This method must return distance measured with the same unit used by the positions. No non-euclidean distance metrics are allowed.

getSizeInDistanceUnits

open fun getSizeInDistanceUnits(): Array<Double>

Override this method if units measuring distance do not match with units used for coordinates.

isTerminated

fun isTerminated(): Boolean

Return true if all the terminators are true.

iterator

fun iterator(): Iterator<Node<T>>

makePosition

abstract fun makePosition(coordinates: Array<Number>): P

Given the coordinates of the point, returns a Position compatible with this environment.

moveNodeToPosition

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

This method moves a node in the environment to some position. If node move is unsupported, it does nothing.

randomElement

fun <R> Iterable<R>.randomElement(randomGenerator: <Error class: unknown class>): R

Returns a random element of the Iterable using the provided randomGenerator.

removeGlobalReaction

open fun removeGlobalReaction(reaction: GlobalReaction<T>)

Remove a GlobalReaction from the Environment.

removeNode

fun removeNode(node: Node<T>)

This method allows to remove a node.

setLinkingRule

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

Returns the current LinkingRule.

setSimulation

abstract fun setSimulation(<set-?>: Simulation<T, P>)

Return the current Simulation, if present, or throws an IllegalStateException otherwise.

shuffled

fun <R> Iterable<R>.shuffled(randomGenerator: <Error class: unknown class>): Iterable<R>

Fisher–Yates shuffle algorithm using a RandomGenerator. More information on Wikipedia.

spliterator

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

subscriptionMonitor

fun <T, P : Position<out P>> Environment<T, P>.subscriptionMonitor(): EnvironmentSubscriptionMonitor<T, P>

Returns the EnvironmentSubscriptionMonitor of this Environment.

toEnvironmentSurrogate

fun <T, P : Position<out P>, TS : Any> Environment<T, P>.toEnvironmentSurrogate(toConcentrationSurrogate: (T) -> TS): EnvironmentSurrogate<TS, PositionSurrogate>

A function that maps an Environment to its surrogate class (EnvironmentSurrogate). Use the toSuitablePositionSurrogate strategy for PositionSurrogate mapping.

fun <T, P : Position<out P>, TS : Any, PS : PositionSurrogate> Environment<T, P>.toEnvironmentSurrogate(toConcentrationSurrogate: (T) -> TS, toPositionSurrogate: (P) -> PS): EnvironmentSurrogate<TS, PS>

A function that maps an Environment to its surrogate class (EnvironmentSurrogate).

toGraphQLEnvironmentSurrogate

fun <T, P : Position<out P>> Environment<T, P>.toGraphQLEnvironmentSurrogate(): EnvironmentSurrogate<T, P>

Converts an Environment to a EnvironmentSurrogate.

toString

open fun toString(): String

Not used internally.