Class IntGapList

java.lang.Object

org.magicwerk.brownies.collections.primitive.IIntList

org.magicwerk.brownies.collections.primitive.IntGapList

Record Components:

type - of elements stored in the list

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

IntGapList.ReadOnlyList

public class IntGapList
extends IIntList

Class {link IntGapList} combines the strengths of both ArrayList and LinkedList. It is implemented to offer both efficient random access to elements by index (as ArrayList does) and at the same time efficient adding and removing elements to and from beginning and end (as LinkedList does). It also exploits the locality of reference often seen in applications to further improve performance, e.g. for iterating over the list.

The class can be used as drop-in replacement for ArrayList. It is also source compatible to LinkedList/Deque as it implements all needed methods. It cannot implement Deque however, use

invalid reference

#asDeque

to get a view implementing it.

Note that this implementation is not synchronized.

Note that the iterators provided are not fail-fast.

Author:

Thomas Mauch

See Also:

• List
• ArrayList
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	IntGapList.ReadOnlyList	A read-only version of IntGapList.

Nested classes/interfaces inherited from class IIntList

IIntList.IIntListableFromArray, IIntList.IIntListableFromCollection, IIntList.IIntListableFromList, IIntList.IIntListableFromMult

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CAPACITY	Default capacity for list

Constructor Summary

Constructors

Modifier	Constructor	Description
	IntGapList()	Construct a list with the default initial capacity.
protected	IntGapList(boolean copy, IntGapList that)	Constructor used internally, e.g. for ImmutableIntGapList.
	IntGapList(int capacity)	Construct a list with specified initial capacity.
	IntGapList(Collection<Integer> coll)	Construct a list to contain the specified elements.

Method Summary

Modifier and Type	Method	Description
boolean	add(int elem)
void	add(int index, int elem)	Inserts the specified element at the specified position in this list.
int	binarySearch(int index, int len, int key)	Searches the specified range for an object using the binary search algorithm.
int	capacity()	Returns capacity of this list.
IntGapList	clone()	Returns a shallow copy of this list.
IntGapList	copy()	Returns a shallow copy of this list.
static IntGapList	create()
static IntGapList	create(int... elems)	Create new list with specified elements.
static IntGapList	create(Collection<Integer> coll)	Create new list with specified elements.
IntGapList	crop()	Returns a copy this list but without elements.
protected boolean	doAdd(int index, int elem)	Helper method for adding an element to the list.
protected void	doAssign(IIntList that)	Assign this list the content of the that list.
protected void	doClear()
protected void	doClone(IIntList that)	Initialize this object after the bitwise copy has been made by Object.clone().
IntGapList	doCreate(int capacity)	Create list with specified capacity.
protected void	doEnsureCapacity(int minCapacity)	Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
protected int	doGet(int index)	Helper method for getting an element from the list.
protected void	doGetAll(int[] array, int index, int len)	Helper method to fill the specified elements in an array.
protected int	doRemove(int index)	Helper method to remove an element.
protected void	doRemoveAll(int index, int len)	Remove specified range of elements from list.
protected boolean	doRemoveAllFast(int index, int len)	Remove specified range of elements from list as specialized fast operation.
protected int	doReSet(int index, int elem)	Sets an element at specified position.
protected int	doSet(int index, int elem)	Helper method for setting an element in the list.
static IntGapList	EMPTY()
int	get(int index)
IntGapList	getAll(int elem)	Returns all elements in the list equal to the specified element.
IntGapList	getAll(int index, int len)	Returns specified range of elements from list.
int	getDefaultElem()
static IntGapList	immutable(int... elems)	Create new immutable list with specified elements.
static IntGapList	immutable(Collection<Integer> coll)	Create new immutable list with specified elements.
IntGapList	immutableList()	Returns an immutable copy of this list.
boolean	isReadOnly()	Returns true if this list is either unmodifiable or immutable, false otherwise.
<R> GapList<R>	map(Function<Integer,R> mapper)
int	remove(int index)
int	size()
void	sort(int index, int len)	Sort specified elements in the list using the specified comparator.
void	trimToSize()	Trims the capacity of this IntGapList instance to be the list's current size.
IntGapList	unmodifiableList()

Methods inherited from class IIntList

addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, asIIntListable, binarySearch, checkIndex, checkIndexAdd, checkLength, checkLengths, checkNonNull, checkRange, clear, contains, containsAll, containsAny, containsIf, copy, count, countIf, doAddAll, doCreateArray, doIndexOf, doIndexOfIf, doInitAll, doLastIndexOf, doLastIndexOfIf, doModify, doPutAll, doReplace, doRotate, drag, element, ensureCapacity, equals, extract, extractIf, fill, filter, filterMap, flatMap, getDistinct, getFirst, getFirstOrNull, getIf, getLast, getLastOrNull, getSingle, getSingleOrNull, hashCode, indexOf, indexOf, indexOfIf, indexOfIf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, lastIndexOfIf, lastIndexOfIf, mapFilter, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, remove, remove, removeAll, removeAll, removeAll, removeElem, removeFirst, removeFirstOccurrence, removeIf, removeLast, removeLastOccurrence, replace, replaceAll, replaceAll, replaceArray, replaceMult, resize, retain, retainAll, retainAll, retainIf, reverse, reverse, rotate, rotate, set, setAll, setAll, setArray, setArray, setMult, sort, swap, toArray, toArray, toArray, toArray, toArray, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap, transform, transformedList

Methods inherited from class Object

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

Field Details

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

Default capacity for list

See Also:

• Constant Field Values

Constructor Details

IntGapList

protected IntGapList(boolean copy,
 IntGapList that)

Constructor used internally, e.g. for ImmutableIntGapList.

Parameters:

copy - true to copy all instance values from source, if false nothing is done

that - list to copy

IntGapList

public IntGapList()

Construct a list with the default initial capacity.

IntGapList

public IntGapList(int capacity)

Construct a list with specified initial capacity.

Parameters:

capacity - capacity

IntGapList

public IntGapList(Collection<Integer> coll)

Construct a list to contain the specified elements. The list will have an initial capacity to hold these elements.

Parameters:

coll - collection with elements

Method Details

EMPTY

public static IntGapList EMPTY()

Returns:

unmodifiable empty instance

create

public static IntGapList create()

create

public static IntGapList create(Collection<Integer> coll)

Create new list with specified elements.

Parameters:

coll - collection with elements

type - of elements stored in the list

Returns:

created list

create

@SafeVarargs
public static IntGapList create(int... elems)

Create new list with specified elements.

Parameters:

elems - array with elements

type - of elements stored in the list

Returns:

created list

immutable

public static IntGapList immutable(Collection<Integer> coll)

Create new immutable list with specified elements. To reduce the needed memory, the list's capacity will be equal to its size.

Parameters:

coll - collection with elements

type - of elements stored in the list

Returns:

created list

immutable

@SafeVarargs
public static IntGapList immutable(int... elems)

Create new immutable list with specified elements. To reduce the needed memory, the list's capacity will be equal to its size.

Parameters:

elems - array with elements

type - of elements stored in the list

Returns:

created list

doAssign

protected void doAssign(IIntList that)

Description copied from class: IIntList

Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.

Specified by:

doAssign in class IIntList

Parameters:

that - list to copy content from

getDefaultElem

public int getDefaultElem()

Specified by:

getDefaultElem in class IIntList

crop

public IntGapList crop()

Description copied from class: IIntList

Returns a copy this list but without elements. The new list will have the same type as this list.

Overrides:

crop in class IIntList

Returns:

an empty copy of this list

copy

public IntGapList copy()

Description copied from class: IIntList

Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. This returned list will be modifiable, i.e. a read-only list will be copied and be modifiable again.

Specified by:

copy in class IIntList

Returns:

a modifiable copy of this list

clone

public IntGapList clone()

Description copied from class: IIntList

Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. If the list is read-only, the same list is returned without change. Use IIntList.copy() to .

Overrides:

clone in class IIntList

Returns:

a modifiable copy of this list

isReadOnly

public boolean isReadOnly()

Description copied from class: IIntList

Returns true if this list is either unmodifiable or immutable, false otherwise.

Specified by:

isReadOnly in class IIntList

unmodifiableList

public IntGapList unmodifiableList()

Specified by:

unmodifiableList in class IIntList

immutableList

public IntGapList immutableList()

Description copied from class: IIntList

Returns an immutable copy of this list. The returned list is independent from the original list, i.e. changes done later are not seen. Attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException. If this list is already immutable, it is returned unchanged. See IIntList.unmodifiableList() to get unmodifiable view of a list.

Specified by:

immutableList in class IIntList

Returns:

an immutable copy of the specified list

doClone

protected void doClone(IIntList that)

Description copied from class: IIntList

Initialize this object after the bitwise copy has been made by Object.clone().

Specified by:

doClone in class IIntList

Parameters:

that - source object

doClear

protected void doClear()

Overrides:

doClear in class IIntList

size

public int size()

Specified by:

size in class IIntList

capacity

public int capacity()

Description copied from class: IIntList

Returns capacity of this list. Note that two lists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.

Specified by:

capacity in class IIntList

Returns:

capacity of this list

get

public int get(int index)

Overrides:

get in class IIntList

doGet

protected int doGet(int index)

Description copied from class: IIntList

Helper method for getting an element from the list. This is the only method which really gets an element. Override if you need to validity checks before getting.

Specified by:

doGet in class IIntList

Parameters:

index - index of element to return

Returns:

the element at the specified position in this list

doSet

protected int doSet(int index,
 int elem)

Description copied from class: IIntList

Helper method for setting an element in the list. This is the only method which really sets an element. Override if you need to validity checks before setting.

Specified by:

doSet in class IIntList

Parameters:

index - index where element will be placed

elem - element to set

Returns:

old element which was at the position

doReSet

protected int doReSet(int index,
 int elem)

Description copied from class: IIntList

Sets an element at specified position. This method is used internally if existing elements will be moved etc. Override if you need to validity checks.

Specified by:

doReSet in class IIntList

Parameters:

index - index where element will be placed

elem - element to set

Returns:

old element which was at the position

add

public boolean add(int elem)

Overrides:

add in class IIntList

add

public void add(int index,
 int elem)

Description copied from class: IIntList

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Overrides:

add in class IIntList

Parameters:

index - index at which the specified element is to be inserted

elem - element to be inserted

getAll

public IntGapList getAll(int index,
 int len)

Description copied from class: IIntList

Returns specified range of elements from list.

Overrides:

getAll in class IIntList

Parameters:

index - index of first element to retrieve

len - number of elements to retrieve

Returns:

list containing the specified range of elements

getAll

public IntGapList getAll(int elem)

Description copied from class: IIntList

Returns all elements in the list equal to the specified element.

Overrides:

getAll in class IIntList

Parameters:

elem - element to look for

Returns:

all elements in the list equal to the specified element

map

public <R> GapList<R> map(Function<Integer,R> mapper)

Overrides:

map in class IIntList

doAdd

protected boolean doAdd(int index,
 int elem)

Description copied from class: IIntList

Helper method for adding an element to the list. This is the only method which really adds an element. Override if you need to validity checks before adding.

Specified by:

doAdd in class IIntList

Parameters:

index - index where element should be added (-1 means it is up to the implementation to choose the index)

elem - element to add

Returns:

true if element has been added, false otherwise

remove

public int remove(int index)

Overrides:

remove in class IIntList

doRemove

protected int doRemove(int index)

Description copied from class: IIntList

Helper method to remove an element. This is the only method which really removes an element. Override if you need to validity checks before removing.

Specified by:

doRemove in class IIntList

Parameters:

index - index of element to remove

Returns:

removed element

doEnsureCapacity

protected void doEnsureCapacity(int minCapacity)

Description copied from class: IIntList

Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

Specified by:

doEnsureCapacity in class IIntList

Parameters:

minCapacity - the desired minimum capacity

trimToSize

public void trimToSize()

Trims the capacity of this IntGapList instance to be the list's current size. An application can use this operation to minimize the storage of an instance.

Specified by:

trimToSize in class IIntList

doGetAll

protected void doGetAll(int[] array,
 int index,
 int len)

Description copied from class: IIntList

Helper method to fill the specified elements in an array.

Overrides:

doGetAll in class IIntList

Parameters:

array - array to store the list elements

index - index of first element to copy

len - number of elements to copy

doCreate

public IntGapList doCreate(int capacity)

Description copied from class: IIntList

Create list with specified capacity.

Specified by:

doCreate in class IIntList

Parameters:

capacity - initial capacity (use -1 for default capacity)

Returns:

created list

doRemoveAll

protected void doRemoveAll(int index,
 int len)

Description copied from class: IIntList

Remove specified range of elements from list.

Overrides:

doRemoveAll in class IIntList

Parameters:

index - index of first element to remove

len - number of elements to remove

doRemoveAllFast

protected boolean doRemoveAllFast(int index,
 int len)

Remove specified range of elements from list as specialized fast operation.

Parameters:

index - index of first element to remove

len - number of elements to remove

Returns:

true if removal could be done, false otherwise

sort

public void sort(int index,
 int len)

Description copied from class: IIntList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class IIntList

Parameters:

index - index of first element to sort

len - number of elements to sort

See Also:

• Arrays.sort(int[])

binarySearch

public int binarySearch(int index,
 int len,
 int key)

Description copied from class: IIntList

Searches the specified range for an object using the binary search algorithm.

Note that the method is defined to work with an arbitrary type <K>. This allows to search directly for a key field in the object without the need to construct an object containing the key:

persons.binarySearch("john", new SearchByName());

class SearchByName implements Comparator<Object> {
 public int compare(Object o1, Object o2) {
   String s1 = (o1 instanceof String) ? (String) o1 : ((Name) o1).getName();
   String s2 = (o2 instanceof String) ? (String) o2 : ((Name) o2).getName();
   return s1.compareTo(s2);
 }
}
/

Specified by:

binarySearch in class IIntList

Parameters:

index - index of first element to search

len - number of elements to search

key - the value to be searched for

Returns:

index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

See Also:

• Arrays.binarySearch(long[], long)