DynamicArray (Crater Dog Java Collection Framework 3.7 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - craterdog.collections.primitives.DynamicArray<E>

Type Parameters:

E - The type of the elements in the array.

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess
```
public final class DynamicArray<E>
extends java.util.AbstractCollection<E>
implements java.util.List<E>, java.util.RandomAccess, java.lang.Cloneable
```
This class provides an implementation of dynamic array that scales up and down geometrically as the number of elements increases and decreases. When the number of elements in the array reaches its current capacity, it automatically doubles its capacity. When the number of elements drops below 1/4th of its current capacity, it automatically halves its capacity. This ensures a hysteresis of 1/2 its capacity so that it won't oscillate up and down with small changes in number of elements near a boundary condition.

Author:

Derk Norton

Constructor Summary

Constructors
Constructor and Description
`DynamicArray()` This default constructor creates an instance of a dynamic array with the minimum capacity (16 elements).
`DynamicArray(java.util.Collection<? extends E> elements)` This constructor creates an instance of a dynamic array that contains the elements from the specified collection.
`DynamicArray(int minimumCapacity)` This constructor creates an instance of a dynamic array with at least the specified minimum capacity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E element)`
`void`	`add(int index, E element)`
`boolean`	`addAll(int index, java.util.Collection<? extends E> collection)`
`void`	`clear()`
`java.lang.Object`	`clone()`
`boolean`	`equals(java.lang.Object object)`
`E`	`get(int index)`
`int`	`hashCode()`
`int`	`indexOf(java.lang.Object element)`
`java.util.ListIterator<E>`	`iterator()`
`int`	`lastIndexOf(java.lang.Object element)`
`java.util.ListIterator<E>`	`listIterator()`
`java.util.ListIterator<E>`	`listIterator(int index)`
`E`	`remove(int index)`
`DynamicArray<E>`	`remove(int firstIndex, int lastIndex)` This method removes the elements starting at the specified first index and excluding the element referenced by the last index.
`boolean`	`remove(java.lang.Object object)`
`E`	`set(int index, E element)`
`int`	`size()`
`DynamicArray<E>`	`subList(int fromIndex, int toIndex)`
`java.lang.Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] array)`

Methods inherited from class java.util.AbstractCollection
addAll, contains, containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List
addAll, contains, containsAll, isEmpty, removeAll, replaceAll, retainAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - DynamicArray
```
public DynamicArray()
```
    This default constructor creates an instance of a dynamic array with the minimum capacity (16 elements).
  - DynamicArray
```
public DynamicArray(int minimumCapacity)
```
    This constructor creates an instance of a dynamic array with at least the specified minimum capacity. The actual capacity will be a power of two that is greater or equal to the specified minimum capacity.
    
    Parameters:
    
    minimumCapacity - The minimum initial size of the array.
  - DynamicArray
```
public DynamicArray(java.util.Collection<? extends E> elements)
```
    This constructor creates an instance of a dynamic array that contains the elements from the specified collection.
    
    Parameters:
    
    elements - The elements that should be used to seed the array.
- Method Detail
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<E>
    
    Specified by:
    
    size in interface java.util.List<E>
    
    Specified by:
    
    size in class java.util.AbstractCollection<E>
  - indexOf
```
public int indexOf(java.lang.Object element)
```
    Specified by:
    
    indexOf in interface java.util.List<E>
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object element)
```
    Specified by:
    
    lastIndexOf in interface java.util.List<E>
  - get
```
public E get(int index)
```
    Specified by:
    
    get in interface java.util.List<E>
  - set
```
public E set(int index,
             E element)
```
    Specified by:
    
    set in interface java.util.List<E>
  - add
```
public boolean add(E element)
```
    Specified by:
    
    add in interface java.util.Collection<E>
    
    Specified by:
    
    add in interface java.util.List<E>
    
    Overrides:
    
    add in class java.util.AbstractCollection<E>
  - add
```
public void add(int index,
                E element)
```
    Specified by:
    
    add in interface java.util.List<E>
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection<? extends E> collection)
```
    Specified by:
    
    addAll in interface java.util.List<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface java.util.List<E>
  - remove
```
public DynamicArray<E> remove(int firstIndex,
                              int lastIndex)
```
    This method removes the elements starting at the specified first index and excluding the element referenced by the last index. This method returns an array containing the removed elements.
    
    Parameters:
    
    firstIndex - The index of the first element to be removed.
    
    lastIndex - The index of the last element after the range to be removed.
    
    Returns:
    
    The elements that were removed from the array.
  - remove
```
public boolean remove(java.lang.Object object)
```
    Specified by:
    
    remove in interface java.util.Collection<E>
    
    Specified by:
    
    remove in interface java.util.List<E>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E>
    
    Specified by:
    
    clear in interface java.util.List<E>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<E>
  - iterator
```
public java.util.ListIterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
    
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.util.List<E>
    
    Specified by:
    
    iterator in class java.util.AbstractCollection<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List<E>
  - listIterator
```
public java.util.ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface java.util.List<E>
  - subList
```
public DynamicArray<E> subList(int fromIndex,
                               int toIndex)
```
    Specified by:
    
    subList in interface java.util.List<E>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
    
    Specified by:
    
    toArray in interface java.util.List<E>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<E>
  - toArray
```
public <T> T[] toArray(T[] array)
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
    
    Specified by:
    
    toArray in interface java.util.List<E>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<E>
  - equals
```
public boolean equals(java.lang.Object object)
```
    Specified by:
    
    equals in interface java.util.Collection<E>
    
    Specified by:
    
    equals in interface java.util.List<E>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Collection<E>
    
    Specified by:
    
    hashCode in interface java.util.List<E>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class DynamicArray<E>

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

DynamicArray

DynamicArray

DynamicArray

Method Detail

size

indexOf

lastIndexOf

get

set

add

add

addAll

remove

remove

remove

clear

iterator

listIterator

listIterator

subList

toArray

toArray

equals

hashCode

clone