Package com.github.tommyettinger.ds

Class BooleanList

java.lang.Object
com.github.tommyettinger.ds.BooleanList
All Implemented Interfaces:
Arrangeable, Ordered.OfBoolean, PrimitiveCollection<Boolean>, PrimitiveCollection.OfBoolean
Direct Known Subclasses:
BooleanBag, BooleanDeque
public class BooleanList extends Object implements PrimitiveCollection.OfBoolean, Ordered.OfBoolean, Arrangeable
A resizable, insertion-ordered boolean list. Primitive-backed, so it avoids the boxing that occurs with an ArrayList of Boolean. This tries to imitate most of the List interface, though it can't implement it without boxing its items. Has a primitive iterator accessible via iterator().
See Also:

  • Field Details

  • Constructor Details

    • BooleanList

      public BooleanList()
      Creates an ordered list with a capacity of 10.

    • BooleanList

      public BooleanList(int capacity)
      Creates an ordered list with the specified capacity.
      Parameters:
      capacity - Any elements added beyond this will cause the backing array to be grown.

    • BooleanList

      @Deprecated public BooleanList(boolean ordered, int capacity)
      Deprecated.
      BooleanList is always ordered; for an unordered list use BooleanBag
      Creates an ordered list with the specified capacity.
      Parameters:
      ordered - ignored; for an unordered list use BooleanBag
      capacity - Any elements added beyond this will cause the backing array to be grown.

    • BooleanList

      public BooleanList(BooleanList list)
      Creates a new list containing the elements in the given list. The new list will be ordered. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.
      Parameters:
      list - another BooleanList (or BooleanBag) to copy from

    • BooleanList

      public BooleanList(boolean[] array)
      Creates a new list containing the elements in the specified array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.
      Parameters:
      array - a boolean array to copy from

    • BooleanList

      public BooleanList(boolean[] array, int startIndex, int count)
      Creates a new list containing the elements in the specified array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.
      Parameters:
      array - a non-null boolean array to add to this list
      startIndex - the first index in array to use
      count - how many items to use from array

    • BooleanList

      @Deprecated public BooleanList(boolean ordered, boolean[] array, int startIndex, int count)
      Deprecated.
      BooleanList is always ordered; for an unordered list use BooleanBag
      Creates a new list containing the elements in the specified array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.
      Parameters:
      ordered - ignored; for an unordered list use BooleanBag
      array - a non-null boolean array to add to this list
      startIndex - the first index in array to use
      count - how many items to use from array

    • BooleanList

      public BooleanList(PrimitiveCollection.OfBoolean coll)
      Creates a new list containing the items in the specified PrimitiveCollection.OfBoolean.
      Parameters:
      coll - a primitive collection that will have its contents added to this

    • BooleanList

      public BooleanList(BooleanIterator coll)
      Creates a new instance containing the items in the specified iterator.
      Parameters:
      coll - an iterator that will have its remaining contents added to this

    • BooleanList

      public BooleanList(Ordered.OfBoolean other)
      Copies the given Ordered.OfBoolean into a new BooleanList.
      Parameters:
      other - another Ordered.OfBoolean that will have its contents copied into this

    • BooleanList

      public BooleanList(Ordered.OfBoolean other, int offset, int count)
      Creates a new list by copying count items from the given Ordered, starting at offset in that Ordered, into this.
      Parameters:
      other - another Ordered.OfBoolean
      offset - the first index in other's ordering to draw an item from
      count - how many items to copy from other

  • Method Details

    • keepsOrder

      public boolean keepsOrder()
      Returns true if this implementation retains order, which it does.
      Returns:
      true

    • size

      public int size()
      Description copied from interface: Arrangeable
      Returns the number of elements in this Arrangeable. Often this is shared with Collection.size(), but isn't always.
      Specified by:
      size in interface Arrangeable
      Specified by:
      size in interface PrimitiveCollection<Boolean>
      Returns:
      the number of elements in this Arrangeable

    • add

      public boolean add(boolean value)
      Specified by:
      add in interface PrimitiveCollection.OfBoolean

    • add

      public void add(boolean value1, boolean value2)

    • add

      public void add(boolean value1, boolean value2, boolean value3)

    • add

      public void add(boolean value1, boolean value2, boolean value3, boolean value4)

    • addAll

      public boolean addAll(BooleanList list)

    • addAll

      public boolean addAll(BooleanList list, int offset, int count)

    • addAll

      public boolean addAll(Ordered.OfBoolean other, int offset, int count)
      Adds up to count items, starting from offset, in the Ordered.OfBoolean other to this list, inserting at the end of the iteration order.
      Parameters:
      other - a non-null Ordered.OfBoolean
      offset - the first index in other to use
      count - how many indices in other to use
      Returns:
      true if this is modified by this call, as addAll(BooleanList) does

    • addAll

      public boolean addAll(int insertionIndex, Ordered.OfBoolean other, int offset, int count)
      Adds up to count items, starting from offset, in the Ordered.OfBoolean other to this list, inserting starting at insertionIndex in the iteration order.
      Parameters:
      insertionIndex - where to insert into the iteration order
      other - a non-null Ordered.OfBoolean
      offset - the first index in other to use
      count - how many indices in other to use
      Returns:
      true if this is modified by this call, as addAll(BooleanList) does

    • addAll

      public boolean addAll(boolean... array)
      Specified by:
      addAll in interface PrimitiveCollection.OfBoolean

    • addAll

      public boolean addAll(boolean[] array, int offset, int length)
      Specified by:
      addAll in interface PrimitiveCollection.OfBoolean

    • get

      public boolean get(int index)

    • set

      public void set(int index, boolean value)

    • and

      public void and(int index, boolean value)

    • or

      public void or(int index, boolean value)

    • xor

      public void xor(int index, boolean value)

    • not

      public void not(int index)

    • insert

      public void insert(int index, boolean value)

    • duplicateRange

      public boolean duplicateRange(int index, int count)
      Inserts the specified number of items at the specified index. The new items will have values equal to the values at those indices before the insertion, and the previous values will be pushed to after the duplicated range.
      Parameters:
      index - the first index to duplicate
      count - how many items to duplicate

    • order

      public BooleanList order()
      Returns this BooleanList, since it is its own order. This is only here to satisfy the Ordered.OfBoolean interface.
      Specified by:
      order in interface Ordered.OfBoolean
      Returns:
      this BooleanList

    • swap

      public void swap(int first, int second)
      Description copied from interface: Ordered.OfBoolean
      Switches the ordering of positions first and second, without changing any items beyond that.
      Specified by:
      swap in interface Arrangeable
      Specified by:
      swap in interface Ordered.OfBoolean
      Parameters:
      first - the first position, must not be negative and must be less than Arrangeable.size()
      second - the second position, must not be negative and must be less than Arrangeable.size()

    • contains

      public boolean contains(boolean value)
      Specified by:
      contains in interface PrimitiveCollection.OfBoolean

    • containsAll

      public boolean containsAll(BooleanList other)
      Returns true if this BooleanList contains, at least once, every item in other; otherwise returns false.
      Parameters:
      other - an BooleanList
      Returns:
      true if this contains every item in other, otherwise false

    • indexOf

      public int indexOf(boolean value)
      Returns the first index in this list that contains the specified value, or -1 if it is not present.
      Parameters:
      value - a boolean value to search for
      Returns:
      the first index of the given value, or -1 if it is not present

    • lastIndexOf

      public int lastIndexOf(boolean value)
      Returns the last index in this list that contains the specified value, or -1 if it is not present.
      Parameters:
      value - a boolean value to search for
      Returns:
      the last index of the given value, or -1 if it is not present

    • remove

      public boolean remove(boolean value)
      Removes the first occurrence of value from this BooleanList, returning true if anything was removed. Otherwise, this returns false.
      Specified by:
      remove in interface PrimitiveCollection.OfBoolean
      Parameters:
      value - the value to (attempt to) remove
      Returns:
      true if a value was removed, false if the BooleanList is unchanged

    • removeAt

      public boolean removeAt(int index)
      Removes and returns the item at the specified index. Note that this is equivalent to List.remove(int), but can't have that name because we also have remove(boolean) that removes a value, rather than an index.
      Parameters:
      index - the index of the item to remove and return
      Returns:
      the removed item

    • removeRange

      public void removeRange(int start, int end)
      Removes the items between the specified start index, inclusive, and end index, exclusive. Note that this takes different arguments than some other range-related methods; this needs a start index and an end index, rather than a count of items. This matches the behavior in the JDK collections.
      Specified by:
      removeRange in interface Ordered.OfBoolean
      Parameters:
      start - the first index to remove, inclusive
      end - the last index (after what should be removed), exclusive

    • removeAll

      public boolean removeAll(PrimitiveCollection.OfBoolean c)
      Removes from this BooleanList all occurrences of any elements contained in the specified collection.
      Specified by:
      removeAll in interface PrimitiveCollection.OfBoolean
      Parameters:
      c - a primitive collection of int items to remove fully, such as another BooleanList or a BooleanDeque
      Returns:
      true if this list was modified.

    • removeEach

      public boolean removeEach(PrimitiveCollection.OfBoolean c)
      Removes from this BooleanList element-wise occurrences of elements contained in the specified collection. Note that if a value is present more than once in this BooleanList, only one of those occurrences will be removed for each occurrence of that value in c. If c has the same contents as this BooleanList or has additional items, then removing each of c will clear this.
      Specified by:
      removeEach in interface PrimitiveCollection.OfBoolean
      Parameters:
      c - a primitive collection of int items to remove one-by-one, such as another BooleanList or a BooleanDeque
      Returns:
      true if this list was modified.

    • retainAll

      public boolean retainAll(PrimitiveCollection.OfBoolean other)
      Removes all items from this BooleanList that are not present somewhere in other, any number of times.
      Specified by:
      retainAll in interface PrimitiveCollection.OfBoolean
      Parameters:
      other - a PrimitiveCollection.OfBoolean that contains the items that this should keep, whenever present
      Returns:
      true if this BooleanList changed as a result of this call, otherwise false

    • replaceAll

      public void replaceAll(com.github.tommyettinger.function.BooleanPredicate operator)
      Replaces each element of this list with the result of applying the given operator to that element.
      Parameters:
      operator - a BooleanPredicate (a functional interface defined in funderby)

    • replaceFirst

      public boolean replaceFirst(boolean find, boolean replace)
      Replaces the first occurrence of find with replace. Returns true if it performed the replacement, or false if there was nothing to replace. This also returns false if find and replace are the same.
      Parameters:
      find - the item to search for
      replace - the item to replace find with, if possible
      Returns:
      true if this changed, or false otherwise

    • replaceAll

      public int replaceAll(boolean find, boolean replace)
      Replaces every occurrence of find with replace. Returns the number of changed items, which is 0 if nothing was found or in the case that find and replace are the same.
      Parameters:
      find - the item to search for
      replace - the item to replace find with, if possible
      Returns:
      the number of replacements that occurred; 0 if nothing was found or replaced

    • pop

      public boolean pop()
      Removes and returns the last item.
      Returns:
      the last item, removed from this

    • peek

      public boolean peek()
      Returns the last item.
      Returns:
      the last item, without modifying this

    • first

      public boolean first()
      Returns the first item.
      Specified by:
      first in interface PrimitiveCollection.OfBoolean
      Returns:
      the first item, without modifying this

    • notEmpty

      public boolean notEmpty()
      Returns true if the list has one or more items, or false otherwise.
      Specified by:
      notEmpty in interface PrimitiveCollection<Boolean>
      Returns:
      true if the list has one or more items, or false otherwise

    • isEmpty

      public boolean isEmpty()
      Returns true if the list is empty.
      Specified by:
      isEmpty in interface PrimitiveCollection<Boolean>
      Returns:
      true if the list is empty, or false if it has any items

    • clear

      public void clear()
      Effectively removes all items from this BooleanList. This is done simply by setting size to 0; because a boolean item isn't a reference, it doesn't need to be set to null.
      Specified by:
      clear in interface PrimitiveCollection<Boolean>

    • shrink

      public boolean[] shrink()
      Reduces the size of the backing array to the size of the actual items. This is useful to release memory when many items have been removed, or if it is known that more items will not be added.
      Returns:
      items; this will be a different reference if this resized

    • trimToSize

      public void trimToSize()

    • ensureCapacity

      public boolean[] ensureCapacity(int additionalCapacity)
      Increases the size of the backing array to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.
      Returns:
      items; this will be a different reference if this resized

    • setSize

      public boolean[] setSize(int newSize)
      Sets the list size, leaving any values beyond the current size undefined.
      Returns:
      items; this will be a different reference if this resized to a larger capacity

    • resize

      protected boolean[] resize(int newSize)

    • sort

      public void sort()
      Sorts this entire collection using BooleanComparators.sort(boolean[], int, int, BooleanComparator) in ascending order (false, then true).

    • sort

      public void sort(int from, int to)
      Uses BooleanComparators.sort(boolean[], int, int, BooleanComparator) to sort a (clamped) subrange of this collection in ascending order (false, then true).
      Parameters:
      from - the index of the first element (inclusive) to be sorted
      to - the index of the last element (exclusive) to be sorted

    • sort

      public void sort(BooleanComparator c)
      Sorts all elements according to the order induced by the specified comparator using BooleanComparators.sort(boolean[], int, int, BooleanComparator). If c is null, this uses BooleanComparators.NATURAL_COMPARATOR as its c (which sorts false before true).

      This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort. The sorting algorithm is an in-place mergesort that is significantly slower than a standard mergesort, as its running time is O(n (log n)2), but it does not allocate additional memory; as a result, it can be used as a generic sorting algorithm.

      Specified by:
      sort in interface Ordered.OfBoolean
      Parameters:
      c - the comparator to determine the order of the BooleanList

    • sort

      public void sort(int from, int to, BooleanComparator c)
      Sorts the specified (clamped) subrange of elements according to the order induced by the specified comparator using mergesort, or BooleanComparators.NATURAL_COMPARATOR if c is null (which sorts false before true). This purely uses BooleanComparators.sort(boolean[], int, int, BooleanComparator), and you can see its docs for more information.
      Parameters:
      from - the index of the first element (inclusive) to be sorted.
      to - the index of the last element (exclusive) to be sorted.
      c - the comparator to determine the order of the BooleanList

    • reverse

      public void reverse()
      Description copied from interface: Ordered.OfBoolean
      Reverses the order of this Ordered in-place.
      Specified by:
      reverse in interface Arrangeable
      Specified by:
      reverse in interface Ordered.OfBoolean

    • shuffle

      public void shuffle(Random random)
      Description copied from interface: Ordered.OfBoolean
      Pseudo-randomly shuffles the order of this Ordered in-place. You can seed rng, the random number generator, with an identical seed to reproduce a shuffle on two Ordered with the same Arrangeable.size().
      Specified by:
      shuffle in interface Arrangeable
      Specified by:
      shuffle in interface Ordered.OfBoolean
      Parameters:
      random - any Random class, such as one from juniper

    • truncate

      public void truncate(int newSize)
      Reduces the size of the list to the specified size. If the list is already smaller than the specified size, no action is taken.

    • random

      public boolean random(Random random)
      Returns a random item from the list, or false if the list is empty.
      Specified by:
      random in interface Ordered.OfBoolean
      Parameters:
      random - a Random or a subclass, such as any from juniper
      Returns:
      a randomly selected item from this, or false if this is empty

    • toArray

      public boolean[] toArray()
      Allocates a new boolean array with size elements and fills it with the items in this.
      Specified by:
      toArray in interface PrimitiveCollection.OfBoolean
      Returns:
      a new boolean array with the same contents as this

    • toArray

      public boolean[] toArray(boolean[] array)
      If array.length at least equal to size(), this copies the contents of this into array and returns it; otherwise, it allocates a new boolean array that can fit all the items in this, and proceeds to copy into that and return that.
      Specified by:
      toArray in interface PrimitiveCollection.OfBoolean
      Parameters:
      array - a boolean array that will be modified if it can fit size() items
      Returns:
      array, if it had sufficient size, or a new array otherwise, either with a copy of this

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface PrimitiveCollection<Boolean>
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Specified by:
      equals in interface PrimitiveCollection<Boolean>
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • iterator

      public BooleanList.BooleanListIterator iterator()
      Returns a Java 8 primitive iterator over the int items in this BooleanList. Iterates in order if keepsOrder() returns true, which it does for a BooleanList but not a BooleanBag.
      This will reuse one of two iterators in this BooleanList; this does not allow nested iteration. Use BooleanListIterator(BooleanList) to nest iterators.
      Specified by:
      iterator in interface PrimitiveCollection<Boolean>
      Specified by:
      iterator in interface PrimitiveCollection.OfBoolean
      Returns:
      a BooleanIterator; use its nextBoolean() method instead of next()

    • with

      public static BooleanList with()
      Constructs an empty list. This is usually less useful than just using the constructor, but can be handy in some code-generation scenarios when you don't know how many arguments you will have.
      Returns:
      a new list containing nothing

    • with

      public static BooleanList with(boolean item)
      Creates a new BooleanList that holds only the given item, but can be resized.
      Parameters:
      item - a boolean item
      Returns:
      a new BooleanList that holds the given item

    • with

      public static BooleanList with(boolean item0, boolean item1)
      Creates a new BooleanList that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      Returns:
      a new BooleanList that holds the given items

    • with

      public static BooleanList with(boolean item0, boolean item1, boolean item2)
      Creates a new BooleanList that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      Returns:
      a new BooleanList that holds the given items

    • with

      public static BooleanList with(boolean item0, boolean item1, boolean item2, boolean item3)
      Creates a new BooleanList that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      Returns:
      a new BooleanList that holds the given items

    • with

      public static BooleanList with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4)
      Creates a new BooleanList that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      Returns:
      a new BooleanList that holds the given items

    • with

      public static BooleanList with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4, boolean item5)
      Creates a new BooleanList that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      item5 - a boolean item
      Returns:
      a new BooleanList that holds the given items

    • with

      public static BooleanList with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4, boolean item5, boolean item6)
      Creates a new BooleanList that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      item5 - a boolean item
      item6 - a boolean item
      Returns:
      a new BooleanList that holds the given items

    • with

      public static BooleanList with(boolean item0, boolean item1, boolean item2, boolean item3, boolean item4, boolean item5, boolean item6, boolean item7)
      Creates a new BooleanList that holds only the given items, but can be resized.
      Parameters:
      item0 - a boolean item
      item1 - a boolean item
      item2 - a boolean item
      item3 - a boolean item
      item4 - a boolean item
      item5 - a boolean item
      item6 - a boolean item
      Returns:
      a new BooleanList that holds the given items

    • with

      public static BooleanList with(boolean... varargs)
      Creates a new BooleanList that holds only the given items, but can be resized. This overload will only be used when an array is supplied and the type of the items requested is the component type of the array, or if varargs are used and there are 9 or more arguments.
      Parameters:
      varargs - a boolean varargs or boolean array; remember that varargs allocate
      Returns:
      a new BooleanList that holds the given items

    • parse

      public static BooleanList parse(String str, String delimiter)
      Calls parse(String, String, boolean) with brackets set to false.
      Parameters:
      str - a String that will be parsed in full
      delimiter - the delimiter between items in str
      Returns:
      a new collection parsed from str

    • parse

      public static BooleanList parse(String str, String delimiter, boolean brackets)
      Creates a new collection and fills it by calling PrimitiveCollection.OfBoolean.addLegible(String, String, int, int) on either all of str (if brackets is false) or str without its first and last chars (if brackets is true). Each item is expected to be separated by delimiter.
      Parameters:
      str - a String that will be parsed in full (depending on brackets)
      delimiter - the delimiter between items in str
      brackets - if true, the first and last chars in str will be ignored
      Returns:
      a new collection parsed from str

    • parse

      public static BooleanList parse(String str, String delimiter, int offset, int length)
      Creates a new collection and fills it by calling PrimitiveCollection.OfBoolean.addLegible(String, String, int, int) with the given four parameters as-is.
      Parameters:
      str - a String that will have the given section parsed
      delimiter - the delimiter between items in str
      offset - the first position to parse in str, inclusive
      length - how many chars to parse, starting from offset
      Returns:
      a new collection parsed from str