agi.foundation.coordinates

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

Class Polar

java.lang.Object

agi.foundation.coordinates.Polar

All Implemented Interfaces:

IEquatable<Polar>, ImmutableValueType, ValueType, IEquatableEpsilon<Polar>

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

A set of curvilinear 2-dimensional coordinates.

The corresponding 3-dimensional coordinates are Cylindrical coordinates.

Constructor Summary

Constructors

Constructor and Description
Polar() Initializes a new instance.
Polar(double[] elements) Initializes a set of Polar coordinates from the first 2 consecutive elements in the provided array.
Polar(double[] elements, int startIndex) Initializes a set of Polar coordinates from 2 consecutive elements in the provided array.
Polar(double clock, double radial) Initializes a set of Polar coordinates from the provided values.
Polar(Rectangular coordinates) Initializes a set of Polar coordinates from the provided set of Rectangular coordinates.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(Polar left, Polar right) Returns true if the two instances are exactly equal.
boolean	equalsEpsilon(Polar 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(Polar 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 and 1 corresponding to the coordinates Clock (get), and Radial (get).
double	getClock() Gets the angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
int	getLength() Gets the number of elements in this set of coordinates.
double	getRadial() Gets the linear coordinate perpendicular to the z-axis.
static Polar	getZero() Gets a set of Polar 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(Polar left, Polar 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

Polar

public Polar()

Initializes a new instance.

Polar

public Polar(double clock,
             double radial)

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

Polar

public Polar(@Nonnull
             Rectangular coordinates)

Initializes a set of Polar coordinates from the provided set of Rectangular coordinates.

Parameters:

coordinates - The set of Rectangular coordinates.

Polar

public Polar(@Nonnull
             double[] elements)

Initializes a set of Polar coordinates from the first 2 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 2 elements.

Polar

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

Initializes a set of Polar coordinates from 2 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 2 elements.

Method Detail

getZero

@Nonnull
public static Polar getZero()

Gets a set of Polar coordinates with values of zero.

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.

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 and 1 corresponding to the coordinates Clock (get), and Radial (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
                                Polar other)

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

Specified by:

equalsType in interface IEquatable<Polar>

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

Parameters:

other - The set of Polar 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.

equals

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