Package com.github.tommyettinger.ds

Class DoubleDeque

java.lang.Object
com.github.tommyettinger.ds.DoubleList
com.github.tommyettinger.ds.DoubleDeque
All Implemented Interfaces:
Arrangeable, Ordered.OfDouble, PrimitiveCollection<Double>, PrimitiveCollection.OfDouble, RandomAccess
public class DoubleDeque extends DoubleList implements RandomAccess, Arrangeable, PrimitiveCollection.OfDouble, Ordered.OfDouble
A resizable, insertion-ordered double-ended queue of primitive double with efficient add and remove at the beginning and end. This extends DoubleList and supports RandomAccess. Like DoubleList, it is a PrimitiveCollection.OfDouble, Arrangeable, and Ordered.OfDouble. Values in the backing array may wrap back to the beginning, making add and remove at the beginning and end O(1) (unless the backing array needs to resize when adding). Deque functionality is provided via removeLast() and addFirst(double).
Unlike most Deque implementations in the JDK, you can get and set items anywhere in the deque in constant time with get(int) and set(int, double). Relative to a DoubleList, get(int) has slightly higher overhead, but it still runs in constant time. Unlike ArrayDeque in the JDK, this implements equals(Object) and hashCode(). This can provide what are effectively ListIterators for iteration from an index or in reverse order.
Unlike ArrayDeque or ArrayList, most methods that take an index here try to be "forgiving;" that is, they treat negative indices as index 0, and too-large indices as the last index, rather than throwing an Exception, except in some cases where the DoubleDeque is empty and an item from it is required. An exception is in set(int, double), which allows prepending by setting a negative index, or appending by setting a too-large index. This isn't a standard JDK behavior, and it doesn't always act how Deque or List is documented.
Some new methods are present here, or have been made public when they weren't before. removeRange(int, int), for instance, is now public, as is resize(int). New APIs include Deque-like methods that affect the middle of the deque, such as peekAt(int) and pollAt(int). There are more bulk methods that work at the head or tail region of the deque, such as addAllFirst(OfDouble) and truncateFirst(int). There are the methods from Arrangeable, and many default methods from PrimitiveCollection and Ordered.
In general, this is an improvement over ArrayDeque in every type of functionality, and is mostly equivalent to DoubleList as long as the performance of get(int) is adequate. Because it is array-backed, it should usually be much faster than LinkedList, as well; only periodic resizing and modifications in the middle of the List using an iterator should be typically faster for LinkedList.

  • Field Details

    • defaultValue

      public double defaultValue
      The value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque.

    • tail

      protected int tail
      Index of last element. Logically bigger than head. Unless empty, it points to a valid element inside the deque. This may be the same as head, and is if there is one element in the deque (or none), that will be the case.

    • descendingIterator1

      protected transient DoubleDeque.DoubleDequeIterator descendingIterator1

    • descendingIterator2

      protected transient DoubleDeque.DoubleDequeIterator descendingIterator2

  • Constructor Details

    • DoubleDeque

      public DoubleDeque()
      Creates a new DoubleDeque which can hold 16 values without needing to resize the backing array.

    • DoubleDeque

      public DoubleDeque(int initialSize)
      Creates a new DoubleDeque which can hold the specified number of values without needing to resize the backing array.
      Parameters:
      initialSize - how large the backing array should be, without any padding

    • DoubleDeque

      public DoubleDeque(PrimitiveCollection.OfDouble coll)
      Creates a new DoubleDeque using all the contents of the given Collection.
      Parameters:
      coll - a Collection of double that will be copied into this and used in full
      Throws:
      NullPointerException - if coll is null

    • DoubleDeque

      public DoubleDeque(DoubleIterator iter)
      Creates a new instance containing the items in the specified iterator.
      Parameters:
      iter - an iterator that will have its remaining contents added to this
      Throws:
      NullPointerException - if iter is null

    • DoubleDeque

      public DoubleDeque(DoubleDeque deque)
      Copies the given DoubleDeque exactly into this one. Individual values will be shallow-copied.
      Parameters:
      deque - another DoubleDeque to copy
      Throws:
      NullPointerException - if deque is null

    • DoubleDeque

      public DoubleDeque(Ordered.OfDouble other, int offset, int count)

    • DoubleDeque

      public DoubleDeque(double[] a)
      Creates a new DoubleDeque using all the contents of the given array.
      Parameters:
      a - an array of double that will be copied into this and used in full
      Throws:
      NullPointerException - if a is null

    • DoubleDeque

      public DoubleDeque(double[] a, int offset, int count)
      Creates a new DoubleDeque using count items from a, starting at offset. If count is 0 or less, this will create an empty DoubleDeque with capacity 1.
      Parameters:
      a - an array of double
      offset - where in a to start using items
      count - how many items to use from a
      Throws:
      NullPointerException - if a is null

    • DoubleDeque

      public DoubleDeque(Ordered.OfDouble other)

  • Method Details

    • order

      public DoubleDeque order()
      Description copied from class: DoubleList
      Returns this DoubleList, since it is its own order. This is only here to satisfy the Ordered.OfDouble interface.
      Specified by:
      order in interface Ordered.OfDouble
      Overrides:
      order in class DoubleList
      Returns:
      this DoubleList

    • getDefaultValue

      public double getDefaultValue()
      Gets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque. Unless changed, the default value is usually null.
      Returns:
      the current default value

    • setDefaultValue

      public void setDefaultValue(double defaultValue)
      Sets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque. Unless changed, the default value is usually null.
      Parameters:
      defaultValue - any double this can return instead of throwing an Exception, or null

    • addLast

      public void addLast(double value)
      Appends given double to the tail (enqueue to tail). Unless the backing array needs resizing, operates in O(1) time.
      Parameters:
      value - can be null

    • addLast

      public void addLast(double value1, double value2)

    • addLast

      public void addLast(double value1, double value2, double value3)

    • addLast

      public void addLast(double value1, double value2, double value3, double value4)

    • addFirst

      public void addFirst(double value)
      Prepend given value to the head (enqueue to head). Unless backing array needs resizing, operates in O(1) time.
      Parameters:
      value - can be null
      See Also:

    • addFirst

      public void addFirst(double value1, double value2)

    • addFirst

      public void addFirst(double value1, double value2, double value3)

    • addFirst

      public void addFirst(double value1, double value2, double value3, double value4)

    • trimToSize

      public void trimToSize()
      Trims the capacity of this DoubleDeque instance to be the deque's current size. An application can use this operation to minimize the storage of a DoubleDeque instance.
      Overrides:
      trimToSize in class DoubleList

    • shrink

      public double[] shrink()
      Description copied from class: DoubleList
      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.
      Overrides:
      shrink in class DoubleList
      Returns:
      DoubleList.items; this will be a different reference if this resized

    • ensureCapacity

      public double[] ensureCapacity(int additional)
      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.
      Overrides:
      ensureCapacity in class DoubleList
      Returns:
      the backing array this will use after this call

    • resize

      public double[] resize(int newSize)
      Resizes the backing array. newSize should be greater than the current size; otherwise, newSize will be set to size and the resize to the same size will (for most purposes) be wasted effort. If this is not empty, this will rearrange the items internally to be linear and have the head at index 0, with the tail at size - 1. This always allocates a new internal backing array.
      Overrides:
      resize in class DoubleList
      Returns:
      the new backing array, as a direct reference

    • ensureGap

      protected int ensureGap(int index, int gapSize)
      Make sure there is a "gap" of exactly gapSize values starting at index. This can resize the backing array to achieve this goal. If possible, this will keep the same backing array and modify it in-place. The "gap" is not assigned null, and may contain old/duplicate references; calling code must overwrite the entire gap with additional values to ensure GC correctness.
      Parameters:
      index - the 0-based index in the iteration order where the gap will be present
      gapSize - the number of items that will need filling in the gap, and can be filled without issues.
      Returns:
      the position in the array where the gap will begin, which is unrelated to the index

    • addAll

      public boolean addAll(DoubleList list)
      Overrides:
      addAll in class DoubleList

    • addAll

      public boolean addAll(DoubleList list, int offset, int count)
      Overrides:
      addAll in class DoubleList

    • removeFirst

      public double removeFirst()
      Remove the first item from the deque. (dequeue from head) Always O(1).
      Returns:
      removed double
      Throws:
      NoSuchElementException - when the deque is empty

    • removeLast

      public double removeLast()
      Remove the last item from the deque. (dequeue from tail) Always O(1).
      Returns:
      removed double
      Throws:
      NoSuchElementException - when the deque is empty
      See Also:

    • offerFirst

      public boolean offerFirst(double t)
      Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addFirst(double) method, which can fail to insert an element only by throwing an exception.
      Parameters:
      t - the element to add
      Returns:
      true if the element was added to this deque, else false
      Throws:
      ClassCastException - if the class of the specified element prevents it from being added to this deque
      NullPointerException - if the specified element is null and this deque does not permit null elements
      IllegalArgumentException - if some property of the specified element prevents it from being added to this deque

    • offerLast

      public boolean offerLast(double t)
      Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addLast(double) method, which can fail to insert an element only by throwing an exception.
      Parameters:
      t - the element to add
      Returns:
      true if the element was added to this deque, else false
      Throws:
      ClassCastException - if the class of the specified element prevents it from being added to this deque
      NullPointerException - if the specified element is null and this deque does not permit null elements
      IllegalArgumentException - if some property of the specified element prevents it from being added to this deque

    • pollFirst

      public double pollFirst()
      Retrieves and removes the first element of this deque, or returns defaultValue if this deque is empty. The default value is usually null unless it has been changed with setDefaultValue(double).
      Returns:
      the head of this deque, or defaultValue if this deque is empty
      See Also:

    • pollLast

      public double pollLast()
      Retrieves and removes the last element of this deque, or returns defaultValue if this deque is empty. The default value is usually null unless it has been changed with setDefaultValue(double).
      Returns:
      the tail of this deque, or defaultValue if this deque is empty
      See Also:

    • getFirst

      public double getFirst()
      Retrieves, but does not remove, the first element of this deque.

      This method differs from peekFirst only in that it throws an exception if this deque is empty.

      Returns:
      the head of this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • getLast

      public double getLast()
      Retrieves, but does not remove, the last element of this deque. This method differs from peekLast only in that it throws an exception if this deque is empty.
      Returns:
      the tail of this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • peekFirst

      public double peekFirst()
      Retrieves, but does not remove, the first element of this deque, or returns defaultValue if this deque is empty.
      Returns:
      the head of this deque, or defaultValue if this deque is empty

    • peekLast

      public double peekLast()
      Retrieves, but does not remove, the last element of this deque, or returns defaultValue if this deque is empty.
      Returns:
      the tail of this deque, or defaultValue if this deque is empty

    • removeFirstOccurrence

      public boolean removeFirstOccurrence(double o)
      Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).
      Parameters:
      o - element to be removed from this deque, if present
      Returns:
      true if an element was removed as a result of this call

    • removeLastOccurrence

      public boolean removeLastOccurrence(double o)
      Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).
      Parameters:
      o - element to be removed from this deque, if present
      Returns:
      true if an element was removed as a result of this call

    • add

      public boolean add(double t)
      Inserts the specified element into the deque represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use offer.

      This method is equivalent to addLast(double).

      Specified by:
      add in interface PrimitiveCollection.OfDouble
      Overrides:
      add in class DoubleList
      Parameters:
      t - the element to add
      Returns:
      true (as specified by Collection.add(E))

    • add

      public void add(double value1, double value2)
      Overrides:
      add in class DoubleList

    • add

      public void add(double value1, double value2, double value3)
      Overrides:
      add in class DoubleList

    • add

      public void add(double value1, double value2, double value3, double value4)
      Overrides:
      add in class DoubleList

    • insert

      public void insert(int index, double item)
      Inserts the specified element into this deque at the specified index. Unlike offerFirst(double) and offerLast(double), this does not run in expected constant time unless the index is less than or equal to 0 (where it acts like offerFirst()) or greater than or equal to size() (where it acts like offerLast()).
      Overrides:
      insert in class DoubleList
      Parameters:
      index - the index in the deque's insertion order to insert the item
      item - a double item to insert; may be null

    • offer

      public boolean offer(double t)
      Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available. When using a capacity-restricted deque, this method is generally preferable to the add(double) method, which can fail to insert an element only by throwing an exception.

      This method is equivalent to offerLast(double).

      Parameters:
      t - the element to add
      Returns:
      true if the element was added to this deque, else false

    • remove

      public double remove()
      Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from poll() only in that it throws an exception if this deque is empty.

      This method is equivalent to removeFirst().

      Returns:
      the head of the queue represented by this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • poll

      public double poll()
      Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.

      This method is equivalent to pollFirst().

      Returns:
      the first element of this deque, or defaultValue if this deque is empty

    • element

      public double element()
      Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from peek only in that it throws an exception if this deque is empty.

      This method is equivalent to getFirst().

      Returns:
      the head of the queue represented by this deque
      Throws:
      NoSuchElementException - if this deque is empty

    • peek

      public double peek()
      Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.

      This method is equivalent to peekFirst().

      Overrides:
      peek in class DoubleList
      Returns:
      the head of the queue represented by this deque, or defaultValue if this deque is empty

    • addAll

      public boolean addAll(PrimitiveCollection.OfDouble c)
      Adds all the elements in the specified collection at the end of this deque, as if by calling addLast(double) on each one, in the order that they are returned by the collection's iterator.

      When using a capacity-restricted deque, it is generally preferable to call offer separately on each element.

      An exception encountered while trying to add an element may result in only some of the elements having been successfully added when the associated exception is thrown.

      Specified by:
      addAll in interface PrimitiveCollection.OfDouble
      Parameters:
      c - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • addAllLast

      public boolean addAllLast(PrimitiveCollection.OfDouble c)
      An alias for addAll(OfDouble), this adds every item in c to this in order at the end.
      Parameters:
      c - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • addAllFirst

      public boolean addAllFirst(PrimitiveCollection.OfDouble c)
      Adds every item in c to this in order at the start. The iteration order of c will be preserved for the added items.
      Parameters:
      c - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • insertAll

      public boolean insertAll(int index, PrimitiveCollection.OfDouble c)
      An alias for addAll(int, OfDouble); inserts all elements in the specified collection into this list at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
      Parameters:
      index - index at which to insert the first element from the specified collection
      c - collection containing elements to be added to this list
      Returns:
      true if this list changed as a result of the call

    • addAll

      public boolean addAll(int index, PrimitiveCollection.OfDouble c)

    • addAll

      public boolean addAll(double[] array)
      Exactly like addAll(OfDouble), but takes an array instead of a PrimitiveCollection.OfDouble.
      Specified by:
      addAll in interface PrimitiveCollection.OfDouble
      Overrides:
      addAll in class DoubleList
      Parameters:
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(double[] array, int offset, int length)
      Like addAll(double[]), but only uses at most length items from array, starting at offset.
      Specified by:
      addAll in interface PrimitiveCollection.OfDouble
      Overrides:
      addAll in class DoubleList
      Parameters:
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(double[] array)
      An alias for addAll(double[]).
      Parameters:
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(double[] array, int offset, int length)
      An alias for addAll(double[], int, int).
      Parameters:
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(double[] array)
      Exactly like addAllFirst(OfDouble), but takes an array instead of a PrimitiveCollection.OfDouble.
      Parameters:
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(double[] array, int offset, int length)
      Like addAllFirst(double[]), but only uses at most length items from array, starting at offset. The order of array will be preserved, starting at the head of the deque.
      Parameters:
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • insertAll

      public boolean insertAll(int index, double[] array)
      Alias for addAll(int, double[]).
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • insertAll

      public boolean insertAll(int index, double[] array, int offset, int length)
      Alias for addAll(int, double[], int, int).
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call

    • addAll

      public boolean addAll(int index, double[] array)
      Like addAll(int, OfDouble), but takes an array instead of a PrimitiveCollection.OfDouble and inserts it so the first item will be at the given index. The order of array will be preserved, starting at the given index in this deque.
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(int index, double[] array, int offset, int length)
      Like addAll(int, OfDouble), but takes an array instead of a PrimitiveCollection.OfDouble, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index. The order of array will be preserved, starting at the given index in this deque.
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      array - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(Ordered.OfDouble ord)
      Exactly like addAll(OfDouble), but takes an Ordered.OfDouble instead of a PrimitiveCollection.OfDouble.
      Parameters:
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(Ordered.OfDouble ord, int offset, int length)
      Like addAll(double[]), but only uses at most length items from ord, starting at offset.
      Overrides:
      addAll in class DoubleList
      Parameters:
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(int index, Ordered.OfDouble ord)
      Like addAll(int, OfDouble), but takes an ord instead of a PrimitiveCollection.OfDouble and inserts it so the first item will be at the given index. The order of ord will be preserved, starting at the given index in this deque.
      Parameters:
      index - the index in this deque's iteration order to place the first item in ord
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(int index, Ordered.OfDouble ord, int offset, int length)
      Like addAll(int, OfDouble), but takes an array instead of a PrimitiveCollection.OfDouble, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index. The order of array will be preserved, starting at the given index in this deque.
      Overrides:
      addAll in class DoubleList
      Parameters:
      index - the index in this deque's iteration order to place the first item in array
      ord - the elements to be inserted into this deque
      offset - the index of the first item in array to add
      length - how many items, at most, to add from array into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(Ordered.OfDouble ord)
      An alias for addAll(Ordered.OfDouble).
      Parameters:
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllLast

      public boolean addAllLast(Ordered.OfDouble ord, int offset, int length)
      An alias for addAll(Ordered.OfDouble, int, int).
      Parameters:
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(Ordered.OfDouble ord)
      Exactly like addAllFirst(OfDouble), but takes an ord instead of a PrimitiveCollection.OfDouble.
      Parameters:
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • addAllFirst

      public boolean addAllFirst(Ordered.OfDouble ord, int offset, int length)
      Like addAllFirst(Ordered.OfDouble), but only uses at most length items from ord, starting at offset. The order of ord will be preserved, starting at the head of the deque.
      Parameters:
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call
      See Also:

    • insertAll

      public boolean insertAll(int index, Ordered.OfDouble ord)
      Alias for addAll(int, Ordered.OfDouble).
      Parameters:
      index - the index in this deque's iteration order to place the first item in ord
      ord - the elements to be inserted into this deque
      Returns:
      true if this deque changed as a result of the call

    • insertAll

      public boolean insertAll(int index, Ordered.OfDouble ord, int offset, int length)
      Alias for addAll(int, Ordered.OfDouble, int, int).
      Parameters:
      index - the index in this deque's iteration order to place the first item in ord
      ord - the elements to be inserted into this deque
      offset - the index of the first item in ord to add
      length - how many items, at most, to add from ord into this
      Returns:
      true if this deque changed as a result of the call

    • push

      public void push(double t)
      Pushes an element onto the stack represented by this deque (in other words, at the head of this deque).

      This method is equivalent to addFirst(double).

      Parameters:
      t - the element to push

    • pop

      public double pop()
      Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque.

      This method is equivalent to removeFirst().

      Overrides:
      pop in class DoubleList
      Returns:
      the element at the front of this deque (which is the top of the stack represented by this deque)
      Throws:
      NoSuchElementException - if this deque is empty

    • remove

      public boolean remove(double o)
      Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

      This method is equivalent to removeFirstOccurrence(double).

      Specified by:
      remove in interface PrimitiveCollection.OfDouble
      Overrides:
      remove in class DoubleList
      Parameters:
      o - element to be removed from this deque, if present
      Returns:
      true if an element was removed as a result of this call

    • contains

      public boolean contains(double o)
      Returns true if this deque contains the specified element. More formally, returns true if and only if this deque contains at least one element e such that o == e.
      Specified by:
      contains in interface PrimitiveCollection.OfDouble
      Overrides:
      contains in class DoubleList
      Parameters:
      o - element whose presence in this deque is to be tested
      Returns:
      true if this deque contains the specified element

    • containsAll

      public boolean containsAll(DoubleList other)
      Description copied from class: DoubleList
      Returns true if this DoubleList contains, at least once, every item in other; otherwise returns false.
      Overrides:
      containsAll in class DoubleList
      Parameters:
      other - an DoubleList
      Returns:
      true if this contains every item in other, otherwise false

    • size

      public int size()
      Returns the number of elements in this deque.
      Specified by:
      size in interface Arrangeable
      Specified by:
      size in interface PrimitiveCollection<Double>
      Overrides:
      size in class DoubleList
      Returns:
      the number of elements in this deque

    • toArray

      public double[] toArray()
      Returns an array containing all the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is double.

      The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

      Specified by:
      toArray in interface PrimitiveCollection.OfDouble
      Overrides:
      toArray in class DoubleList
      Returns:
      an array, whose runtime component type is double, containing all the elements in this collection

    • toArray

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

    • setSize

      public double[] setSize(int newSize)
      Description copied from class: DoubleList
      Sets the list size, leaving any values beyond the current size undefined.
      Overrides:
      setSize in class DoubleList
      Returns:
      DoubleList.items; this will be a different reference if this resized to a larger capacity

    • truncateLast

      public void truncateLast(int newSize)
      Alias for truncate(int).
      Parameters:
      newSize - the size this deque should have after this call completes, if smaller than the current size

    • truncate

      public void truncate(int newSize)
      Reduces the size of the deque to the specified size by bulk-removing items from the tail end. If the deque is already smaller than the specified size, no action is taken.
      Overrides:
      truncate in class DoubleList
      Parameters:
      newSize - the size this deque should have after this call completes, if smaller than the current size

    • truncateFirst

      public void truncateFirst(int newSize)
      Reduces the size of the deque to the specified size by bulk-removing from the head. If the deque is already smaller than the specified size, no action is taken.
      Parameters:
      newSize - the size this deque should have after this call completes, if smaller than the current size

    • removeRange

      public void removeRange(int fromIndex, int toIndex)
      Removes from this list all the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shrinks the list by (toIndex - fromIndex) elements. If toIndex==fromIndex, this operation has no effect. If fromIndex is 0 or less, this delegates to truncateFirst(int); if toIndex is equal to or greater than the size of this collection, this delegates to truncate(int).
      This is public here, not protected as in most JDK collections, because there are actually sometimes needs for this in user code.
      Specified by:
      removeRange in interface Ordered.OfDouble
      Overrides:
      removeRange in class DoubleList
      Parameters:
      fromIndex - index of first element to be removed (inclusive)
      toIndex - index after last element to be removed (exclusive)

    • indexOf

      public int indexOf(double value)
      Returns the index of the first occurrence of value in the deque, or -1 if no such value exists.
      Overrides:
      indexOf in class DoubleList
      Parameters:
      value - the double to look for
      Returns:
      An index of the first occurrence of value in the deque or -1 if no such value exists

    • indexOf

      public int indexOf(double value, int fromIndex)
      Returns the index of the first occurrence of value in the deque, or -1 if no such value exists. This returns fromIndex if value is present at that point, so if you chain calls to indexOf(), the subsequent fromIndex should be larger than the last-returned index.
      Parameters:
      value - the double to look for
      fromIndex - the initial index to check (zero-indexed, starts at the head, inclusive)
      Returns:
      An index of first occurrence of value at or after fromIndex in the deque, or -1 if no such value exists

    • lastIndexOf

      public int lastIndexOf(double value)
      Returns the index of the last occurrence of value in the deque, or -1 if no such value exists.
      Overrides:
      lastIndexOf in class DoubleList
      Parameters:
      value - the double to look for
      Returns:
      An index of the last occurrence of value in the deque or -1 if no such value exists

    • lastIndexOf

      public int lastIndexOf(double value, int fromIndex)
      Returns the index of last occurrence of value in the deque, starting from fromIndex and going backwards, or -1 if no such value exists. This returns fromIndex if value is present at that point, so if you chain calls to indexOf(), the subsequent fromIndex should be smaller than the last-returned index.
      Parameters:
      value - the double to look for
      fromIndex - the initial index to check (zero-indexed, starts at the head, inclusive)
      Returns:
      An index of last occurrence of value at or before fromIndex in the deque, or -1 if no such value exists

    • listIterator

      public DoubleList.DoubleListIterator listIterator()

    • listIterator

      public DoubleList.DoubleListIterator listIterator(int index)
      Gets an iterator over this deque that starts at the given index.
      Parameters:
      index - the index to start iterating from in this deque
      Returns:
      a reused iterator starting at the given index

    • removeValue

      public boolean removeValue(double value)
      Removes the first instance of the specified value in the deque.
      Parameters:
      value - the double to remove
      Returns:
      true if value was found and removed, false otherwise

    • removeLastValue

      public boolean removeLastValue(double value)
      Removes the last instance of the specified value in the deque.
      Parameters:
      value - the double to remove
      Returns:
      true if value was found and removed, false otherwise

    • removeAt

      public double removeAt(int index)
      Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque.
      Overrides:
      removeAt in class DoubleList
      Parameters:
      index - the index of the element to be removed
      Returns:
      the element previously at the specified position

    • pollAt

      public double pollAt(int index)
      Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque, or the default value if this is empty. This will not throw an Exception in normal usage, even if index is negative (which makes this simply return pollFirst()) or greater than or equal to size() (which makes this return pollLast()).
      This is an alias for poll(int) for compatibility with primitive-backed lists and deques; poll(int) can refer to the method that removes an item by value, not by index, in those types.
      Parameters:
      index - the index of the element to be removed
      Returns:
      the element previously at the specified position

    • poll

      public double poll(int index)
      Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque, or the default value if this is empty. This will not throw an Exception in normal usage, even if index is negative (which makes this simply return pollFirst()) or greater than or equal to size() (which makes this return pollLast()).
      Parameters:
      index - the index of the element to be removed
      Returns:
      the element previously at the specified position

    • removeAll

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

    • removeEach

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

    • retainAll

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

    • notEmpty

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

    • isEmpty

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

    • first

      public double first()
      Returns the first (head) item in the deque (without removing it).
      Specified by:
      first in interface PrimitiveCollection.OfDouble
      Overrides:
      first in class DoubleList
      Returns:
      the first item, without modifying this
      Throws:
      NoSuchElementException - when the deque is empty
      See Also:

    • last

      public double last()
      Returns the last (tail) item in the deque (without removing it).
      Throws:
      NoSuchElementException - when the deque is empty
      See Also:

    • get

      public double get(int index)
      Returns the element at the specified position in this deque. Like ArrayList or DoubleList, but unlike LinkedList, this runs in O(1) time. It is expected to be slightly slower than DoubleList.get(int), which also runs in O(1) time. Unlike get() in ArrayList or DoubleList, this considers negative indices to refer to the first item, and too-large indices to refer to the last item. That means it delegates to getFirst() or getLast() in those cases instead of throwing an IndexOutOfBoundsException, though it may throw a NoSuchElementException if the deque is empty and there is no item it can get.
      Overrides:
      get in class DoubleList
      Parameters:
      index - index of the element to return
      Returns:
      the element at the specified position in this deque
      Throws:
      NoSuchElementException - if the deque is empty

    • peekAt

      public double peekAt(int index)
      Returns the element at the specified position in this deque. Like ArrayList or DoubleList, but unlike LinkedList, this runs in O(1) time. It is expected to be slightly slower than DoubleList.get(int), which also runs in O(1) time. Unlike get() in ArrayList or DoubleList, this considers negative indices to refer to the first item, and too-large indices to refer to the last item. That means it delegates to peekFirst() or peekLast() in those cases instead of throwing an IndexOutOfBoundsException, and it will return the default value if the deque is empty. Unless changed, the default value is usually null.
      Parameters:
      index - index of the element to return
      Returns:
      the element at the specified position in this deque

    • assign

      public double assign(int index, double item)
      Replaces the element at the specified position in this list with the specified element. If this deque is empty or the index is larger than the largest index currently in this deque, this delegates to addLast(double) and returns the default value. If the index is negative, this delegates to addFirst(double) and returns the default value.
      Parameters:
      index - index of the element to replace
      item - element to be stored at the specified position
      Returns:
      the element previously at the specified position

    • set

      public void set(int index, double item)
      Replaces the element at the specified position in this list with the specified element. If this deque is empty or the index is larger than the largest index currently in this deque, this delegates to addLast(double) and returns the default value. If the index is negative, this delegates to addFirst(double) and returns the default value.
      Overrides:
      set in class DoubleList
      Parameters:
      index - index of the element to replace
      item - element to be stored at the specified position

    • plus

      public void plus(int index, double value)
      Overrides:
      plus in class DoubleList

    • plus

      public DoubleList plus(double value)
      Description copied from class: DoubleList
      Adds value to each item in this DoubleList, stores it in this and returns it. The presence of this method allows Kotlin code to use the + operator (though it shouldn't be used more than once in an expression, because this method modifies this DoubleList).
      Overrides:
      plus in class DoubleList
      Parameters:
      value - each item in this will be assigned item + value
      Returns:
      this for chaining and Kotlin compatibility

    • times

      public void times(int index, double value)
      Overrides:
      times in class DoubleList

    • times

      public DoubleList times(double value)
      Description copied from class: DoubleList
      Multiplies each item in this DoubleList by value, stores it in this and returns it. The presence of this method allows Kotlin code to use the * operator (though it shouldn't be used more than once in an expression, because this method modifies this DoubleList).
      Overrides:
      times in class DoubleList
      Parameters:
      value - each item in this will be assigned item * value
      Returns:
      this for chaining and Kotlin compatibility

    • minus

      public void minus(int index, double value)
      Overrides:
      minus in class DoubleList

    • minus

      public DoubleList minus(double value)
      Description copied from class: DoubleList
      Takes each item in this DoubleList and subtracts value, stores it in this and returns it. This is just a minor convenience in Java, but the presence of this method allows Kotlin code to use the - operator (though it shouldn't be used more than once in an expression, because this method modifies this DoubleList).
      Overrides:
      minus in class DoubleList
      Parameters:
      value - each item in this will be assigned item - value
      Returns:
      this for chaining and Kotlin compatibility

    • div

      public void div(int index, double value)
      Overrides:
      div in class DoubleList

    • div

      public DoubleList div(double value)
      Description copied from class: DoubleList
      Divides each item in this DoubleList by value, stores it in this and returns it. The presence of this method allows Kotlin code to use the / operator (though it shouldn't be used more than once in an expression, because this method modifies this DoubleList).
      Overrides:
      div in class DoubleList
      Parameters:
      value - each item in this will be assigned item / value
      Returns:
      this for chaining and Kotlin compatibility

    • rem

      public void rem(int index, double value)
      Overrides:
      rem in class DoubleList

    • rem

      public DoubleList rem(double value)
      Description copied from class: DoubleList
      Gets the remainder of each item in this DoubleList with value, stores it in this and returns it. The presence of this method allows Kotlin code to use the % operator (though it shouldn't be used more than once in an expression, because this method modifies this DoubleList).
      Overrides:
      rem in class DoubleList
      Parameters:
      value - each item in this will be assigned item % value
      Returns:
      this for chaining and Kotlin compatibility

    • replaceAll

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

    • replaceFirst

      public boolean replaceFirst(double find, double 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. This compares items with ==, so an item must be identical to find to be replaced, except in the cases of 0f == -0f and Double.NaN != anyDouble.
      Overrides:
      replaceFirst in class DoubleList
      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(double find, double 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.
      Overrides:
      replaceAll in class DoubleList
      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

    • replaceFirst

      public boolean replaceFirst(double find, double replace, double tolerance)
      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.
      Overrides:
      replaceFirst in class DoubleList
      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(double find, double replace, double tolerance)
      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.
      Overrides:
      replaceAll in class DoubleList
      Parameters:
      find - the item to search for
      replace - the item to replace find with, if possible
      tolerance - how much an item can be different from find and still be replaced
      Returns:
      the number of replacements that occurred; 0 if nothing was found or replaced

    • replaceFirstNaN

      public boolean replaceFirstNaN(double replace)
      Replaces the first occurrence of NaN with replace. Returns true if it performed the replacement, or false if there was nothing to replace.
      Overrides:
      replaceFirstNaN in class DoubleList
      Parameters:
      replace - the item to replace NaN with, if possible
      Returns:
      true if this changed, or false otherwise

    • replaceAllNaN

      public int replaceAllNaN(double replace)
      Replaces every occurrence of NaN with replace. Returns the number of changed items, which is 0 if nothing was found.
      Overrides:
      replaceAllNaN in class DoubleList
      Parameters:
      replace - the item to replace NaN with, if possible
      Returns:
      the number of replacements that occurred; 0 if nothing was found or replaced

    • 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.
      Overrides:
      duplicateRange in class DoubleList
      Parameters:
      index - the first index to duplicate
      count - how many items to duplicate

    • clear

      public void clear()
      Removes all values from this deque. This operates in O(1) time.
      Specified by:
      clear in interface PrimitiveCollection<Double>
      Overrides:
      clear in class DoubleList

    • iterator

      public DoubleList.DoubleListIterator iterator()
      Returns an iterator for the items in the deque. Remove is supported.
      Reuses one of two iterators for this deque. For nested or multithreaded iteration, use DoubleDequeIterator(DoubleDeque).
      Specified by:
      iterator in interface PrimitiveCollection<Double>
      Specified by:
      iterator in interface PrimitiveCollection.OfDouble
      Overrides:
      iterator in class DoubleList
      Returns:
      a DoubleIterator; use its nextDouble() method instead of next()

    • descendingIterator

      public DoubleList.DoubleListIterator descendingIterator()
      Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).
      Reuses one of two descending iterators for this deque. For nested or multithreaded iteration, use DoubleDequeIterator(DoubleDeque, boolean).
      Returns:
      an iterator over the elements in this deque in reverse sequence

    • descendingIterator

      public DoubleList.DoubleListIterator descendingIterator(int index)
      Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from index backwards to first (head).
      Reuses one of two descending iterators for this deque. For nested or multithreaded iteration, use DoubleDequeIterator(DoubleDeque, boolean).
      Parameters:
      index - the index to start iterating from in this deque
      Returns:
      an iterator over the elements in this deque in reverse sequence

    • toString

      public String toString()
      Delegates to PrimitiveCollection.OfDouble.toString(String, boolean) with a delimiter of ", " and square brackets enabled.
      Overrides:
      toString in class DoubleList
      Returns:
      the square-bracketed String representation of this DoubleDeque, with items separated by ", "

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface PrimitiveCollection<Double>
      Overrides:
      hashCode in class DoubleList

    • equals

      public boolean equals(Object o)
      Using Double.compare(double, double) between each item in order, compares for equality with other subtypes of DoubleList. If o is not a DoubleList (and is also not somehow reference-equivalent to this collection), this returns false. This uses the PrimitiveCollection.OfDouble.iterator() of both this and o, so if either is in the middle of a concurrent iteration that modifies the collection, this may fail.
      Specified by:
      equals in interface PrimitiveCollection<Double>
      Overrides:
      equals in class DoubleList
      Parameters:
      o - object to be compared for equality with this collection
      Returns:
      true if this is equal to o, or false otherwise

    • equals

      public boolean equals(Object o, double tolerance)
      Description copied from class: DoubleList
      Compares double items with the given tolerance for error.
      Overrides:
      equals in class DoubleList

    • swap

      public void swap(int first, int second)
      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.OfDouble
      Overrides:
      swap in class DoubleList
      Parameters:
      first - the first position, must not be negative and must be less than size()
      second - the second position, must not be negative and must be less than size()

    • reverse

      public void reverse()
      Reverses this DoubleDeque in-place.
      Specified by:
      reverse in interface Arrangeable
      Specified by:
      reverse in interface Ordered.OfDouble
      Overrides:
      reverse in class DoubleList

    • shuffle

      public void shuffle(Random rng)
      Description copied from interface: Ordered.OfDouble
      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.OfDouble
      Overrides:
      shuffle in class DoubleList
      Parameters:
      rng - any Random class, such as one from juniper

    • sort

      public void sort()
      Sorts this deque in-place using Arrays.sort(double[], int, int) in ascending order.
      Overrides:
      sort in class DoubleList

    • sort

      public void sort(int from, int to)
      Uses Arrays.sort(double[], int, int) to sort a (clamped) subrange of this deque.
      Overrides:
      sort in class DoubleList
      Parameters:
      from - first index to use, inclusive
      to - last index to use, exclusive

    • sort

      public void sort(DoubleComparator comparator)
      Sorts this deque in-place using DoubleComparators.sort(double[], int, int, DoubleComparator). This should operate in O(n log(n)) time or less when the internals of the deque are continuous (the head is before the tail in the array). If the internals are not continuous, this takes an additional O(n) step (where n is less than the size of the deque) to rearrange the internals before sorting. You can pass null as the value for comparator, which will make this use the natural ordering for double.
      Specified by:
      sort in interface Ordered.OfDouble
      Overrides:
      sort in class DoubleList
      Parameters:
      comparator - the Comparator to use for double items; may be null to use the natural order of double items when double implements Comparable of double

    • sort

      public void sort(int from, int to, DoubleComparator comparator)
      Description copied from class: DoubleList
      Sorts the specified range of elements according to the order induced by the specified comparator using mergesort, or Arrays.sort(double[], int, int) if c is null. This purely uses DoubleComparators.sort(double[], int, int, DoubleComparator), and you can see its docs for more information. This clamps from and to to the valid range.
      Overrides:
      sort in class DoubleList
      Parameters:
      from - the index of the first element (inclusive) to be sorted
      to - the index of the last element (exclusive) to be sorted
      comparator - the comparator to determine the order of the DoubleList

    • getRandom

      public double getRandom(Random random)
      Gets a randomly selected item from this DoubleDeque, using the given random number generator. Throws a NoSuchElementException if empty.
      Parameters:
      random - any Random or subclass of it, such as AlternateRandom.
      Returns:
      a randomly selected item from this deque

    • random

      public double random(Random random)
      Gets a randomly selected item from this DoubleDeque, using the given random number generator.
      Specified by:
      random in interface Ordered.OfDouble
      Overrides:
      random in class DoubleList
      Parameters:
      random - any Random or subclass of it, such as AlternateRandom.
      Returns:
      a randomly selected item from this deque, or the default value if empty

    • with

      public static DoubleDeque with()
      Constructs an empty deque. 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 deque containing nothing

    • with

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

    • with

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

    • with

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

    • with

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

    • with

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

    • with

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

    • with

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

    • with

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

    • with

      public static DoubleDeque with(double... varargs)
      Creates a new DoubleDeque that will hold the items in the given array or varargs. This overload will only be used when a double array is supplied, or if varargs are used and there are 9 or more arguments.
      Parameters:
      varargs - either 0 or more double items, or an array of double
      Returns:
      a new DoubleDeque that holds the given double items

    • parse

      public static DoubleDeque 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 DoubleDeque parse(String str, String delimiter, boolean brackets)
      Creates a new collection and fills it by calling PrimitiveCollection.OfDouble.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 DoubleDeque parse(String str, String delimiter, int offset, int length)
      Creates a new collection and fills it by calling PrimitiveCollection.OfDouble.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