alchemist/it.unibo.alchemist.model.positions/AbstractEuclideanPosition

AbstractEuclideanPosition

abstract class AbstractEuclideanPosition<P : AbstractEuclideanPosition<P>> : AbstractPosition<P> , Vector<P>

N-dimensional Euclidean position.

Parameters

copy

true if it is unsafe to store the coordinates array as-is.

coordinates

the array of coordinates.

Type Parameters

P

actual type

Inheritors

Euclidean2DPosition

Properties

override val coordinates: DoubleArray

Allows to get the position as a Number array.

override val dimensions: Int

open val magnitude: Double

Finds the magnitude of a vector.

open val zero: P

Origin.

Functions

open fun angleBetween(other: P): Double

Computes the angle in radians between two vectors.

override 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 bidimensional coordinates, it must return the opposite vertices of the square circumscribing the circle with center in this position and radius range.

open fun coerceAtLeast(minimumMagnitude: Double): P

open fun coerceAtMost(maximumMagnitude: Double): P

open fun coerceIn(minimumMagnitude: Double, maximumMagnitude: Double): P

Performs a coercion at least and at most.

override fun distanceTo(other: P): Double

Computes the distance between this position and another compatible position.

open operator fun div(other: Double): P

Division by a Double.

open fun dot(other: P): Double

Computes the dot product between two vectors.

operator override fun equals(other: Any?): Boolean

fromCoordinates

abstract fun fromCoordinates(coordinates: DoubleArray): P

Builds a new Vector from the provided coordinates.

operator override fun get(dimension: Int): Double

Allows to access the value of a coordinate.

override fun hashCode(): Int

operator fun minus(other: P): P

Same as minus, with the internal representation of other.

operator override fun minus(other: DoubleArray): P

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

abstract fun normal(): P

Find the normal of a vector.

abstract fun normalized(): P

operator fun plus(other: P): P

Same as plus, with the internal representation of other.

operator override fun plus(other: DoubleArray): P

Considers both positions as vectors, and sums them.

open fun resized(newLen: Double): P

abstract operator fun times(other: Double): P

Multiplication by a Double.

open override fun toString(): String

Prints the coordinates.