agi.foundation.coordinates

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

Class EigenDecomposition

java.lang.Object

agi.foundation.coordinates.EigenDecomposition

All Implemented Interfaces:

IEquatable<EigenDecomposition>

public class EigenDecomposition
extends Object
implements IEquatable<EigenDecomposition>

Holds results of the Eigen decomposition of a 3-by-3 matrix.

Constructor Summary

Constructors

Constructor and Description
EigenDecomposition(Matrix3By3 eigenvectors, Matrix3By3 eigenValues) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(EigenDecomposition left, EigenDecomposition 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(EigenDecomposition other) Indicates whether another instance of this type is exactly equal to this instance.
Matrix3By3	getValues() Gets the 3-by-3 matrix where the diagonal elements of the matrix hold the eigenvalues.
Matrix3By3	getVectors() Gets the 3-by-3 matrix where the columns of the matrix hold the eigenvectors.
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 boolean	notEquals(EigenDecomposition left, EigenDecomposition 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

EigenDecomposition

public EigenDecomposition(@Nonnull
                          Matrix3By3 eigenvectors,
                          @Nonnull
                          Matrix3By3 eigenValues)

Initializes a new instance.

Parameters:

eigenvectors - The 3-by-3 matrix where the columns of the matrix hold the eigenvectors.

eigenValues - The 3-by-3 matrix where the diagonal elements of the matrix hold the eigenvalues.

Method Detail

getVectors

@Nonnull
public final Matrix3By3 getVectors()

Gets the 3-by-3 matrix where the columns of the matrix hold the eigenvectors.

getValues

@Nonnull
public final Matrix3By3 getValues()

Gets the 3-by-3 matrix where the diagonal elements of the matrix hold the eigenvalues.

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(EigenDecomposition other)

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

Specified by:

equalsType in interface IEquatable<EigenDecomposition>

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)

equals

public static boolean equals(EigenDecomposition left,
                             EigenDecomposition right)

Returns true if the two instances are exactly 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 boolean notEquals(EigenDecomposition left,
                                EigenDecomposition right)

Returns true if the two instances are not exactly 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.