37.1.1

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

AbstractEuclideanPosition

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

N-dimensional Euclidean position.

Parameters

<P>

actual type

Inheritors

Euclidean2DPosition

Functions

open fun angleBetween(other: S): Double

Computes the angle in radians between two vectors.

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.

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.

open fun coerceAtLeast(minimumMagnitude: Double): S

open fun coerceAtMost(maximumMagnitude: Double): S

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

Performs a coercion at least and at most.

abstract fun distanceTo(other: S): Double

Computes the distance between two vectors, interpreted as points in an Euclidean space. Throws IllegalArgumentException if vectors have different dimensions.

fun distanceTo(other: P): Double

Computes the distance between this position and another compatible position.

open fun div(other: Double): S

Division by a Double.

open fun dot(other: S): Double

Computes the dot product between two vectors.

fun equals(o: Any): Boolean

fromCoordinates

abstract fun fromCoordinates(coordinates: Array<Double>): S

Builds a new Vector from the provided coordinates.

fun get(dimension: Int): Double

The coordinate of this vector in the specified dimension relatively to the basis its space is described with.

abstract fun getCoordinate(dimension: Int): Double

Allows to access the value of a coordinate.

fun getCoordinate(dimension: Int): Double

Allows to access the value of a coordinate.

abstract fun getCoordinates(): Array<Double>

Coordinates for a Cartesian space. Implementors must guarantee that internal state is not exposed.

fun getCoordinates(): Array<Double>

Allows to get the position as a Number array.

abstract fun getDimensions(): Int

The dimensions of the space this vector belongs to.

fun getDimensions(): Int

open fun getMagnitude(): NonExistentClass

Finds the magnitude of a vector.

open fun getZero(): S

Origin.

fun hashCode(): Int

abstract fun minus(other: Array<Double>): P

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

abstract fun minus(other: S): S

Support for subtraction. Note: the dimensions must coincide.

fun minus(other: P): P

Same as minus, with the internal representation of other.

fun minus(other: Array<Double>): P

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

abstract fun normal(): S

Find the normal of a vector.

abstract fun normalized(): S

abstract fun plus(other: Array<Double>): P

Considers both positions as vectors, and sums them.

abstract fun plus(other: S): S

Support for sum. Note: the dimensions must coincide.

fun plus(other: P): P

Same as plus, with the internal representation of other.

fun plus(other: Array<Double>): P

Considers both positions as vectors, and sums them.

open fun resized(newLen: Double): S

abstract fun times(other: Double): S

Multiplication by a Double.

open fun toString(): String

Prints the coordinates.