Package civitas.celestis.util.array

Class IntFastArray

java.lang.Object
civitas.celestis.util.array.IntFastArray
All Implemented Interfaces:
BaseArray<Integer>, IntArray, Serializable, Iterable<Integer>
public class IntFastArray extends Object implements IntArray
A basic int array with no built-in synchronization or thread-safety measures.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final int[]
    values
    The internal array of values.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    IntFastArray(int length)
    Creates a new fast int array.
    protected
    IntFastArray(int[] array)
    Creates a new fast int array.
     
    IntFastArray(IntArray a)
    Creates a new fast int array.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    array()
    Returns a primitive array containing the elements of this array in their proper order.
    SafeArray<Integer>
    boxed()
    Returns an array containing the elements of this array in their boxed form.
    boolean
    contains(int v)
    Returns whether this array contains the provided value v.
    boolean
    containsAll(Iterable<Integer> i)
    Returns whether this array contains multiple objects.
    boolean
    equals(Object obj)
    Checks for equality between this array and the provided object obj.
    void
    fill(int v)
    Fills this array with the provided value v.
    void
    fillRange(int s, int e, int v)
    Fills every slot of this array between the range of [s, e) with the provided value v.
    void
    forEach(BiConsumer<? super Integer,? super Integer> a)
    Executes the provided action a once for each element of this array.
    void
    forEach(Consumer<? super Integer> a)
    Executes the provided action a once for each element of this array.
    int
    get(int i)
    Returns the ith element of this array.
    int
    hashCode()
    Returns the hash code of this instance.
    Iterator<Integer>
    iterator()
    Returns an iterator over every element of this array.
    int
    length()
    Returns the length of this array.
    List<Integer>
    list()
    Returns an unmodifiable list containing the elements of this array in their proper order.
    IntArray
    map(IntUnaryOperator f)
    Applies the provided mapper function f to each element of this array, then returns a new array containing the return values of the function f.
    <F> SafeArray<F>
    mapToObj(IntFunction<? extends F> f)
    Applies the provided mapper function f to each element of this array, then returns a new array containing the return values of the function f.
    IntArray
    merge(IntArray a, IntBinaryOperator f)
    Between this array and the provided array a, this applies the merger function f to each corresponding pair of elements, then returns a new array containing the return values of the merger function f.
    void
    replaceAll(int oldValue, int newValue)
    Replaces all instances of the old value to the new value.
    void
    replaceFirst(int oldValue, int newValue)
    Replaces only the first instance of the old value to the new value.
    void
    replaceLast(int oldValue, int newValue)
    Replaces only the last instance of the old value to the new value.
    IntArray
    resize(int size)
    Returns a resized array whose elements are mapped from that of this array's elements.
    void
    set(int i, int e)
    Sets the ith element of this array.
    void
    setRange(int s, int e, IntArray a)
    Sets a sub-array of this array to the values of the provided sub-array a.
    void
    shuffle()
    Shuffles this array, randomizing its elements' order.
    void
    sort()
    Sorts this array by its natural ascending order.
    void
    sort(Comparator<? super Integer> c)
    Sorts this array using the provided comparator function c.
    IntStream
    stream()
    Returns a stream whose source is the elements of this array.
    IntArray
    subArray(int s, int e)
    Returns a sub-array of this array which represents a portion of this array between the range of [s, e).
    String
    toString()
    Serializes this array into a string.
    IntTuple
    tuple()
    Returns a tuple containing the elements of this array in their proper order.
    void
    update(int i, IntUnaryOperator f)
    Updates the ith element of this array with the provided update function f.
    void
    update(BiFunction<? super Integer,? super Integer,Integer> f)
    Applies the provided update function f to each element of this array, then assigns the return value of the function to the corresponding index of this array.
    void
    update(IntUnaryOperator f)
    Applies the provided update function f to each element of this array, then assigns the return value of the function to the corresponding index of this array.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface civitas.celestis.util.array.IntArray

    append, filter, prepend

    Methods inherited from interface java.lang.Iterable

    spliterator

  • Field Details

    • values

      @Nonnull protected final int[] values
      The internal array of values.

  • Constructor Details

    • IntFastArray

      public IntFastArray(int length)
      Creates a new fast int array.
      Parameters:
      length - The length to initialize this array to

    • IntFastArray

      public IntFastArray(@Nonnull IntArray a)
      Creates a new fast int array.
      Parameters:
      a - The array of which to copy elements from

    • IntFastArray

      protected IntFastArray(@Nonnull int[] array)
      Creates a new fast int array. This is a direct assignment constructor, and thus is hidden to ensure safe usage.
      Parameters:
      array - The array of which to directly assign as the internal array

  • Method Details

    • length

      public int length()
      Returns the length of this array.
      Specified by:
      length in interface BaseArray<Integer>
      Specified by:
      length in interface IntArray
      Returns:
      The number of elements this array contains

    • contains

      public boolean contains(int v)
      Returns whether this array contains the provided value v.
      Specified by:
      contains in interface IntArray
      Parameters:
      v - The value to check for containment
      Returns:
      true if at least one element of this array is equal to the provided value v

    • containsAll

      public boolean containsAll(@Nonnull Iterable<Integer> i)
      Returns whether this array contains multiple objects.
      Specified by:
      containsAll in interface IntArray
      Parameters:
      i - The iterable object of which to check for containment
      Returns:
      true if this array contains every element of the iterable object

    • get

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

    • set

      public void set(int i, int e) throws IndexOutOfBoundsException
      Sets the ith element of this array.
      Specified by:
      set in interface IntArray
      Parameters:
      i - The index of the element to set
      e - The element of which to set to
      Throws:
      IndexOutOfBoundsException - When the index i is out of bounds

    • update

      public void update(int i, @Nonnull IntUnaryOperator f) throws IndexOutOfBoundsException
      Updates the ith element of this array with the provided update function f.
      Specified by:
      update in interface IntArray
      Parameters:
      i - The index of the element to update
      f - The update function of which to apply to the element
      Throws:
      IndexOutOfBoundsException - When the index i is out of bounds

    • fill

      public void fill(int v)
      Fills this array with the provided value v. Every element will be reassigned.
      Specified by:
      fill in interface IntArray
      Parameters:
      v - The value to fill this array with

    • fillRange

      public void fillRange(int s, int e, int v)
      Fills every slot of this array between the range of [s, e) with the provided value v.
      Specified by:
      fillRange in interface IntArray
      Parameters:
      s - The starting index at which to start assigning values from
      e - The ending index at which to stop assigning values at
      v - The value of which to assign to every slot within the specified range

    • update

      public void update(@Nonnull IntUnaryOperator f)
      Applies the provided update function f to each element of this array, then assigns the return value of the function to the corresponding index of this array.
      Specified by:
      update in interface IntArray
      Parameters:
      f - The function of which to apply to each element of this array

    • update

      public void update(@Nonnull BiFunction<? super Integer,? super Integer,Integer> f)
      Applies the provided update function f to each element of this array, then assigns the return value of the function to the corresponding index of this array. The first parameter is the index of the value which was provided.
      Specified by:
      update in interface IntArray
      Parameters:
      f - The function of which to apply to each element of this array

    • replaceAll

      public void replaceAll(int oldValue, int newValue)
      Replaces all instances of the old value to the new value.
      Specified by:
      replaceAll in interface IntArray
      Parameters:
      oldValue - The old value to replace
      newValue - The new value to replace to

    • replaceFirst

      public void replaceFirst(int oldValue, int newValue)
      Replaces only the first instance of the old value to the new value. (starting from index 0, and incrementing upwards)
      Specified by:
      replaceFirst in interface IntArray
      Parameters:
      oldValue - The old value to replace
      newValue - The new value to replace to

    • replaceLast

      public void replaceLast(int oldValue, int newValue)
      Replaces only the last instance of the old value to the new value. (starting from the last index, and decrementing downwards)
      Specified by:
      replaceLast in interface IntArray
      Parameters:
      oldValue - The old value to replace
      newValue - The new value to replace to

    • subArray

      @Nonnull public IntArray subArray(int s, int e) throws IndexOutOfBoundsException
      Returns a sub-array of this array which represents a portion of this array between the range of [s, e). Changes in the sub-array will be reflected to this array. For example, calling a.subArray(1, 3).fill(null); will have the same effect as setting the values of indices 1, 2 of the original array to null.
      Specified by:
      subArray in interface IntArray
      Parameters:
      s - The starting index at which to start creating the sub-array (inclusive)
      e - The ending index at which to stop creating the sub-array (exclusive)
      Returns:
      The sub-array representing the index range of [s, e)
      Throws:
      IndexOutOfBoundsException - When the range is invalid, or is out of bounds

    • setRange

      public void setRange(int s, int e, @Nonnull IntArray a) throws IndexOutOfBoundsException
      Sets a sub-array of this array to the values of the provided sub-array a.
      Specified by:
      setRange in interface IntArray
      Parameters:
      s - The starting index at which to start copying values from (inclusive)
      e - The ending index at which to stop copying values from (exclusive)
      a - The sub-array containing the values to assign to this array
      Throws:
      IndexOutOfBoundsException - When the range is invalid, or is out of bounds

    • resize

      @Nonnull public IntArray resize(int size)
      Returns a resized array whose elements are mapped from that of this array's elements. If the new array is larger than this array, the unmappable part will not be populated, leaving it uninitialized as null.
      Specified by:
      resize in interface IntArray
      Parameters:
      size - The size to resize this array to
      Returns:
      The resized array

    • shuffle

      public void shuffle()
      Shuffles this array, randomizing its elements' order.
      Specified by:
      shuffle in interface BaseArray<Integer>
      Specified by:
      shuffle in interface IntArray

    • sort

      public void sort()
      Sorts this array by its natural ascending order.
      Specified by:
      sort in interface BaseArray<Integer>
      Specified by:
      sort in interface IntArray

    • sort

      public void sort(@Nonnull Comparator<? super Integer> c)
      Sorts this array using the provided comparator function c.
      Specified by:
      sort in interface BaseArray<Integer>
      Specified by:
      sort in interface IntArray
      Parameters:
      c - The comparator function of which to sort this array with

    • map

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

    • mapToObj

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

    • merge

      @Nonnull public IntArray merge(@Nonnull IntArray a, @Nonnull IntBinaryOperator f) throws IllegalArgumentException
      Between this array and the provided array a, this applies the merger function f to each corresponding pair of elements, then returns a new array containing the return values of the merger function f. In other words, this merges the two arrays into a new array using the provided merger function f.
      Specified by:
      merge in interface IntArray
      Parameters:
      a - The array of which to merge this array with
      f - The merger function to handle the merging of the two arrays
      Returns:
      The resulting array
      Throws:
      IllegalArgumentException - When the provided array a's length is different from that of this array's length

    • iterator

      @Nonnull public Iterator<Integer> iterator()
      Returns an iterator over every element of this array.
      Specified by:
      iterator in interface BaseArray<Integer>
      Specified by:
      iterator in interface IntArray
      Specified by:
      iterator in interface Iterable<Integer>
      Returns:
      An iterator over every element of this array

    • forEach

      public void forEach(@Nonnull Consumer<? super Integer> a)
      Executes the provided action a once for each element of this array. A reference to the element is provided as the first parameter of the action.
      Specified by:
      forEach in interface BaseArray<Integer>
      Specified by:
      forEach in interface IntArray
      Specified by:
      forEach in interface Iterable<Integer>
      Parameters:
      a - The action to be performed for each element

    • forEach

      public void forEach(@Nonnull BiConsumer<? super Integer,? super Integer> a)
      Executes the provided action a once for each element of this array. The index of the element is provided as the first parameter of the action, and a reference to the element is provided as the second parameter of the action.
      Specified by:
      forEach in interface BaseArray<Integer>
      Specified by:
      forEach in interface IntArray
      Parameters:
      a - The action to be performed for each element

    • array

      @Nonnull public int[] array()
      Returns a primitive array containing the elements of this array in their proper order.
      Specified by:
      array in interface IntArray
      Returns:
      The primitive array representation of this array

    • stream

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

    • list

      @Nonnull public List<Integer> list()
      Returns an unmodifiable list containing the elements of this array in their proper order.
      Specified by:
      list in interface BaseArray<Integer>
      Specified by:
      list in interface IntArray
      Returns:
      The list representation of this array
      See Also:

    • tuple

      @Nonnull public IntTuple tuple()
      Returns a tuple containing the elements of this array in their proper order. Unlike IntArray.list(), this operation cannot fail as tuples inherently support the usage of null as their values.
      Specified by:
      tuple in interface IntArray
      Returns:
      The tuple representation of this array
      See Also:

    • boxed

      @Nonnull public SafeArray<Integer> boxed()
      Returns an array containing the elements of this array in their boxed form.
      Specified by:
      boxed in interface IntArray
      Returns:
      The boxed object representation of this array
      See Also:

    • equals

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

    • toString

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

    • hashCode

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