Package civitas.celestis.util.tuple

Interface IntTuple

All Superinterfaces:
BaseTuple<Integer>, Serializable
All Known Implementing Classes:
Int1, Int2, Int3, Int4, IntArrayTuple
public interface IntTuple extends BaseTuple<Integer>
A specialized tuple which holds the primitive type int. Integer tuples * can be converted to their boxed form by calling boxed().
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    array()
    Returns an array containing the components of this tuple in their proper order.
    Tuple<Integer>
    boxed()
    Returns a tuple containing the components of this tuple in their boxed form.
    boolean
    contains(int v)
    Checks if this tuple contains the provided value v.
    boolean
    containsAll(Iterable<Integer> i)
    Checks if this tuple contains multiple values.
    static IntTuple
    empty()
    Returns an empty integer tuple.
    boolean
    equals(Object obj)
    Checks for equality between this tuple and the provided object obj.
    int
    get(int i)
    Returns the ith component of this tuple.
    default IntArray
    intArray()
    Returns an integer array containing the components of this tuple in their proper order.
    boolean
    isZero()
    Returns whether this tuple represents zero.
    List<Integer>
    list()
    Returns an unmodifiable list containing the components of this tuple in their proper order.
    IntTuple
    map(IntUnaryOperator 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(IntFunction<? 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.
    static IntTuple
    of(int... components)
    Creates a new integer tuple from the provided array of components.
    int
    size()
    Returns the size of this tuple.
    IntStream
    stream()
    Returns a stream whose source is the elements of this tuple.
    String
    toString()
    Serializes this tuple into a string.

  • Method Details

    • of

      @Nonnull static IntTuple of(@Nonnull int... components)
      Creates a new integer tuple from the provided array of components.
      Parameters:
      components - The components of which to construct the tuple from
      Returns:
      A tuple constructed from the provided components

    • empty

      @Nonnull static IntTuple empty()
      Returns an empty integer tuple.
      Returns:
      An empty integer tuple

    • size

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

    • isZero

      boolean isZero()
      Returns whether this tuple represents zero. (whether every component is zero)
      Returns:
      true if every component of this tuple is zero

    • contains

      boolean contains(int v)
      Checks if this tuple contains the provided value v.
      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

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

    • get

      int get(int i) throws IndexOutOfBoundsException
      Returns the ith component of this tuple.
      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

    • mapToObj

      @Nonnull <F> Tuple<F> mapToObj(@Nonnull IntFunction<? 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.
      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

    • map

      @Nonnull IntTuple map(@Nonnull IntUnaryOperator 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.
      Parameters:
      f - The function of which to apply to each component of this tuple
      Returns:
      The resulting tuple

    • array

      @Nonnull int[] array()
      Returns an array containing the components of this tuple in their proper order.
      Returns:
      The array representation of this tuple

    • intArray

      @Nonnull default IntArray intArray()
      Returns an integer array containing the components of this tuple in their proper order.
      Returns:
      The array representation of this tuple
      See Also:

    • stream

      @Nonnull IntStream stream()
      Returns a stream whose source is the elements of this tuple.
      Returns:
      A stream whose source is the elements of this tuple
      See Also:

    • list

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

    • boxed

      @Nonnull Tuple<Integer> boxed()
      Returns a tuple containing the components of this tuple in their boxed form.
      Returns:
      The boxed object representation of this tuple
      See Also:

    • equals

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

    • toString

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