agi.foundation.coordinates

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

Class CartesianBounds

java.lang.Object

agi.foundation.coordinates.CartesianBounds

All Implemented Interfaces:

IEquatable<CartesianBounds>, ImmutableValueType, ValueType, IEquatableEpsilon<CartesianBounds>

public final class CartesianBounds
extends Object
implements IEquatable<CartesianBounds>, IEquatableEpsilon<CartesianBounds>, ImmutableValueType

Holds two Cartesian values which form the bounds of a range of cartesian coordinates.

Constructor Summary

Constructors

Constructor and Description
CartesianBounds() Initializes a new instance.
CartesianBounds(Cartesian lowerBound, Cartesian upperBound) Holds two Cartesian values which form the bounds of a range of cartesian coordinates.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(CartesianBounds left, CartesianBounds 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	equalsEpsilon(CartesianBounds other, double epsilon) Indicates whether each value of another instance of this type is within the required tolerance of the corresponding value of this instance.
boolean	equalsType(CartesianBounds other) Indicates whether another instance of this type is exactly equal to this instance.
boolean	getIsFinite() Gets a value indicating whether this instance has a finite range.
boolean	getIsUnbounded() Gets a value indicating whether this instance ranges from Double.NEGATIVE_INFINITY to Double.POSITIVE_INFINITY for all coordinates.
boolean	getIsUndefined() Gets a value indicating whether any of the bounds coordinates for this instance have the value Double.NaN.
Cartesian	getLowerBound() Gets the minimal value defining the bounds.
static CartesianBounds	getUnbounded() Gets a set of CartesianBounds representing the full range of real values from negative infinity to positive infinity.
static CartesianBounds	getUndefined() Gets a set of CartesianBounds with values of Double.NaN.
Cartesian	getUpperBound() Gets the maximal value defining the bounds.
Bounds	getXBounds() Gets the bounds for the X coordinate.
Bounds	getYBounds() Gets the bounds for the Y coordinate.
Bounds	getZBounds() Gets the bounds for the Z 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 boolean	notEquals(CartesianBounds left, CartesianBounds right) Returns true if the two instances are not exactly equal.
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

CartesianBounds

public CartesianBounds()

Initializes a new instance.

CartesianBounds

public CartesianBounds(@Nonnull
                       Cartesian lowerBound,
                       @Nonnull
                       Cartesian upperBound)

Holds two Cartesian values which form the bounds of a range of cartesian coordinates.

Parameters:

lowerBound - The minimal values defining the bounds.

upperBound - The maximal values defining the bounds.

Throws:

ArgumentException - Thrown when the upperBound is less than the lowerBound or when one value in a given coordinate is Double.NaN and the other is not.

Method Detail

getUnbounded

@Nonnull
public static CartesianBounds getUnbounded()

Gets a set of CartesianBounds representing the full range of real values from negative infinity to positive infinity.

Use IsUnbounded (get) to test whether a CartesianBounds instance is unbounded since it will return true if all the values range from Double.NEGATIVE_INFINITY to Double.POSITIVE_INFINITY.

getUndefined

@Nonnull
public static CartesianBounds getUndefined()

Gets a set of CartesianBounds with values of Double.NaN.

Use IsUndefined (get) to test whether a CartesianBounds instance is undefined since it will return true if any of the values are Double.NaN.

getLowerBound

@Nonnull
public final Cartesian getLowerBound()

Gets the minimal value defining the bounds.

getUpperBound

@Nonnull
public final Cartesian getUpperBound()

Gets the maximal value defining the bounds.

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(@Nonnull
                                CartesianBounds other)

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

Specified by:

equalsType in interface IEquatable<CartesianBounds>

Parameters:

other - The instance to compare to this instance.

Returns:

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

equalsEpsilon

public final boolean equalsEpsilon(@Nonnull
                                   CartesianBounds other,
                                   double epsilon)

Indicates whether each value of another instance of this type is within the required tolerance of the corresponding value of this instance.

Specified by:

equalsEpsilon in interface IEquatableEpsilon<CartesianBounds>

Parameters:

other - The set of CartesianBounds to compare to this instance.

epsilon - The limit at which the absolute differences between the values will not be considered equal.

Returns:

true if the absolute differences are less than or equal to epsilon; 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)

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 values of this instance in the form "LowerBound (get), UpperBound (get)".

equals

public static boolean equals(@Nonnull
                             CartesianBounds left,
                             @Nonnull
                             CartesianBounds 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(@Nonnull
                                CartesianBounds left,
                                @Nonnull
                                CartesianBounds 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.

getIsFinite

public final boolean getIsFinite()

Gets a value indicating whether this instance has a finite range.

getIsUnbounded

public final boolean getIsUnbounded()

Gets a value indicating whether this instance ranges from Double.NEGATIVE_INFINITY to Double.POSITIVE_INFINITY for all coordinates.

getIsUndefined

public final boolean getIsUndefined()

Gets a value indicating whether any of the bounds coordinates for this instance have the value Double.NaN.

getXBounds

@Nonnull
public final Bounds getXBounds()

Gets the bounds for the X coordinate.

getYBounds

@Nonnull
public final Bounds getYBounds()

Gets the bounds for the Y coordinate.

getZBounds

@Nonnull
public final Bounds getZBounds()

Gets the bounds for the Z coordinate.