agi.foundation

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

Class Motion1<T>

java.lang.Object

agi.foundation.Motion1<T>

Type Parameters:

T - The coordinate type used to describe the motion.

All Implemented Interfaces:

IEquatable<Motion1<T>>, ImmutableValueType, ValueType, IMotion<T,T>

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

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

Constructor Summary

Constructors

Constructor and Description
Motion1() Initializes a new instance.
Motion1(T... motion) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static <T> boolean	equals(Motion1<T> left, Motion1<T> 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(Motion1<T> other) Indicates whether another instance of this type is exactly equal to this instance.
T	get(int index) Gets the indicated component of the motion.
T	getFirstDerivative() Gets the first derivative, if it is available.
int	getOrder() Gets the number of derivatives described by this instance.
T	getSecondDerivative() Gets the second derivative, if it is available.
T	getValue() Gets the value of the coordinate.
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> boolean	notEquals(Motion1<T> left, Motion1<T> 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

Motion1

public Motion1()

Initializes a new instance.

Motion1

public Motion1(@Nonnull
               T... motion)

Initializes a new instance.

The first array element describes the value of the coordinate. The second describes the first derivative, the third describes the second derivative, and so on. The array must have at least one element.

Parameters:

motion - The description of the motion.

Throws:

ArgumentNullException - Thrown when the parameter motion is null.

IllegalStateException - Thrown when the motion does not contain any values.

Method Detail

equalsType

public final boolean equalsType(@Nonnull
                                Motion1<T> 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<Motion1<T>>

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> boolean equals(@Nonnull
                                 Motion1<T> left,
                                 @Nonnull
                                 Motion1<T> 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> boolean notEquals(@Nonnull
                                    Motion1<T> left,
                                    @Nonnull
                                    Motion1<T> 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 value of the coordinate.

Specified by:

getValue in interface IMotion<T,T>

getFirstDerivative

public final T getFirstDerivative()

Gets the first derivative, if it is available.

Specified by:

getFirstDerivative in interface IMotion<T,T>

Throws:

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

getSecondDerivative

public final T getSecondDerivative()

Gets the second derivative, if it is available.

Specified by:

getSecondDerivative in interface IMotion<T,T>

Throws:

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

get

public final T get(int index)

Gets the indicated component of the motion. Index 0 retrieves the coordinate value. 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.

Specified by:

get in interface IMotion<T,T>

Parameters:

index - The index of the motion component to retrieve.

Returns:

The requested motion component.

Throws:

ArgumentOutOfRangeException - Thrown when the index is not between zero and the Order (get) inclusive.

getOrder

public final int getOrder()

Gets the number of derivatives described by this instance.

Specified by:

getOrder in interface IMotion<T,T>