alchemist/it.unibo.alchemist.model/Neighborhood

Neighborhood

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

A neighborhood, namely the set of nodes to which a "central" node is connected to.

Parameters

<T>

concentration type

Inheritors

SimpleNeighborhood

Functions

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

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

Verifies if a node is contained inside a neighborhood.

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

abstract fun getCenter(): Node<T>

Allows accessing the central node.

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

Allows directly accessing every node in the neighborhood.

abstract fun isEmpty(): Boolean

abstract fun iterator(): Iterator<T>

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

abstract fun size(): Int

open fun spliterator(): Spliterator<T>

toGraphQLNeighborhoodSurrogate

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

Converts a Neighborhood to a NeighborhoodSurrogate.