agi.foundation

(agi.foundation.core-2024r3.jar)

Class Motion2<T,TDerivative>

java.lang.Object

agi.foundation.Motion2<T,TDerivative>

Type Parameters:

T - The coordinate type used to describe the motion.

TDerivative - The derivative type used to describe the motion.

All Implemented Interfaces:

IEquatable<Motion2<T,TDerivative>>, ImmutableValueType, ValueType, IMotion<T,TDerivative>

public final class Motion2<T,TDerivative>
extends Object
implements IMotion<T,TDerivative>, IEquatable<Motion2<T,TDerivative>>, ImmutableValueType

Describes motion, including a coordinate and optionally one or more derivatives.

Constructor Summary

Constructors

Constructor and Description
Motion2() Initializes a new instance.
Motion2(T value, TDerivative... derivatives) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static <T,TDerivative> boolean	equals(Motion2<T,TDerivative> left, Motion2<T,TDerivative> right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(Motion2<T,TDerivative> other) Indicates whether another instance of this type is exactly equal to this instance.
TDerivative	get(int index) Gets the indicated derivative of the motion.
TDerivative	getFirstDerivative() Gets the first derivative, if it is available.
int	getOrder() Gets the number of derivatives described by this instance.
TDerivative	getSecondDerivative() Gets the second derivative, if it is available.
T	getValue() Gets the coordinate value.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static <T,TDerivative> boolean	notEquals(Motion2<T,TDerivative> left, Motion2<T,TDerivative> right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Motion2

public Motion2()

Initializes a new instance.

Motion2

public Motion2(T value,
               TDerivative... derivatives)

Initializes a new instance.

The first array element describes the first derivative, the second describes the second derivative, and so on.

Parameters:

value - The value of the coordinate.

derivatives - The derivatives describing the motion.

Method Detail

equalsType

public final boolean equalsType(@Nonnull
                                Motion2<T,TDerivative> other)

Indicates whether another instance of this type is exactly equal to this instance.

For two Motion instances to be considered equal, the value and derivatives of each must compare as equal.

Specified by:

equalsType in interface IEquatable<Motion2<T,TDerivative>>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

For two Motion instances to be considered equal, the value and derivatives of each must compare as equal.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public static <T,TDerivative> boolean equals(@Nonnull
                                             Motion2<T,TDerivative> left,
                                             @Nonnull
                                             Motion2<T,TDerivative> right)

Returns true if the two instances are exactly equal.

For two Motion instances to be considered equal, the value and derivatives of each must compare as equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static <T,TDerivative> boolean notEquals(@Nonnull
                                                Motion2<T,TDerivative> left,
                                                @Nonnull
                                                Motion2<T,TDerivative> right)

Returns true if the two instances are not exactly equal.

For two Motion instances to be considered equal, the value and derivatives of each must compare as equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

getValue

public final T getValue()

Gets the coordinate value.

Specified by:

getValue in interface IMotion<T,TDerivative>

getFirstDerivative

public final TDerivative getFirstDerivative()

Gets the first derivative, if it is available.

Specified by:

getFirstDerivative in interface IMotion<T,TDerivative>

Throws:

ArgumentOutOfRangeException - This motion instance does not contain a first derivative.

getSecondDerivative

public final TDerivative getSecondDerivative()

Gets the second derivative, if it is available.

Specified by:

getSecondDerivative in interface IMotion<T,TDerivative>

Throws:

ArgumentOutOfRangeException - This motion instance does not contain a second derivative.

get

public final TDerivative get(int index)

Gets the indicated derivative of the motion. Index 1 retrieves the first derivative, if it exists. Index 2 retrieves the second derivative, if it exists. The number of available derivatives is indicated by the Order (get) property.

Requesting index 0 will result in an ArgumentOutOfRangeException.

Specified by:

get in interface IMotion<T,TDerivative>

Parameters:

index - The index of the derivative to retrieve.

Returns:

The requested derivative.

Throws:

ArgumentOutOfRangeException - Thrown when the index is less than one or greater than the Order (get). This exception can also be thrown if this object does not contain any derivatives.

getOrder

public final int getOrder()

Gets the number of derivatives described by this instance.

Specified by:

getOrder in interface IMotion<T,TDerivative>