alchemist-api/it.unibo.alchemist.model/Position

Position

interface Position<P : Position<P>> : Serializable(source)

An interface to represent a generic coordinates system.

Parameters

the actual {@link Position} type: this strategy allows to progressively refine the {@link Position} by inheritance, allowing for specifying incrementally fine grained model elements.

Inheritors

Position2D

Properties

coordinates

abstract val coordinates: DoubleArray

Allows to get the position as a Number array.

dimensions

abstract val dimensions: Int

Functions

boundingBox

abstract fun boundingBox(range: Double): List<P>

Given a range, produces N coordinates, representing the N opposite vertices of the hypercube having the current coordinate as center and circumscribing the N-sphere defined by the range. In the case of two dimensional coordinates, it must return the opposite vertices of the square circumscribing the circle with center in this position and radius range.

distanceTo

abstract fun distanceTo(other: P): Double

Computes the distance between this position and another compatible position.

getCoordinate

abstract fun getCoordinate(dimension: Int): Double

Allows to access the value of a coordinate.

minus

abstract operator fun minus(other: DoubleArray): P

Considers both positions as vectors, and returns the difference between this position and the passed one.

plus

abstract operator fun plus(other: DoubleArray): P

Considers both positions as vectors, and sums them.