IntArrayList (Cognitive Foundry)

java.lang.Object
- gov.sandia.cognition.collection.IntArrayList

All Implemented Interfaces:

java.io.Serializable
```
public final class IntArrayList
extends java.lang.Object
```
A memory-dense, base-type int vector that permits adding new elements, altering elements, etc. Allocates a local array of int. Doubles the size as needed and copies the old values into the new, larger array.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`DEFAULT_SIZE` The standard starting point for the array length
`protected int`	`numElements` The number of used elements in this

Constructor Summary

Constructors
Constructor and Description
`IntArrayList()` Initializes an empty vector with a default allocation.
`IntArrayList(int startSize)` Initializes an empty vector (allocating startSize locations for additions).
`IntArrayList(IntArrayList copy)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`add(int element)` Adds element to the end of the vector (allocating more space as needed
`protected void`	`checkBounds(int idx)` Checks that idx is in the allowed elements of the vector (distinct from the space in elements).
`protected static void`	`checkNewSizePositive(int size)` Helper that ensures the input size is positive
`void`	`clear()` Quickly "clears" the contents (sets numElements to 0).
`void`	`decreaseTo(int size)` Effectively remove elements from the vector.
`protected void`	`ensureNotFull()` Simple helper that increases the size if the current vector is full
`boolean`	`equals(java.lang.Object o)`
`int`	`get(int idx)` Returns the element at idx
`int`	`hashCode()`
`void`	`increaseTo(int size)` Resizes the background array if it is too small.
`protected int`	`length()` Returns the number of elements in the vector
`void`	`plusEquals(int idx, int val)` Adds val to the element at idx
`void`	`randomizeOrder()` Takes the elements of this and alters their order to a random order (using a variant of Fisher-Yates shuffle called Durstenfeld shuffle).
`void`	`randomizeOrder(java.util.Random r)` Takes the elements of this and alters their order to a random order (using a variant of Fisher-Yates shuffle called Durstenfeld shuffle).
`static IntArrayList`	`range(int max)` Creates a new instance pre-loaded with values [0 ..
`static IntArrayList`	`range(int min, int max)` Creates a new instance pre-loaded with values [min ..
`void`	`reserve(int size)` Resizes the background array to the specified size.
`protected void`	`resize(int size)` Replace the internal storage with a new buffer.
`void`	`set(int idx, int val)` Sets the element at idx
`void`	`shrinkToFit()` Resizes the background array to exactly fit the current number of elements.
`int`	`size()` Returns the number of elements added to the vector (not the size of the storage)
`void`	`swap(int p1, int p2)` Swaps the values stored at p1 and p2.
`static IntArrayList`	`zeros(int size)` Factory method that initializes a IntVector of the input size with zeros in every entry.

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

- Field Detail
  - numElements
```
protected int numElements
```
    The number of used elements in this
  - DEFAULT_SIZE
```
protected static final int DEFAULT_SIZE
```
    The standard starting point for the array length
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IntArrayList
```
public IntArrayList()
```
    Initializes an empty vector with a default allocation.
  - IntArrayList
```
public IntArrayList(int startSize)
```
    Initializes an empty vector (allocating startSize locations for additions). An accurate estimate of the final size will reduce storage allocations.
    
    Parameters:
    
    startSize - The number of positions to start the storage
  - IntArrayList
```
public IntArrayList(IntArrayList copy)
```
    Copy constructor
    
    Parameters:
    
    copy - The vector to make a deep copy of
- Method Detail
  - add
```
public int add(int element)
```
    Adds element to the end of the vector (allocating more space as needed
    
    Parameters:
    
    element - The element to add to the end
    
    Returns:
    
    the number of elements in this
  - get
```
public int get(int idx)
```
    Returns the element at idx
    
    Parameters:
    
    idx - The index
    
    Returns:
    
    the element at idx
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if idx is outside the allowed bounds
  - set
```
public void set(int idx,
                int val)
```
    Sets the element at idx
    
    Parameters:
    
    idx - The index
    
    val - The new value at idx
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if idx is outside the allowed bounds
  - plusEquals
```
public void plusEquals(int idx,
                       int val)
```
    Adds val to the element at idx
    
    Parameters:
    
    idx - The index
    
    val - The value to add at idx
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if idx is outside the allowed bounds
  - swap
```
public void swap(int p1,
                 int p2)
```
    Swaps the values stored at p1 and p2. Both must be within the bounds of the elements in the array.
    
    Parameters:
    
    p1 - The first index to swap
    
    p2 - The second index to swap
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if either index is outside the allowed bounds
  - resize
```
protected void resize(int size)
```
    Replace the internal storage with a new buffer. Used primarily to grow the storage when necessary.
    
    Parameters:
    
    size - the number of elements in the new internal array
  - length
```
protected int length()
```
    Returns the number of elements in the vector
    
    Returns:
    
    the number of elements in the vector
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - randomizeOrder
```
@PublicationReference(type=WebPage,
                      title="Fisher-Yates Suffle: The modern algorithm",
                      year=2016,
                      url="https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#The_modern_algorithm",
                      author="Wikipedia")
public void randomizeOrder()
```
    Takes the elements of this and alters their order to a random order (using a variant of Fisher-Yates shuffle called Durstenfeld shuffle).
  - randomizeOrder
```
public void randomizeOrder(java.util.Random r)
```
    Takes the elements of this and alters their order to a random order (using a variant of Fisher-Yates shuffle called Durstenfeld shuffle).
    
    Parameters:
    
    r - The random number generator to be used here
  - range
```
public static IntArrayList range(int max)
```
    Creates a new instance pre-loaded with values [0 .. max). Note that it does not include max.
    
    Parameters:
    
    max - The number of elements to include in the result
    
    Returns:
    
    a new instance pre-loaded with values [0 .. max)
  - range
```
public static IntArrayList range(int min,
                                 int max)
```
    Creates a new instance pre-loaded with values [min .. max). Note that it does not include max.
    
    Parameters:
    
    min - The number to start the range with
    
    max - The number one shy of the maximum value
    
    Returns:
    
    a new instance pre-loaded with values [min .. max)
  - zeros
```
public static IntArrayList zeros(int size)
```
    Factory method that initializes a IntVector of the input size with zeros in every entry.
    
    Parameters:
    
    size - The number of zeros to put in the returned DoubleVector
    
    Returns:
    
    a IntVector of the input size with zeroes in every entry
  - reserve
```
public void reserve(int size)
```
    Resizes the background array to the specified size. If the new size is larger than the number of elements in the array at present, old values are preserved. If smaller, the array shrinks to the correct size and elements past that point are lost.
    
    Parameters:
    
    size - The new size for the array
  - shrinkToFit
```
public void shrinkToFit()
```
    Resizes the background array to exactly fit the current number of elements.
  - increaseTo
```
public void increaseTo(int size)
```
    Resizes the background array if it is too small. Preserves current values.
    
    Parameters:
    
    size - The new size
  - decreaseTo
```
public void decreaseTo(int size)
```
    Effectively remove elements from the vector. Does not reallocate storage.
    
    Parameters:
    
    size - The new length of the array
  - clear
```
public void clear()
```
    Quickly "clears" the contents (sets numElements to 0). All old data is unavailable.
  - size
```
public int size()
```
    Returns the number of elements added to the vector (not the size of the storage)
    
    Returns:
    
    the number of elements added to the vector
  - ensureNotFull
```
protected void ensureNotFull()
```
    Simple helper that increases the size if the current vector is full
  - checkBounds
```
protected void checkBounds(int idx)
```
    Checks that idx is in the allowed elements of the vector (distinct from the space in elements).
    
    Parameters:
    
    idx - the index into the vector
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - if idx is outside the allowed bounds
  - checkNewSizePositive
```
protected static void checkNewSizePositive(int size)
```
    Helper that ensures the input size is positive
    
    Parameters:
    
    size - The new size
    
    Throws:
    
    java.lang.IllegalArgumentException - if size is negative

Class IntArrayList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

numElements

DEFAULT_SIZE

Constructor Detail

IntArrayList

IntArrayList

IntArrayList

Method Detail

add

get

set

plusEquals

swap

resize

length

hashCode

equals

randomizeOrder

randomizeOrder

range

range

zeros

reserve

shrinkToFit

increaseTo

decreaseTo

clear

size

ensureNotFull

checkBounds

checkNewSizePositive