alchemist/it.unibo.alchemist.model/Neighborhood

Neighborhood

interface Neighborhood<T> : Serializable, Cloneable, Iterable<T>

The type which describes the concentration of a molecule Interface for a neighborhood. When implementing it in a real class, please remember to correctly implement also the equals method inherited from Object.

Parameters

<T>

concentration type

Functions

add

abstract fun add(node: Node<T>): Neighborhood<T>

contains

abstract fun contains(n: Node<T>): Boolean

Verifies if a node is contained inside a neighborhood.

forEach

open fun forEach(action: Consumer<in T>)

getCenter

abstract fun getCenter(): Node<T>

Allows to access the central node.

getNeighbors

abstract fun getNeighbors(): ListSet<out Node<T>>

Allows to directly access every node in the neighborhood.

isEmpty

abstract fun isEmpty(): Boolean

iterator

abstract fun iterator(): Iterator<T>

remove

abstract fun remove(node: Node<T>): Neighborhood<T>

size

abstract fun size(): Int

spliterator

open fun spliterator(): Spliterator<T>

toGraphQLNeighborhoodSurrogate

fun <T> Neighborhood<T>.toGraphQLNeighborhoodSurrogate(): NeighborhoodSurrogate<T>

Converts a Neighborhood to a NeighborhoodSurrogate.