ArrayDoubleList (Commons Primitives 1.1-SNAPSHOT API)

java.lang.Object
- org.apache.commons.collections.primitives.AbstractDoubleCollection
- - org.apache.commons.collections.primitives.RandomAccessDoubleList
  - - org.apache.commons.collections.primitives.ArrayDoubleList

All Implemented Interfaces:

Serializable, DoubleCollection, DoubleList
```
public class ArrayDoubleList
extends RandomAccessDoubleList
implements DoubleList, Serializable
```
An DoubleList backed by an array of doubles. This implementation supports all optional methods.

Since:

Commons Primitives 1.0

Version:

$Revision: 480460 $ $Date: 2006-11-29 03:14:21 -0500 (Wed, 29 Nov 2006) $

Author:

Rodney Waldhoff

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessDoubleList
  RandomAccessDoubleList.RandomAccessDoubleListIterator, RandomAccessDoubleList.RandomAccessDoubleSubList

Constructor Summary

Constructors
Constructor and Description
`ArrayDoubleList()` Construct an empty list with the default initial capacity.
`ArrayDoubleList(double[] array)` Constructs a list by copying the specified array.
`ArrayDoubleList(DoubleCollection that)` Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.
`ArrayDoubleList(int initialCapacity)` Construct an empty list with the given initial capacity.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(int index, double element)` Inserts the specified element at the specified position (optional operation).
`boolean`	`addAll(DoubleCollection collection)` `Adds` all of the elements in the specified collection to me (optional operation).
`boolean`	`addAll(int index, DoubleCollection collection)` Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
`void`	`clear()` Removes all my elements (optional operation).
`void`	`ensureCapacity(int mincap)` Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.
`double`	`get(int index)` Returns the value of the element at the specified position within me.
`double`	`removeElementAt(int index)` Removes the element at the specified position in (optional operation).
`double`	`set(int index, double element)` Replaces the element at the specified position in me with the specified element (optional operation).
`int`	`size()` Returns the number of elements I contain.
`void`	`trimToSize()` Reduce my capacity, if necessary, to match my current `size`.

Methods inherited from class org.apache.commons.collections.primitives.RandomAccessDoubleList
add, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString

Methods inherited from class org.apache.commons.collections.primitives.AbstractDoubleCollection
contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray

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

Methods inherited from interface org.apache.commons.collections.primitives.DoubleList
add, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

Methods inherited from interface org.apache.commons.collections.primitives.DoubleCollection
contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray

- Constructor Detail
  - ArrayDoubleList
```
public ArrayDoubleList()
```
    Construct an empty list with the default initial capacity.
  - ArrayDoubleList
```
public ArrayDoubleList(int initialCapacity)
```
    Construct an empty list with the given initial capacity.
    
    Throws:
    
    IllegalArgumentException - when initialCapacity is negative
  - ArrayDoubleList
```
public ArrayDoubleList(DoubleCollection that)
```
    Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.
    
    Parameters:
    that - the non-null collection of doubles to add
    
    Throws:
    
    NullPointerException - if that is null
    See Also:
    addAll(org.apache.commons.collections.primitives.DoubleCollection)
  - ArrayDoubleList
```
public ArrayDoubleList(double[] array)
```
    Constructs a list by copying the specified array.
    
    Parameters:
    array - the array to initialize the collection with
    
    Throws:
    
    NullPointerException - if the array is null
- Method Detail
  - get
```
public double get(int index)
```
    Description copied from interface: DoubleList
    
    Returns the value of the element at the specified position within me.
    
    Specified by:
    
    get in interface DoubleList
    
    Specified by:
    
    get in class RandomAccessDoubleList
    
    Parameters:
    index - the index of the element to return
    
    Returns:
    the value of the element at the specified position
  - size
```
public int size()
```
    Description copied from interface: DoubleCollection
    
    Returns the number of elements I contain.
    
    Specified by:
    
    size in interface DoubleCollection
    
    Specified by:
    
    size in class RandomAccessDoubleList
    
    Returns:
    the number of elements I contain
  - removeElementAt
```
public double removeElementAt(int index)
```
    Removes the element at the specified position in (optional operation). Any subsequent elements are shifted to the left, subtracting one from their indices. Returns the element that was removed.
    
    Specified by:
    
    removeElementAt in interface DoubleList
    
    Overrides:
    
    removeElementAt in class RandomAccessDoubleList
    
    Parameters:
    index - the index of the element to remove
    
    Returns:
    the value of the element that was removed
    
    Throws:
    
    UnsupportedOperationException - when this operation is not supported
    
    IndexOutOfBoundsException - if the specified index is out of range
  - set
```
public double set(int index,
         double element)
```
    Replaces the element at the specified position in me with the specified element (optional operation).
    
    Specified by:
    
    set in interface DoubleList
    
    Overrides:
    
    set in class RandomAccessDoubleList
    
    Parameters:
    index - the index of the element to change
    element - the value to be stored at the specified position
    
    Returns:
    the value previously stored at the specified position
    
    Throws:
    
    UnsupportedOperationException - when this operation is not supported
    
    IndexOutOfBoundsException - if the specified index is out of range
  - add
```
public void add(int index,
       double element)
```
    Inserts the specified element at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices.
    
    Specified by:
    
    add in interface DoubleList
    
    Overrides:
    
    add in class RandomAccessDoubleList
    
    Parameters:
    index - the index at which to insert the element
    element - the value to insert
    
    Throws:
    
    UnsupportedOperationException - when this operation is not supported
    
    IllegalArgumentException - if some aspect of the specified element prevents it from being added to me
    
    IndexOutOfBoundsException - if the specified index is out of range
  - clear
```
public void clear()
```
    Description copied from interface: DoubleCollection
    
    Removes all my elements (optional operation). I will be empty after this method successfully returns.
    
    Specified by:
    
    clear in interface DoubleCollection
    
    Overrides:
    
    clear in class AbstractDoubleCollection
  - addAll
```
public boolean addAll(DoubleCollection collection)
```
    Description copied from interface: DoubleCollection
    
    Adds all of the elements in the specified collection to me (optional operation).
    
    Specified by:
    
    addAll in interface DoubleCollection
    
    Overrides:
    
    addAll in class AbstractDoubleCollection
    
    Parameters:
    collection - the collection of elements whose presence within me is to be ensured
    
    Returns:
    true iff I changed as a result of this call
  - addAll
```
public boolean addAll(int index,
             DoubleCollection collection)
```
    Description copied from interface: DoubleList
    
    Inserts all of the elements in the specified collection into me, at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices. The new elements will appear in the order that they are returned by the given collection's iterator.
    
    Specified by:
    
    addAll in interface DoubleList
    
    Overrides:
    
    addAll in class RandomAccessDoubleList
    
    Parameters:
    index - the index at which to insert the first element from the specified collection
    collection - the DoubleCollection of elements to add
    
    Returns:
    true iff I changed as a result of this call
  - ensureCapacity
```
public void ensureCapacity(int mincap)
```
    Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.
  - trimToSize
```
public void trimToSize()
```
    Reduce my capacity, if necessary, to match my current size.

Class ArrayDoubleList

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessDoubleList

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.collections.primitives.RandomAccessDoubleList

Methods inherited from class org.apache.commons.collections.primitives.AbstractDoubleCollection

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.collections.primitives.DoubleList

Methods inherited from interface org.apache.commons.collections.primitives.DoubleCollection

Constructor Detail

ArrayDoubleList

ArrayDoubleList

ArrayDoubleList

ArrayDoubleList

Method Detail

get

size

removeElementAt

set

add

clear

addAll

addAll

ensureCapacity

trimToSize