com.cosylab.acs.maci

Class IntArray

java.lang.Object

com.cosylab.acs.maci.IntArray

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IntArray
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

A resizable, array of integer primitives.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	data Array data.

Constructor Summary

Constructors

Constructor and Description
IntArray() Constrcuts a new IntArray instance with the default capacity.
IntArray(int capacity) Constrcuts a new IntArray instance with the specified capacity.
IntArray(int[] values) Constrcuts a new IntArray instance whose capacity is the greater of the length of values and DEFAULT_CAPACITY and whose initial contents are the specified values.

Method Summary

Modifier and Type	Method and Description
void	add(int val) Adds val to the end of the list, growing as needed.
void	add(int[] vals) Adds the values in the array vals to the end of the list, in order.
void	add(int[] vals, int offset, int length) Adds a subset of the values in the array vals to the end of the list, in order.
void	clear() Flushes the internal state of the list, resetting the capacity to the default.
void	clear(int capacity) Flushes the internal state of the list, setting the capacity of the empty list to capacity.
java.lang.Object	clone() Returns a clone of this list.
boolean	contains(int value) Searches the list for value
void	ensureCapacity(int capacity) Grow the internal array as needed to accomodate the specified number of elements.
boolean	equals(java.lang.Object other) Compares this list to another list, value by value.
int	get(int offset) Returns the value at the specified offset.
int	hashCode() Returns the hash code value for this list.
void	insert(int offset, int value) Inserts value into the list at offset.
void	insert(int offset, int[] values) Inserts the array of values into the list at offset.
void	insert(int offset, int[] values, int valOffset, int len) Inserts a slice of the array of values into the list at offset.
boolean	isEmpty() Tests whether this list contains any values.
int	remove(int value) Removes the element with value value from the list.
int	removeAt(int offset) Removes the value at offset from the list.
void	removeAt(int offset, int length) Removes length values from the list, starting at offset
void	set(int offset, int val) Sets the value at the specified offset.
void	set(int offset, int[] values) Replace the values in the list starting at offset with the contents of the values array.
void	set(int offset, int[] values, int valOffset, int length) Replace the values in the list starting at offset with length values from the values array, starting at valOffset.
int	size() Returns the number of values in the list.
int[]	toArray() Copies the contents of the list into a native array.
void	toArray(int[] dest, int offset, int len) Copies a slice of the list into a native array.
int[]	toArray(int offset, int len) Copies a slice of the list into a native array.
java.lang.String	toString() Returns a String representation of the list, front to back.
void	trimToSize() Sheds any excess capacity above and beyond the current size of the list.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

data

protected transient int[] data

Array data.

Constructor Detail

IntArray

public IntArray()

Constrcuts a new IntArray instance with the default capacity.

IntArray

public IntArray(int capacity)

Constrcuts a new IntArray instance with the specified capacity.

Parameters:

capacity - an int value

IntArray

public IntArray(int[] values)

Constrcuts a new IntArray instance whose capacity is the greater of the length of values and DEFAULT_CAPACITY and whose initial contents are the specified values.

Parameters:

values - an int[] value

Method Detail

ensureCapacity

public void ensureCapacity(int capacity)

Grow the internal array as needed to accomodate the specified number of elements. The size of the array doubles on each resize unless capacity requires more than twice the current capacity.

Parameters:

capacity - an int value

size

public int size()

Returns the number of values in the list.

Returns:

the number of values in the list.

isEmpty

public boolean isEmpty()

Tests whether this list contains any values.

Returns:

true if the list is empty.

trimToSize

public void trimToSize()

Sheds any excess capacity above and beyond the current size of the list.

add

public void add(int val)

Adds val to the end of the list, growing as needed.

Parameters:

val - an int value

add

public void add(int[] vals)

Adds the values in the array vals to the end of the list, in order.

Parameters:

vals - an int[] value

add

public void add(int[] vals,
                int offset,
                int length)

Adds a subset of the values in the array vals to the end of the list, in order.

Parameters:

vals - an int[] value

offset - the offset at which to start copying

length - the number of values to copy.

insert

public void insert(int offset,
                   int value)

Inserts value into the list at offset. All values including and to the right of offset are shifted to the right.

Parameters:

offset - an int value

value - an int value

insert

public void insert(int offset,
                   int[] values)

Inserts the array of values into the list at offset. All values including and to the right of offset are shifted to the right.

Parameters:

offset - an int value

values - an int[] value

insert

public void insert(int offset,
                   int[] values,
                   int valOffset,
                   int len)

Inserts a slice of the array of values into the list at offset. All values including and to the right of offset are shifted to the right.

Parameters:

offset - an int value

values - an int[] value

valOffset - the offset in the values array at which to start copying.

len - the number of values to copy from the values array

get

public int get(int offset)

Returns the value at the specified offset.

Parameters:

offset - an int value

Returns:

an int value

set

public void set(int offset,
                int val)

Sets the value at the specified offset.

Parameters:

offset - an int value

val - an int value

set

public void set(int offset,
                int[] values)

Replace the values in the list starting at offset with the contents of the values array.

Parameters:

offset - the first offset to replace

values - the source of the new values

set

public void set(int offset,
                int[] values,
                int valOffset,
                int length)

Replace the values in the list starting at offset with length values from the values array, starting at valOffset.

Parameters:

offset - the first offset to replace

values - the source of the new values

valOffset - the first value to copy from the values array

length - the number of values to copy

clear

public void clear()

Flushes the internal state of the list, resetting the capacity to the default.

clear

public void clear(int capacity)

Flushes the internal state of the list, setting the capacity of the empty list to capacity.

Parameters:

capacity - an int value

removeAt

public int removeAt(int offset)

Removes the value at offset from the list.

Parameters:

offset - an int value

Returns:

the value previously stored at offset.

remove

public int remove(int value)

Removes the element with value value from the list.

Parameters:

value - value of the element to be removed

Returns:

ofset of the removed element, -1 on failure.

removeAt

public void removeAt(int offset,
                     int length)

Removes length values from the list, starting at offset

Parameters:

offset - an int value

length - an int value

clone

public java.lang.Object clone()

Returns a clone of this list. Since this is a primitive collection, this will be a deep clone.

Overrides:

clone in class java.lang.Object

Returns:

a deep clone of the list.

toArray

public int[] toArray()

Copies the contents of the list into a native array.

Returns:

an int[] value

toArray

public int[] toArray(int offset,
                     int len)

Copies a slice of the list into a native array.

Parameters:

offset - the offset at which to start copying

len - the number of values to copy.

Returns:

an int[] value

toArray

public void toArray(int[] dest,
                    int offset,
                    int len)

Copies a slice of the list into a native array.

Parameters:

dest - the array to copy into.

offset - the offset of the first value to copy

len - the number of values to copy.

equals

public boolean equals(java.lang.Object other)

Compares this list to another list, value by value.

Overrides:

equals in class java.lang.Object

Parameters:

other - the object to compare against

Returns:

true if other is a TIntArrayList and has exactly the same values.

hashCode

public int hashCode()

Returns the hash code value for this list.

This implementation uses exactly the code that is used to define the list hash function in the documentation for the List.hashCode method.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this list.

contains

public boolean contains(int value)

Searches the list for value

Parameters:

value - an int value

Returns:

true if value is in the list.

toString

public java.lang.String toString()

Returns a String representation of the list, front to back.

Overrides:

toString in class java.lang.Object

Returns:

a String value