Pyramidal

java.lang.Object
- agi.foundation.coordinates.Pyramidal

All Implemented Interfaces:

IEquatable<Pyramidal>, ImmutableValueType, ValueType, IEquatableEpsilon<Pyramidal>
```
public final class Pyramidal
extends Object
implements IEquatable<Pyramidal>, IEquatableEpsilon<Pyramidal>, ImmutableValueType
```
A set of curvilinear 3-dimensional coordinates.

Constructor Summary

Constructors
Constructor and Description
`Pyramidal()` Initializes a new instance.
`Pyramidal(Cartesian coordinates)` Initializes a set of `Pyramidal` coordinates from the provided set of `Cartesian` coordinates.
`Pyramidal(double[] elements)` Initializes a set of `Pyramidal` coordinates from the first 3 consecutive elements in the provided array.
`Pyramidal(double[] elements, int startIndex)` Initializes a set of `Pyramidal` coordinates from 3 consecutive elements in the provided array.
`Pyramidal(double zxAngle, double zyAngle, double z)` Initializes a set of `Pyramidal` coordinates from the provided values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Indicates whether another object is exactly equal to this instance.
`static boolean`	`equals(Pyramidal left, Pyramidal right)` Returns `true` if the two instances are exactly equal.
`boolean`	`equalsEpsilon(Pyramidal other, double epsilon)` Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
`boolean`	`equalsType(Pyramidal other)` Indicates whether another instance of this type is exactly equal to this instance.
`double`	`get(int index)` Gets the value of the specified element with `index` of 0, 1, and 2 corresponding to the coordinates `ZXAngle` (`get`), `ZYAngle` (`get`), and `Z` (`get`).
`boolean`	`getIsUndefined()` Gets a value indicating whether any of the coordinates for this instance have the value `Double.NaN`.
`int`	`getLength()` Gets the number of elements in this set of coordinates.
`static Pyramidal`	`getUndefined()` Gets a set of `Pyramidal` coordinates with values of `Double.NaN`.
`double`	`getZ()` Gets the linear coordinate along the positive z-axis.
`static Pyramidal`	`getZero()` Gets a set of `Pyramidal` coordinates with values of zero.
`double`	`getZXAngle()` Gets the angular coordinate that is z-x.
`double`	`getZYAngle()` Gets the angular coordinate that is z-y.
`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(Pyramidal left, Pyramidal 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
  - Pyramidal
```
public Pyramidal()
```
    Initializes a new instance.
  - Pyramidal
```
public Pyramidal(double zxAngle,
                 double zyAngle,
                 double z)
```
    Initializes a set of Pyramidal coordinates from the provided values.
    
    Parameters:
    
    zxAngle - The angular coordinate in z-x.
    
    zyAngle - The angular coordinate in z-y.
    
    z - The linear coordinate along the positive z-axis.
  - Pyramidal
```
public Pyramidal(@Nonnull
                 Cartesian coordinates)
```
    Initializes a set of Pyramidal coordinates from the provided set of Cartesian coordinates.
    
    Parameters:
    
    coordinates - The set of Cartesian coordinates.
  - Pyramidal
```
public Pyramidal(@Nonnull
                 double[] elements)
```
    Initializes a set of Pyramidal coordinates from the first 3 consecutive elements in the provided array.
    
    Parameters:
    
    elements - The array of coordinate values.
    
    Throws:
    
    ArgumentNullException - Thrown when elements is null.
    
    ArgumentOutOfRangeException - An object of this type must be constructed from an array with at least 3 elements.
  - Pyramidal
```
public Pyramidal(@Nonnull
                 double[] elements,
                 int startIndex)
```
    Initializes a set of Pyramidal coordinates from 3 consecutive elements in the provided array.
    
    Parameters:
    
    elements - The array of coordinate values.
    
    startIndex - The index of the first element in the array to use.
    
    Throws:
    
    ArgumentNullException - Thrown when the array of elements is null.
    
    ArgumentOutOfRangeException - Thrown when an object of this type is constructed from an array with less than 3 elements.
- Method Detail
  - getZero
```
@Nonnull
public static Pyramidal getZero()
```
    Gets a set of Pyramidal coordinates with values of zero.
  - getUndefined
```
@Nonnull
public static Pyramidal getUndefined()
```
    Gets a set of Pyramidal coordinates with values of Double.NaN.
    Use IsUndefined (get) to test whether a Pyramidal instance is undefined since it will return true if any of the coordinate values are Double.NaN.
  - getZXAngle
```
public final double getZXAngle()
```
    Gets the angular coordinate that is z-x.
  - getZYAngle
```
public final double getZYAngle()
```
    Gets the angular coordinate that is z-y.
  - getZ
```
public final double getZ()
```
    Gets the linear coordinate along the positive z-axis.
  - getIsUndefined
```
public final boolean getIsUndefined()
```
    Gets a value indicating whether any of the coordinates for this instance have the value Double.NaN.
  - getLength
```
public final int getLength()
```
    Gets the number of elements in this set of coordinates.
  - get
```
public final double get(int index)
```
    Gets the value of the specified element with index of 0, 1, and 2 corresponding to the coordinates ZXAngle (get), ZYAngle (get), and Z (get).
    
    Parameters:
    
    index - The index to retrieve.
    
    Returns:
    
    The coordinate associated with the specified index.
    
    Throws:
    
    ArgumentOutOfRangeException - Thrown when index is less than 0 or greater than or equal to Length (get).
  - 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
                                Pyramidal other)
```
    Indicates whether another instance of this type is exactly equal to this instance.
    
    Specified by:
    
    equalsType in interface IEquatable<Pyramidal>
    
    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
                                   Pyramidal other,
                                   double epsilon)
```
    Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
    
    Specified by:
    
    equalsEpsilon in interface IEquatableEpsilon<Pyramidal>
    
    Parameters:
    
    other - The set of Pyramidal coordinates to compare to this instance.
    
    epsilon - The limit at which the absolute differences between the coordinate 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 value of this instance in the form "ZXAngle, ZYAngle, Z".
  - equals
```
public static boolean equals(@Nonnull
                             Pyramidal left,
                             @Nonnull
                             Pyramidal 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
                                Pyramidal left,
                                @Nonnull
                                Pyramidal 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.

Class Pyramidal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Pyramidal

Pyramidal

Pyramidal

Pyramidal

Method Detail

getZero

getUndefined

getZXAngle

getZYAngle

getZ

getIsUndefined

getLength

get

equals

equalsType

equalsEpsilon

hashCode

toString

equals

notEquals