agi.foundation.coordinates

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

Class Cylindrical

java.lang.Object

agi.foundation.coordinates.Cylindrical

All Implemented Interfaces:

IEquatable<Cylindrical>, ImmutableValueType, ValueType, IEquatableEpsilon<Cylindrical>

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

A set of curvilinear 3-dimensional coordinates.

The corresponding 2-dimensional coordinates are Polar coordinates.

Constructor Summary

Constructors

Constructor and Description
Cylindrical() Initializes a new instance.
Cylindrical(AzimuthElevationRange coordinates) Initializes a set of Cylindrical coordinates from the provided set of AzimuthElevationRange coordinates.
Cylindrical(Cartesian coordinates) Initializes a set of Cylindrical coordinates from the provided set of Cartesian coordinates.
Cylindrical(double[] elements) Initializes a set of Cylindrical coordinates from the first 3 consecutive elements in the provided array.
Cylindrical(double[] elements, int startIndex) Initializes a set of Cylindrical coordinates from 3 consecutive elements in the provided array.
Cylindrical(double clock, double radial, double z) Initializes a set of Cylindrical coordinates from the provided values.
Cylindrical(LongitudeLatitudeRadius coordinates) Initializes a set of Cylindrical coordinates from the provided set of LongitudeLatitudeRadius coordinates.
Cylindrical(Spherical coordinates) Initializes a set of Cylindrical coordinates from the provided set of Spherical coordinates.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(Cylindrical left, Cylindrical 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(Cylindrical 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(Cylindrical 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 Clock (get), Radial (get), and Z (get).
double	getClock() Gets the angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
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.
double	getRadial() Gets the linear coordinate perpendicular to the z-axis.
static Cylindrical	getUndefined() Gets a set of Cylindrical coordinates with values of Double.NaN.
double	getZ() Gets the linear coordinate along the positive z-axis.
static Cylindrical	getZero() Gets a set of Cylindrical coordinates with values of zero.
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(Cylindrical left, Cylindrical 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

Cylindrical

public Cylindrical()

Initializes a new instance.

Cylindrical

public Cylindrical(double clock,
                   double radial,
                   double z)

Initializes a set of Cylindrical coordinates from the provided values.

Parameters:

clock - The angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.

radial - The linear coordinate perpendicular to the z-axis.

z - The linear coordinate along the positive z-axis.

Cylindrical

public Cylindrical(@Nonnull
                   Spherical coordinates)

Initializes a set of Cylindrical coordinates from the provided set of Spherical coordinates.

Parameters:

coordinates - The set of Spherical coordinates.

Cylindrical

public Cylindrical(@Nonnull
                   LongitudeLatitudeRadius coordinates)

Initializes a set of Cylindrical coordinates from the provided set of LongitudeLatitudeRadius coordinates.

Parameters:

coordinates - The set of LongitudeLatitudeRadius coordinates.

Cylindrical

public Cylindrical(@Nonnull
                   Cartesian coordinates)

Initializes a set of Cylindrical coordinates from the provided set of Cartesian coordinates.

Parameters:

coordinates - The set of Cartesian coordinates.

Cylindrical

public Cylindrical(@Nonnull
                   AzimuthElevationRange coordinates)

Initializes a set of Cylindrical coordinates from the provided set of AzimuthElevationRange coordinates.

Parameters:

coordinates - The set of AzimuthElevationRange coordinates.

Cylindrical

public Cylindrical(@Nonnull
                   double[] elements)

Initializes a set of Cylindrical 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.

Cylindrical

public Cylindrical(@Nonnull
                   double[] elements,
                   int startIndex)

Initializes a set of Cylindrical 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 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 Cylindrical getZero()

Gets a set of Cylindrical coordinates with values of zero.

getUndefined

@Nonnull
public static Cylindrical getUndefined()

Gets a set of Cylindrical coordinates with values of Double.NaN.

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

getClock

public final double getClock()

Gets the angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.

getRadial

public final double getRadial()

Gets the linear coordinate perpendicular to the z-axis.

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 Clock (get), Radial (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
                                Cylindrical other)

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

Specified by:

equalsType in interface IEquatable<Cylindrical>

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
                                   Cylindrical 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<Cylindrical>

Parameters:

other - The set of Cylindrical 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 Clock, Radial, and Z.

equals

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