Grid

open class Grid(environment: Environment<*, *>, randomGenerator: <Error class: unknown class>, xStart: Double, yStart: Double, xEnd: Double, yEnd: Double, xStep: Double, yStep: Double, xRand: Double = 0.0, yRand: Double = 0.0, xShift: Double = 0.0, yShift: Double = 0.0) : Deployment<Position<*>>

A (possibly randomized) grid of nodes.

environment

the {@link Environment}

randomGenerator

the {@link RandomGenerator}

xStart

the start x position

yStart

the start y position

xEnd

the end x position

yEnd

the end y position

xStep

how distant on the x axis (on average) nodes should be

yStep

how distant on the y axis (on average) nodes should be

xRand

how randomized should be positions along the x axis

yRand

how randomized should be positions along the y axis

xShift

how shifted should be positions between lines

yShift

how shifted should be positions along columns

Constructors

constructor(environment: Environment<*, *>, randomGenerator: <Error class: unknown class>, xStart: Double, yStart: Double, xEnd: Double, yEnd: Double, xStep: Double, yStep: Double, xRand: Double = 0.0, yRand: Double = 0.0, xShift: Double = 0.0, yShift: Double = 0.0)

Optional LinkingRule associated to the deployment.

open operator override fun iterator(): MutableIterator<Position<*>>

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

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

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

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

open override fun stream(): Stream<Position<*>>