@structures/array-list

Classes

ArrayList

Class storing elements in contiguous memory. Allows precise control over resizing strategy.
Note: In most cases, the built-in JS Array will outperform this structure due to internal
optimizations.

Constants

DEFAULT_INITIAL_CAPACITY

DEFAULT_RESIZE_STRATEGY

ArrayList

Class storing elements in contiguous memory. Allows precise control over resizing strategy.
Note: In most cases, the built-in JS Array will outperform this structure due to internal
optimizations.

Kind: global class

* ArrayList
* [new ArrayList([initialCapacity], [resizeStrategy])](#new_ArrayList_new)
* .add(...elements) ⇒ ArrayList
* .addAll(iterable) ⇒ ArrayList
* .clear() ⇒ ArrayList
* [.contains(element, [comparator])](#ArrayList+contains) ⇒ boolean
.get(index) ⇒ \
* [.indexOf(element, [comparator])](#ArrayList+indexOf) ⇒ number
* .insert(index, element) ⇒ ArrayList
* .isEmpty() ⇒ boolean
.remove(index) ⇒ \
.set(index, elemnet) ⇒ \
* .size() ⇒ number
* .toString() ⇒ string
* .iterator() ⇒ iterator

$3

Creates a new ArrayList

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [initialCapacity] | number | DEFAULT_INITIAL_CAPACITY | Initial array capacity before resize required. |
| [resizeStrategy] | function | DEFAULT_RESIZE_STRATEGY | Function to resize array after capacity met. |

$3

Adds the passed elements to the list.

Kind: instance method of ArrayList
Returns: ArrayList - - This

| Param | Type | Description |
| --- | --- | --- |
| ...elements | \* | Elements to be added. |

$3

Adds each element in the passed array to the list.

Kind: instance method of ArrayList
Returns: ArrayList - - This
Throws:

- Error Will throw if iterable does not implement iterable protocol.

| Param | Type | Description |
| --- | --- | --- |
| iterable | Array | Iterable containing the elements to be added. |

$3

Clears all elements from the list.

Kind: instance method of ArrayList
Returns: ArrayList - - This

$3

Checks if an element exists within the list, with the comparator if passed.

Kind: instance method of ArrayList
Returns: boolean - - Returns true if element exists, false if not.

| Param | Type | Description |
| --- | --- | --- |
| element | \* | The element to check existence. |
| [comparator] | function | The function used to compare two elements. |

$3

Returns the element at the specified index.

Kind: instance method of ArrayList
Returns: \* - - Returns the element at the index given.
Throws:

- Error - Will throw if |index| is out of bounds for this list.

| Param | Type | Description |
| --- | --- | --- |
| index | number | The index to retrieve an element from. Negatives allowed. |

$3

Returns the index of the element, or -1 if it is not in the list.

Kind: instance method of ArrayList
Returns: number - - Returns the index of the element, or else -1.

| Param | Type | Description |
| --- | --- | --- |
| element | \* | The element to retrieve the index of. |
| [comparator] | function | The function used to compare two elements. |

$3

Inserts the element at the specified index, shifting remaining elements down.

Kind: instance method of ArrayList
Returns: ArrayList - - This
Throws:

- Error - Will throw if |index| is out of bounds for this list.

| Param | Type | Description |
| --- | --- | --- |
| index | number | The index to insert the element at. Negatives allowed. |
| element | \* | The element to insert. |

$3

Returns true if the list has no elements, or else false.

Kind: instance method of ArrayList
Returns: boolean - - Whether or not this list is empty

$3

Removes the element from the list, shifting remaining elements, and returns it.

Kind: instance method of ArrayList
Returns: \* - - The element that was removed.
Throws:

- Error - Will throw if |index| is out of bounds for this list.

| Param | Type | Description |
| --- | --- | --- |
| index | number | The index of the element to remove. Negatives allowed. |

$3

Replaces the element at the specified index.

Kind: instance method of ArrayList
Returns: \* - - The element that was replaced.
Throws:

- Error - Will throw if |index| is out of bounds for this list.

| Param | Type | Description |
| --- | --- | --- |
| index | number | The index of the element to replace. Negatives allowed. |
| elemnet | \* | The element to place in the list. |

$3

Returns the current number of elements in the list.

Kind: instance method of ArrayList
Returns: number - - The current list size.

$3

Returns a string representation of this list.

Kind: instance method of ArrayList
Returns: string - - The string representation of this list.

$3

Returns an object that implements the iterator protocol.

Kind: instance method of ArrayList
Returns: iterator - - An iterator for the list. Not access safe.

DEFAULT_INITIAL_CAPACITY

Kind: global constant
Default: 8

DEFAULT_RESIZE_STRATEGY

Kind: global constant
Default: - Doubles array capacity once limit is reached