Bounds

java.lang.Object
- agi.foundation.Bounds

All Implemented Interfaces:

IEquatable<Bounds>, ImmutableValueType, ValueType, IEquatableEpsilon<Bounds>
```
public final class Bounds
extends Object
implements IEquatable<Bounds>, IEquatableEpsilon<Bounds>, ImmutableValueType
```
Holds two values which form the bounds of a range of real numbers.

Constructor Summary

Constructors
Constructor and Description
`Bounds()` Initializes a new instance.
`Bounds(double lowerBound, double upperBound)` Holds the values which form the bounds of a range of real numbers.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`equals(Bounds left, Bounds 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(Bounds 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(Bounds 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 value as either the lower or upper bound.
`boolean`	`getIsUnbounded()` Gets a value indicating whether this instance ranges from `Double.NEGATIVE_INFINITY` to `Double.POSITIVE_INFINITY`.
`boolean`	`getIsUndefined()` Gets a value indicating whether any of the values for this instance have the value `Double.NaN`.
`double`	`getLowerBound()` Gets the minimal value defining the range of numbers.
`static Bounds`	`getUnbounded()` Gets a set of `Bounds` representing the full range of real values from negative infinity to positive infinity.
`static Bounds`	`getUndefined()` Gets a set of `Bounds` with values of `Double.NaN`.
`double`	`getUpperBound()` Gets the maximal value defining the range of numbers.
`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(Bounds left, Bounds 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
  - Bounds
```
public Bounds()
```
    Initializes a new instance.
  - Bounds
```
public Bounds(double lowerBound,
              double upperBound)
```
    Holds the values which form the bounds of a range of real numbers.
    
    Parameters:
    
    lowerBound - The minimal value defining the range of numbers.
    
    upperBound - The maximal value defining the range of numbers.
    
    Throws:
    
    ArgumentException - Thrown when the upperBound is less than the lowerBound or when one value is Double.NaN and the other is not.
- Method Detail
  - getUnbounded
```
@Nonnull
public static Bounds getUnbounded()
```
    Gets a set of Bounds representing the full range of real values from negative infinity to positive infinity.
    Use IsUnbounded (get) to test whether a Bounds instance is unbounded since it will return true if the values range from Double.NEGATIVE_INFINITY to Double.POSITIVE_INFINITY.
  - getUndefined
```
@Nonnull
public static Bounds getUndefined()
```
    Gets a set of Bounds with values of Double.NaN.
    Use IsUndefined (get) to test whether a Bounds instance is undefined since it will return true if any of the values are Double.NaN.
  - getLowerBound
```
public final double getLowerBound()
```
    Gets the minimal value defining the range of numbers.
  - getUpperBound
```
public final double getUpperBound()
```
    Gets the maximal value defining the range of numbers.
  - 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
                                Bounds other)
```
    Indicates whether another instance of this type is exactly equal to this instance.
    
    Specified by:
    
    equalsType in interface IEquatable<Bounds>
    
    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
                                   Bounds 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<Bounds>
    
    Parameters:
    
    other - The set of Bounds 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
                             Bounds left,
                             @Nonnull
                             Bounds 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
                                Bounds left,
                                @Nonnull
                                Bounds 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 value as either the lower or upper bound.
  - getIsUnbounded
```
public final boolean getIsUnbounded()
```
    Gets a value indicating whether this instance ranges from Double.NEGATIVE_INFINITY to Double.POSITIVE_INFINITY.
  - getIsUndefined
```
public final boolean getIsUndefined()
```
    Gets a value indicating whether any of the values for this instance have the value Double.NaN.

Class Bounds

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bounds

Method Detail

getUnbounded

getUndefined

getLowerBound

getUpperBound

equals

equalsType

equalsEpsilon

hashCode

toString

equals

notEquals

getIsFinite

getIsUnbounded

getIsUndefined