Class IntBigList

java.lang.Object

org.magicwerk.brownies.collections.primitive.IIntList

org.magicwerk.brownies.collections.primitive.IntBigList

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

IntBigList.ReadOnlyIntBigList

public class IntBigList
extends IIntList

IntBigList is a list optimized for storing large number of elements. It stores the elements in fixed size blocks and the blocks itself are maintained in a tree for fast access. It also offers specialized methods for bulk processing of elements. Also copying a IntBigList is efficiently possible as its implemented using a copy-on-write approach.

Note that this implementation is not synchronized. Due to data caching used for exploiting locality of reference, performance can decrease if IntBigList is accessed by several threads at different positions.

Note that the iterators provided are not fail-fast.

Author:

Thomas Mauch

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	IntBigList.ReadOnlyIntBigList	A read-only version of invalid reference Key1List .

Nested classes/interfaces inherited from class IIntList

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	IntBigList()	Default constructor.
protected	IntBigList(boolean copy, IntBigList that)	Constructor used internally, e.g. for ImmutableIntBigList.
	IntBigList(int blockSize)	Constructor.
	IntBigList(Collection<Integer> coll)	Create new list with specified elements.

Method Summary

Modifier and Type	Method	Description
int	binarySearch(int index, int len, int key)	Searches the specified range for an object using the binary search algorithm.
int	blockSize()	Returns block size used for this IntBigList.
int	capacity()	As IntBigList grows and shrinks automatically, the term capacity does not really make sense.
IntBigList	clone()	Returns a shallow copy of this list.
IntBigList	copy()	Returns a shallow copy of this list.
static IntBigList	create()
static IntBigList	create(int... elems)	Create new list with specified elements.
static IntBigList	create(Collection<Integer> coll)	Create new list with specified elements.
IntBigList	crop()	Returns a copy this list but without elements.
protected boolean	doAdd(int index, int element)	Helper method for adding an element to the list.
protected boolean	doAddAll(int index, org.magicwerk.brownies.collections.primitive.IIntListable list)	Helper method for adding multiple elements 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().
protected IIntList	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 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 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 IntBigList	EMPTY()
protected void	finalize()
int	getDefaultElem()
IntBigList	immutableList()	Returns an immutable copy of this list.
boolean	isReadOnly()	Returns true if this list is either unmodifiable or immutable, false otherwise.
int	size()
void	sort(int index, int len)	Sort specified elements in the list using the specified comparator.
void	trimToSize()	Pack as many elements in the blocks as allowed.
IntBigList	unmodifiableList()

Methods inherited from class IIntList

add, add, 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, doCreateArray, doGetAll, doIndexOf, doIndexOfIf, doInitAll, doLastIndexOf, doLastIndexOfIf, doModify, doPutAll, doReplace, doRotate, drag, element, ensureCapacity, equals, extract, extractIf, fill, filter, filterMap, flatMap, get, getAll, getAll, getDistinct, getFirst, getFirstOrNull, getIf, getLast, getLastOrNull, getSingle, getSingleOrNull, hashCode, indexOf, indexOf, indexOfIf, indexOfIf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, lastIndexOfIf, lastIndexOfIf, map, mapFilter, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, remove, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IntBigList

protected IntBigList(boolean copy,
 IntBigList that)

Constructor used internally, e.g. for ImmutableIntBigList.

Parameters:

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

that - list to copy

IntBigList

public IntBigList()

Default constructor. The default block size is used.

IntBigList

public IntBigList(int blockSize)

Constructor.

Parameters:

blockSize - block size

IntBigList

public IntBigList(Collection<Integer> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

Method Details

EMPTY

public static IntBigList EMPTY()

Returns:

unmodifiable empty instance

create

public static IntBigList create()

create

public static IntBigList create(Collection<Integer> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

type - of elements stored in the list

Returns:

created list

create

public static IntBigList create(int... elems)

Create new list with specified elements.

Parameters:

elems - array with elements

type - of elements stored in the list

Returns:

created list

blockSize

public int blockSize()

Returns block size used for this IntBigList.

Returns:

block size used for this IntBigList

crop

public IntBigList 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

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

copy

public IntBigList copy()

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.

The copy is realized by a copy-on-write approach so also really large lists can efficiently be handled.

Specified by:

copy in class IIntList

Returns:

a modifiable copy of this list

clone

public IntBigList clone()

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 .

The copy is realized by a copy-on-write approach so also really large lists can efficiently be handled.

Overrides:

clone in class IIntList

Returns:

a modifiable copy of this 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

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

getDefaultElem

public int getDefaultElem()

Specified by:

getDefaultElem in class IIntList

finalize

protected void finalize()

Overrides:

finalize in class Object

size

public int size()

Specified by:

size in class IIntList

capacity

public int capacity()

As IntBigList grows and shrinks automatically, the term capacity does not really make sense. Therefore always -1 is returned.

Specified by:

capacity in class IIntList

Returns:

capacity of this list

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

doAdd

protected boolean doAdd(int index,
 int element)

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)

element - element to add

Returns:

true if element has been added, false otherwise

doAddAll

protected boolean doAddAll(int index,
 org.magicwerk.brownies.collections.primitive.IIntListable list)

Description copied from class: IIntList

Helper method for adding multiple elements to the list. This default implementation calls doAdd() for adding each element.

Overrides:

doAddAll in class IIntList

Parameters:

index - index where element should be added (-1 is valid for adding at the end)

list - list with elements to add

Returns:

true if elements have been added, false otherwise

doClear

protected void doClear()

Overrides:

doClear in class IIntList

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

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

unmodifiableList

public IntBigList unmodifiableList()

Specified by:

unmodifiableList in class IIntList

immutableList

public IntBigList 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

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()

Pack as many elements in the blocks as allowed. An application can use this operation to minimize the storage of an instance.

Specified by:

trimToSize in class IIntList

doCreate

protected IIntList 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

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)