Class DoubleGapList

java.lang.Object
org.magicwerk.brownies.collections.primitive.IDoubleList
org.magicwerk.brownies.collections.primitive.DoubleGapList
Record Components:
type - of elements stored in the list
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
DoubleGapList.ReadOnlyList
public class DoubleGapList extends IDoubleList
Class {link DoubleGapList} combines the strengths of both ArrayList and LinkedList. It is implemented to offer both efficient random access to elements by index (as ArrayList does) and at the same time efficient adding and removing elements to and from beginning and end (as LinkedList does). It also exploits the locality of reference often seen in applications to further improve performance, e.g. for iterating over the list.

The class can be used as drop-in replacement for ArrayList. It is also source compatible to LinkedList/Deque as it implements all needed methods. It cannot implement Deque however, use

invalid reference 
#asDeque
to get a view implementing it.

Note that this implementation is not synchronized.

Note that the iterators provided are not fail-fast.

Author:
Thomas Mauch
See Also:

  • Field Details

    • DEFAULT_CAPACITY

      public static final int DEFAULT_CAPACITY
      Default capacity for list
      See Also:

  • Constructor Details

    • DoubleGapList

      protected DoubleGapList(boolean copy, DoubleGapList that)
      Constructor used internally, e.g. for ImmutableDoubleGapList.
      Parameters:
      copy - true to copy all instance values from source, if false nothing is done
      that - list to copy

    • DoubleGapList

      public DoubleGapList()
      Construct a list with the default initial capacity.

    • DoubleGapList

      public DoubleGapList(int capacity)
      Construct a list with specified initial capacity.
      Parameters:
      capacity - capacity

    • DoubleGapList

      public DoubleGapList(Collection<Double> coll)
      Construct a list to contain the specified elements. The list will have an initial capacity to hold these elements.
      Parameters:
      coll - collection with elements

  • Method Details

    • EMPTY

      public static DoubleGapList EMPTY()
      Returns:
      unmodifiable empty instance

    • create

      public static DoubleGapList create()

    • create

      public static DoubleGapList create(Collection<Double> coll)
      Create new list with specified elements.
      Parameters:
      coll - collection with elements
      type - of elements stored in the list
      Returns:
      created list

    • create

      @SafeVarargs public static DoubleGapList create(double... elems)
      Create new list with specified elements.
      Parameters:
      elems - array with elements
      type - of elements stored in the list
      Returns:
      created list

    • immutable

      public static DoubleGapList immutable(Collection<Double> coll)
      Create new immutable list with specified elements. To reduce the needed memory, the list's capacity will be equal to its size.
      Parameters:
      coll - collection with elements
      type - of elements stored in the list
      Returns:
      created list

    • immutable

      @SafeVarargs public static DoubleGapList immutable(double... elems)
      Create new immutable list with specified elements. To reduce the needed memory, the list's capacity will be equal to its size.
      Parameters:
      elems - array with elements
      type - of elements stored in the list
      Returns:
      created list

    • doAssign

      protected void doAssign(IDoubleList that)
      Description copied from class: IDoubleList
      Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.
      Specified by:
      doAssign in class IDoubleList
      Parameters:
      that - list to copy content from

    • getDefaultElem

      public double getDefaultElem()
      Specified by:
      getDefaultElem in class IDoubleList

    • crop

      public DoubleGapList crop()
      Description copied from class: IDoubleList
      Returns a copy this list but without elements. The new list will have the same type as this list.
      Overrides:
      crop in class IDoubleList
      Returns:
      an empty copy of this list

    • copy

      public DoubleGapList copy()
      Description copied from class: IDoubleList
      Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. This returned list will be modifiable, i.e. a read-only list will be copied and be modifiable again.
      Specified by:
      copy in class IDoubleList
      Returns:
      a modifiable copy of this list

    • clone

      public DoubleGapList clone()
      Description copied from class: IDoubleList
      Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. If the list is read-only, the same list is returned without change. Use IDoubleList.copy() to .
      Overrides:
      clone in class IDoubleList
      Returns:
      a modifiable copy of this list

    • isReadOnly

      public boolean isReadOnly()
      Description copied from class: IDoubleList
      Returns true if this list is either unmodifiable or immutable, false otherwise.
      Specified by:
      isReadOnly in class IDoubleList

    • unmodifiableList

      public DoubleGapList unmodifiableList()
      Specified by:
      unmodifiableList in class IDoubleList

    • immutableList

      public DoubleGapList immutableList()
      Description copied from class: IDoubleList
      Returns an immutable copy of this list. The returned list is independent from the original list, i.e. changes done later are not seen. Attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException. If this list is already immutable, it is returned unchanged. See IDoubleList.unmodifiableList() to get unmodifiable view of a list.
      Specified by:
      immutableList in class IDoubleList
      Returns:
      an immutable copy of the specified list

    • doClone

      protected void doClone(IDoubleList that)
      Description copied from class: IDoubleList
      Initialize this object after the bitwise copy has been made by Object.clone().
      Specified by:
      doClone in class IDoubleList
      Parameters:
      that - source object

    • doClear

      protected void doClear()
      Overrides:
      doClear in class IDoubleList

    • size

      public int size()
      Specified by:
      size in class IDoubleList

    • capacity

      public int capacity()
      Description copied from class: IDoubleList
      Returns capacity of this list. Note that two lists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.
      Specified by:
      capacity in class IDoubleList
      Returns:
      capacity of this list

    • get

      public double get(int index)
      Overrides:
      get in class IDoubleList

    • doGet

      protected double doGet(int index)
      Description copied from class: IDoubleList
      Helper method for getting an element from the list. This is the only method which really gets an element. Override if you need to validity checks before getting.
      Specified by:
      doGet in class IDoubleList
      Parameters:
      index - index of element to return
      Returns:
      the element at the specified position in this list

    • doSet

      protected double doSet(int index, double elem)
      Description copied from class: IDoubleList
      Helper method for setting an element in the list. This is the only method which really sets an element. Override if you need to validity checks before setting.
      Specified by:
      doSet in class IDoubleList
      Parameters:
      index - index where element will be placed
      elem - element to set
      Returns:
      old element which was at the position

    • doReSet

      protected double doReSet(int index, double elem)
      Description copied from class: IDoubleList
      Sets an element at specified position. This method is used internally if existing elements will be moved etc. Override if you need to validity checks.
      Specified by:
      doReSet in class IDoubleList
      Parameters:
      index - index where element will be placed
      elem - element to set
      Returns:
      old element which was at the position

    • add

      public boolean add(double elem)
      Overrides:
      add in class IDoubleList

    • add

      public void add(int index, double elem)
      Description copied from class: IDoubleList
      Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
      Overrides:
      add in class IDoubleList
      Parameters:
      index - index at which the specified element is to be inserted
      elem - element to be inserted

    • getAll

      public DoubleGapList getAll(int index, int len)
      Description copied from class: IDoubleList
      Returns specified range of elements from list.
      Overrides:
      getAll in class IDoubleList
      Parameters:
      index - index of first element to retrieve
      len - number of elements to retrieve
      Returns:
      list containing the specified range of elements

    • getAll

      public DoubleGapList getAll(double elem)
      Description copied from class: IDoubleList
      Returns all elements in the list equal to the specified element.
      Overrides:
      getAll in class IDoubleList
      Parameters:
      elem - element to look for
      Returns:
      all elements in the list equal to the specified element

    • map

      public <R> GapList<R> map(Function<Double,R> mapper)
      Overrides:
      map in class IDoubleList

    • doAdd

      protected boolean doAdd(int index, double elem)
      Description copied from class: IDoubleList
      Helper method for adding an element to the list. This is the only method which really adds an element. Override if you need to validity checks before adding.
      Specified by:
      doAdd in class IDoubleList
      Parameters:
      index - index where element should be added (-1 means it is up to the implementation to choose the index)
      elem - element to add
      Returns:
      true if element has been added, false otherwise

    • remove

      public double remove(int index)
      Overrides:
      remove in class IDoubleList

    • doRemove

      protected double doRemove(int index)
      Description copied from class: IDoubleList
      Helper method to remove an element. This is the only method which really removes an element. Override if you need to validity checks before removing.
      Specified by:
      doRemove in class IDoubleList
      Parameters:
      index - index of element to remove
      Returns:
      removed element

    • doEnsureCapacity

      protected void doEnsureCapacity(int minCapacity)
      Description copied from class: IDoubleList
      Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
      Specified by:
      doEnsureCapacity in class IDoubleList
      Parameters:
      minCapacity - the desired minimum capacity

    • trimToSize

      public void trimToSize()
      Trims the capacity of this DoubleGapList instance to be the list's current size. An application can use this operation to minimize the storage of an instance.
      Specified by:
      trimToSize in class IDoubleList

    • doGetAll

      protected void doGetAll(double[] array, int index, int len)
      Description copied from class: IDoubleList
      Helper method to fill the specified elements in an array.
      Overrides:
      doGetAll in class IDoubleList
      Parameters:
      array - array to store the list elements
      index - index of first element to copy
      len - number of elements to copy

    • doCreate

      public DoubleGapList doCreate(int capacity)
      Description copied from class: IDoubleList
      Create list with specified capacity.
      Specified by:
      doCreate in class IDoubleList
      Parameters:
      capacity - initial capacity (use -1 for default capacity)
      Returns:
      created list

    • doRemoveAll

      protected void doRemoveAll(int index, int len)
      Description copied from class: IDoubleList
      Remove specified range of elements from list.
      Overrides:
      doRemoveAll in class IDoubleList
      Parameters:
      index - index of first element to remove
      len - number of elements to remove

    • doRemoveAllFast

      protected boolean doRemoveAllFast(int index, int len)
      Remove specified range of elements from list as specialized fast operation.
      Parameters:
      index - index of first element to remove
      len - number of elements to remove
      Returns:
      true if removal could be done, false otherwise

    • sort

      public void sort(int index, int len)
      Description copied from class: IDoubleList
      Sort specified elements in the list using the specified comparator.
      Specified by:
      sort in class IDoubleList
      Parameters:
      index - index of first element to sort
      len - number of elements to sort
      See Also:

    • binarySearch

      public int binarySearch(int index, int len, double key)
      Description copied from class: IDoubleList
      Searches the specified range for an object using the binary search algorithm.

      Note that the method is defined to work with an arbitrary type <K>. This allows to search directly for a key field in the object without the need to construct an object containing the key: 

      persons.binarySearch("john", new SearchByName());

class SearchByName implements Comparator<Object> {
 public int compare(Object o1, Object o2) {
   String s1 = (o1 instanceof String) ? (String) o1 : ((Name) o1).getName();
   String s2 = (o2 instanceof String) ? (String) o2 : ((Name) o2).getName();
   return s1.compareTo(s2);
 }
}
/
      Specified by:
      binarySearch in class IDoubleList
      Parameters:
      index - index of first element to search
      len - number of elements to search
      key - the value to be searched for
      Returns:
      index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.
      See Also: