Package civitas.celestis.util.tuple

Class Double2

java.lang.Object
civitas.celestis.util.tuple.Double2
All Implemented Interfaces:
BaseTuple<Double>, DoubleTuple, Serializable
Direct Known Subclasses:
Vector2
public class Double2 extends Object implements DoubleTuple
An immutable type containing two primitive doubles.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final double
    x
    The X component of this tuple.
    protected final double
    y
    The Y component of this tuple.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Double2(double[] components)
    Creates a new Double2.
    Double2(double x, double y)
    Creates a new Double2.
    Double2(DoubleTuple t)
    Creates a new Double2.

  • Method Summary

    Modifier and Type
    Method
    Description
    double[]
    array()
    Returns an array containing the components of this tuple in their proper order.
    Tuple<Double>
    boxed()
    Returns a tuple containing the components of this tuple in their boxed form.
    boolean
    contains(double v)
    Checks if this tuple contains the provided value v.
    boolean
    containsAll(Iterable<Double> i)
    Checks if this tuple contains multiple values.
    boolean
    equals(Object obj)
    Checks for equality between this tuple and the provided object obj.
    double
    get(int i)
    Returns the ith component of this tuple.
    int
    hashCode()
    Returns the hash code of this instance.
    boolean
    isFinite()
    Returns whether this tuple is finite.
    boolean
    isInfinite()
    Returns whether this tuple is infinite.
    boolean
    isNaN()
    Returns whether this tuple contains Double.NaN.
    boolean
    isZero()
    Returns whether this tuple represents zero.
    List<Double>
    list()
    Returns an unmodifiable list containing the components of this tuple in their proper order.
    Double2
    map(DoubleUnaryOperator f)
    Applies the provided mapper function f to each component of this tuple, then returns a new tuple containing the return values of the function f.
    <F> Tuple<F>
    mapToObj(DoubleFunction<? extends F> f)
    Applies the provided mapper function f to each component of this tuple, then returns a new tuple containing the return values of the function f.
    int
    size()
    Returns the size of this tuple.
    DoubleStream
    stream()
    Returns a stream whose source is the elements of this tuple.
    String
    toString()
    Serializes this tuple into a string.
    double
    x()
    Returns the X component of this tuple.
    double
    y()
    Returns the Y component of this tuple.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface civitas.celestis.util.tuple.DoubleTuple

    doubleArray

  • Field Details

    • x

      protected final double x
      The X component of this tuple.

    • y

      protected final double y
      The Y component of this tuple.

  • Constructor Details

    • Double2

      public Double2(double x, double y)
      Creates a new Double2.
      Parameters:
      x - The X component of this tuple
      y - The Y component of this tuple

    • Double2

      public Double2(@Nonnull double[] components)
      Creates a new Double2.
      Parameters:
      components - An array containing the components of this tuple in XY order
      Throws:
      IllegalArgumentException - When the provided array's length is not 2

    • Double2

      public Double2(@Nonnull DoubleTuple t)
      Creates a new Double2.
      Parameters:
      t - The tuple of which to copy component values from
      Throws:
      IllegalArgumentException - When the provided tuple t's size is not 2

  • Method Details

    • size

      public int size()
      Returns the size of this tuple. (the number of components it has)
      Specified by:
      size in interface BaseTuple<Double>
      Specified by:
      size in interface DoubleTuple
      Returns:
      The number of components this tuple has

    • isZero

      public boolean isZero()
      Returns whether this tuple represents zero. (whether every component is zero)
      Specified by:
      isZero in interface DoubleTuple
      Returns:
      true if every component of this tuple is zero

    • isNaN

      public boolean isNaN()
      Returns whether this tuple contains Double.NaN.
      Specified by:
      isNaN in interface DoubleTuple
      Returns:
      true if at least one component of this tuple is not a number
      See Also:

    • isFinite

      public boolean isFinite()
      Returns whether this tuple is finite.
      Specified by:
      isFinite in interface DoubleTuple
      Returns:
      true if every component of this tuple is finite
      See Also:

    • isInfinite

      public boolean isInfinite()
      Returns whether this tuple is infinite.
      Specified by:
      isInfinite in interface DoubleTuple
      Returns:
      true if at least one component of this tuple is infinite
      See Also:

    • contains

      public boolean contains(double v)
      Checks if this tuple contains the provided value v.
      Specified by:
      contains in interface DoubleTuple
      Parameters:
      v - The value of which to check for containment
      Returns:
      true if at least one component of this tuple is equal to the provided value v

    • containsAll

      public boolean containsAll(@Nonnull Iterable<Double> i)
      Checks if this tuple contains multiple values.
      Specified by:
      containsAll in interface DoubleTuple
      Parameters:
      i - The iterable object of which to check for containment
      Returns:
      true if this tuple contains every component of the iterable object

    • get

      public double get(int i) throws IndexOutOfBoundsException
      Returns the ith component of this tuple.
      Specified by:
      get in interface DoubleTuple
      Parameters:
      i - The index of the component to get
      Returns:
      The ith component of this tuple
      Throws:
      IndexOutOfBoundsException - When the index i is out of bounds

    • x

      public double x()
      Returns the X component of this tuple.
      Returns:
      The X component of this tuple

    • y

      public double y()
      Returns the Y component of this tuple.
      Returns:
      The Y component of this tuple

    • map

      @Nonnull public Double2 map(@Nonnull DoubleUnaryOperator f)
      Applies the provided mapper function f to each component of this tuple, then returns a new tuple containing the return values of the function f.
      Specified by:
      map in interface DoubleTuple
      Parameters:
      f - The function of which to apply to each component of this tuple
      Returns:
      The resulting tuple

    • mapToObj

      @Nonnull public <F> Tuple<F> mapToObj(@Nonnull DoubleFunction<? extends F> f)
      Applies the provided mapper function f to each component of this tuple, then returns a new tuple containing the return values of the function f.
      Specified by:
      mapToObj in interface DoubleTuple
      Type Parameters:
      F - The type of component to map this tuple to
      Parameters:
      f - The function of which to apply to each component of this tuple
      Returns:
      The resulting tuple

    • array

      @Nonnull public double[] array()
      Returns an array containing the components of this tuple in their proper order.
      Specified by:
      array in interface DoubleTuple
      Returns:
      The array representation of this tuple

    • stream

      @Nonnull public DoubleStream stream()
      Returns a stream whose source is the elements of this tuple.
      Specified by:
      stream in interface DoubleTuple
      Returns:
      A stream whose source is the elements of this tuple
      See Also:

    • list

      @Nonnull public List<Double> list()
      Returns an unmodifiable list containing the components of this tuple in their proper order.
      Specified by:
      list in interface BaseTuple<Double>
      Specified by:
      list in interface DoubleTuple
      Returns:
      The list representation of this tuple
      See Also:

    • boxed

      @Nonnull public Tuple<Double> boxed()
      Returns a tuple containing the components of this tuple in their boxed form.
      Specified by:
      boxed in interface DoubleTuple
      Returns:
      The boxed object representation of this tuple
      See Also:

    • equals

      public boolean equals(@Nullable Object obj)
      Checks for equality between this tuple and the provided object obj.
      Specified by:
      equals in interface DoubleTuple
      Overrides:
      equals in class Object
      Parameters:
      obj - The object to compare to
      Returns:
      true if the other object is also a double tuple, and the number of components, the order of the components, and the components' values are all equal

    • toString

      @Nonnull public String toString()
      Serializes this tuple into a string.
      Specified by:
      toString in interface DoubleTuple
      Overrides:
      toString in class Object
      Returns:
      The string representation of this tuple

    • hashCode

      public int hashCode()
      Returns the hash code of this instance.
      Overrides:
      hashCode in class Object
      Returns:
      The hash code of this instance