maspack.util

Class DynamicArray<T>

java.lang.Object

maspack.util.DynamicArray<T>

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<T>, Clonable

public class DynamicArray<T>
extends java.lang.Object
implements java.lang.Iterable<T>, Clonable

Implements a resizable array of objects (similar to ArrayList), but provides access to the backing buffer

Constructor Summary

Constructors

Constructor and Description
DynamicArray(java.lang.Class<T> type) Creates an empty dynamic array (size=0) of the given type
DynamicArray(java.lang.Class<T> type, int size) Creates a dynamic array of initial fixed size.
DynamicArray(T[] array) Creates a new dynamic array from a fixed-size array.

Method Summary

Modifier and Type	Method and Description
void	add(T value) Adds a new item to the back of the dynamic array, growing the size by one
void	addAll(java.util.Collection<T> collection) Adds a collection of items to the dynamic array, growing the size of the array to fit all elements.
void	addAll(DynamicArray<T> array) Adds a collection of items to the dynamic array, growing the size of the array to fit all elements
DynamicArray<T>	clone()
boolean	contains(T val) Searches the array to find if the item already exists in the array
void	ensureCapacity(int minCapacity) Ensures the dynamic array has a minimum storage capacity before it will need to "grow" to fit new elements
T	get(int idx) Retrieves the item at the given index.
T[]	getArray() Provides direct access to the underlying array.
int	indexOf(T val) Searches the array to find the index of the first element that matches the one provided.
java.util.Iterator<T>	iterator()
void	resize(int size) Sets the size of the dynamic array, either growing or trimming elements as required
void	set(int idx, T value) Sets the value at the given index.
int	size() Current number of elements in the dynamic array
void	trimToSize() Adjusts the internal storage to match the current size of the array

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DynamicArray

public DynamicArray(T[] array)

Creates a new dynamic array from a fixed-size array. The array is copied internally.

Parameters:

array - initial array

DynamicArray

public DynamicArray(java.lang.Class<T> type)

Creates an empty dynamic array (size=0) of the given type

Parameters:

type - class type for internal storage

DynamicArray

public DynamicArray(java.lang.Class<T> type,
                    int size)

Creates a dynamic array of initial fixed size. The array is populated with null elements.

Parameters:

type - class type for internal storage

size - initial number of elements

Method Detail

trimToSize

public void trimToSize()

Adjusts the internal storage to match the current size of the array

ensureCapacity

public void ensureCapacity(int minCapacity)

Ensures the dynamic array has a minimum storage capacity before it will need to "grow" to fit new elements

Parameters:

minCapacity - minimum storage capacity

size

public int size()

Current number of elements in the dynamic array

Returns:

array size

resize

public void resize(int size)

Sets the size of the dynamic array, either growing or trimming elements as required

Parameters:

size - new size of the array

add

public void add(T value)

Adds a new item to the back of the dynamic array, growing the size by one

Parameters:

value - new value to add to the array

addAll

public void addAll(java.util.Collection<T> collection)

Adds a collection of items to the dynamic array, growing the size of the array to fit all elements.

Parameters:

collection - items to append to the array

addAll

public void addAll(DynamicArray<T> array)

Adds a collection of items to the dynamic array, growing the size of the array to fit all elements

Parameters:

array - items to append to the array

get

public final T get(int idx)

Retrieves the item at the given index. The index must be in the range [0, this.size()-1].

Parameters:

idx - index of item to return

Returns:

the item

indexOf

public int indexOf(T val)

Searches the array to find the index of the first element that matches the one provided.

Parameters:

val - item to search for

Returns:

index of item if found, or -1 if not found

contains

public boolean contains(T val)

Searches the array to find if the item already exists in the array

Parameters:

val - item to search for

Returns:

true if found, false otherwise

getArray

public T[] getArray()

Provides direct access to the underlying array. The underlying array is automatically trimmed to the correct size before being returned.

Returns:

the underlying array

set

public void set(int idx,
                T value)

Sets the value at the given index. The index must be smaller than the current size of the array. To grow the array, use add(Object), or set the dynamic array size using resize(int).

Parameters:

idx - index of item to set

value - value to set

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

clone

public DynamicArray<T> clone()

Specified by:

clone in interface Clonable

Overrides:

clone in class java.lang.Object