agi.foundation.coordinates

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

Class Covariance3By3Derivative

java.lang.Object

agi.foundation.coordinates.Covariance3By3Derivative

All Implemented Interfaces:

IEquatable<Covariance3By3Derivative>

public class Covariance3By3Derivative
extends Object
implements IEquatable<Covariance3By3Derivative>

Holds the derivatives of the positional variance and covariance information for an object.

Constructor Summary

Constructors

Constructor and Description
Covariance3By3Derivative(Cartesian sigmaDerivatives, Cartesian rotationDerivative, int order) Initializes a new Covariance3By3SizeAndOrientation object from the sigmas and a rotation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(Covariance3By3Derivative other) Indicates whether another instance of this type is exactly equal to this instance.
int	getOrder() Gets the order of the sigma and rotation derivatives held by this instance.
Cartesian	getRotationDerivative() Gets the Cartesian describing the derivative of the rotation to the axes of the Covariance Ellipsoid.
Cartesian	getSigmaDerivatives() Gets the Cartesian with the derivative of the sigma values of the transformed Covariance Matrix.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
String	toString() Returns the string representation of the value of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Covariance3By3Derivative

public Covariance3By3Derivative(@Nonnull
                                Cartesian sigmaDerivatives,
                                @Nonnull
                                Cartesian rotationDerivative,
                                int order)

Initializes a new Covariance3By3SizeAndOrientation object from the sigmas and a rotation.

Parameters:

sigmaDerivatives - The derivative sigmas.

rotationDerivative - The derivative of the rotation of the frame where the covariances (not the variances) are zero.

order - The order of the derivative of the other two parameters.

Method Detail

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

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

equalsType

public final boolean equalsType(Covariance3By3Derivative other)

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

Specified by:

equalsType in interface IEquatable<Covariance3By3Derivative>

Parameters:

other - The instance to compare to this instance.

Returns:

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

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)

getOrder

public final int getOrder()

Gets the order of the sigma and rotation derivatives held by this instance.

getSigmaDerivatives

@Nonnull
public final Cartesian getSigmaDerivatives()

Gets the Cartesian with the derivative of the sigma values of the transformed Covariance Matrix.

getRotationDerivative

@Nonnull
public final Cartesian getRotationDerivative()

Gets the Cartesian describing the derivative of the rotation to the axes of the Covariance Ellipsoid.

toString

public String toString()

Returns the string representation of the value of this instance.

Overrides:

toString in class Object

Returns:

A string that represents the value of this instance in the form "Order : SigmaDerivatives.X, SigmaDerivatives.Y, SigmaDerivatives.Z : RotationDerivative.X, RotationDerivative.Y, RotationDerivative.Z".