Class BigList<E>
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<E>
-
- org.magicwerk.brownies.collections.IList<E>
-
- org.magicwerk.brownies.collections.BigList<E>
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.List<E>
,java.util.RandomAccess
,ICollection<E>
,IListable<E>
- Direct Known Subclasses:
BigList.ReadOnlyBigList
public class BigList<E> extends IList<E>
BigList 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 BigList 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 BigList is accessed by several threads at different positions.
Note that the iterators provided are not fail-fast.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
BigList.Block<T>
A block stores in maximum blockSize number of elements.(package private) static class
BigList.BlockNode<E>
Implements an AVLNode storing a Block.protected static class
BigList.ReadOnlyBigList<E>
A read-only version ofKey1List
.-
Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.IList
IList.IListableFromArray<E>, IList.IListableFromCollection<E>, IList.IListableFromList<E>, IList.IListableFromMult<E>, IList.Iter, IList.ListIter
-
-
Field Summary
Fields Modifier and Type Field Description private int
blockSize
Number of elements stored at maximum in a blockprivate static boolean
CHECK
Set to true for debugging during developingprivate int
currBlockEnd
End index of current blockprivate int
currBlockStart
Start index of current blockprivate int
currModify
Modify value which must be applied before this block is not current any moreprivate BigList.BlockNode<E>
currNode
Current nodeprivate static int
DEFAULT_BLOCK_SIZE
Default block sizeprivate static BigList
EMPTY
Unmodifiable empty instanceprivate static float
FILL_THRESHOLD
If an element is added to the list at the head or tail, the block is only filled until it has FILL_THRESHOLD*blockSize elements (so there is room for insertion without need to split).private static float
MERGE_THRESHOLD
If two adjacent blocks both less than MERGE_THRESHOLD*blockSize elements, they are mergedprivate BigList.BlockNode<E>
rootNode
The root node in the treeprivate static long
serialVersionUID
UID for serializationprivate int
size
Number of elements stored in this BigList
-
Constructor Summary
Constructors Modifier Constructor Description BigList()
Default constructor.protected
BigList(boolean copy, BigList<E> that)
Constructor used internally, e.g.BigList(int blockSize)
Constructor.private
BigList(int blockSize, int firstBlockSize)
Internal constructor.BigList(java.util.Collection<? extends E> coll)
Create new list with specified elements.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
addBlock(int index, BigList.Block<E> obj)
Adds a new element to the list.<K> int
binarySearch(int index, int len, K key, java.util.Comparator<? super K> comparator)
Searches the specified range for an object using the binary search algorithm.int
blockSize()
Returns block size used for this BigList.int
capacity()
As BigList grows and shrinks automatically, the term capacity does not really make sense.private void
check()
private void
checkHeight(BigList.BlockNode<E> node)
private void
checkNode(BigList.BlockNode<E> node)
BigList<E>
clone()
Returns a shallow copy of this list.BigList<E>
copy()
Returns a shallow copy of this list.private BigList.BlockNode<E>
copy(BigList.BlockNode<E> node)
Create a copy of the specified node.static <E> BigList<E>
create()
Create new list.static <E> BigList<E>
create(E... elems)
Create new list with specified elements.static <E> BigList<E>
create(java.util.Collection<? extends E> coll)
Create new list with specified elements.BigList<E>
crop()
Returns a copy this list but without elements.protected boolean
doAdd(int index, E element)
Helper method for adding an element to the list.protected boolean
doAddAll(int index, IListable<? extends E> list)
Helper method for adding multiple elements to the list.private void
doAddAllHead(IListable<? extends E> list, int addPos, int addLen, int space)
private void
doAddAllMiddle(IListable<? extends E> list, int addPos)
private void
doAddAllTail(IListable<? extends E> list, int addPos, int addLen, int space)
private void
doAddSplitBlock(int index, E element, int pos, BigList.Block<E> newBlock)
protected void
doAssign(IList<E> that)
Assign this list the content of the that list.protected void
doClear()
protected void
doClone(IList<E> that)
Initialize this object after the bitwise copy has been made by Object.clone().protected IList<E>
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 E
doGet(int index)
Helper method for getting an element from the list.private void
doGetBlock(int index, int modify)
Determine node/block for the specified index.private boolean
doGetBlockLeft(int modify, BigList.BlockNode<E> nextNode, boolean wasLeft)
private boolean
doGetBlockRight(int modify, BigList.BlockNode<E> nextNode, boolean wasLeft)
private void
doInit(int blockSize, int firstBlockSize)
Initialize BigList.protected E
doRemove(int index)
Helper method to remove an element.private BigList.BlockNode<E>
doRemove(BigList.BlockNode<E> node)
protected void
doRemoveAll(int index, int len)
Remove specified range of elements from list.private void
doRemoveAll2(int index, int len, int startPos, BigList.BlockNode<E> startNode, BigList.BlockNode<E> endNode)
protected E
doReSet(int index, E elem)
Sets an element at specified position.protected E
doSet(int index, E elem)
Helper method for setting an element in the list.static <EE> BigList<EE>
EMPTY()
protected void
finalize()
private int
getBlockIndex(int index, boolean write, int modify)
Returns index in block where the element with specified index is located.private int
getBlockIndex2(int index, boolean write, int modify)
E
getDefaultElem()
BigList<E>
immutableList()
Returns an immutable copy of this list.private boolean
isOnlyRootBlock()
boolean
isReadOnly()
Returns true if this list is either unmodifiable or immutable, false otherwise.private void
merge(BigList.BlockNode<E> node)
Merge the specified node with the left or right neighbor if possible.private void
modify(BigList.BlockNode<E> node, int modify)
Modify relativePosition of all nodes starting from the specified node.private void
modifyLeftNode(BigList.BlockNode<E> node, int modify)
private void
modifyRightNode(BigList.BlockNode<E> node, int modify)
private void
readObject(java.io.ObjectInputStream ois)
Deserialize a BigList object.private void
releaseBlock()
Release current block and apply modification if pending.int
size()
Return size of listvoid
sort(int index, int len, java.util.Comparator<? super E> comparator)
Sort specified elements in the list using the specified comparator.java.util.Spliterator<E>
spliterator()
void
trimToSize()
Pack as many elements in the blocks as allowed.BigList<E>
unmodifiableList()
Returns an unmodifiable view of this list.private void
writeObject(java.io.ObjectOutputStream oos)
Serialize a BigList object.-
Methods inherited from class org.magicwerk.brownies.collections.IList
add, add, addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, asDeque, asIListable, binarySearch, checkIndex, checkIndexAdd, checkLength, checkLengths, checkNonNull, checkRange, clear, contains, containsAll, containsAny, containsIf, copy, count, countIf, descendingIterator, doCreateArray, doGetAll, doIndexOf, doIndexOfIf, doInitAll, doLastIndexOf, doLastIndexOfIf, doModify, doPutAll, doReplace, doRotate, doTransfer, doTransferSwap, drag, element, ensureCapacity, equals, equalsElem, extract, extractIf, fill, filter, filterMap, flatMap, get, getAll, getAll, getDistinct, getFirst, getFirstOrNull, getIf, getLast, getLastOrNull, getSingle, getSingleOrNull, hashCode, hashCodeElem, indexOf, indexOf, indexOfIf, indexOfIf, initAll, initAll, initArray, initMult, isEmpty, iterator, lastIndexOf, lastIndexOf, lastIndexOfIf, lastIndexOfIf, listIterator, listIterator, map, mapFilter, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, remove, remove, remove, remove, removeAll, removeAll, removeAll, 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, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap, transform, transformedList
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
UID for serialization- See Also:
- Constant Field Values
-
DEFAULT_BLOCK_SIZE
private static final int DEFAULT_BLOCK_SIZE
Default block size- See Also:
- Constant Field Values
-
MERGE_THRESHOLD
private static final float MERGE_THRESHOLD
If two adjacent blocks both less than MERGE_THRESHOLD*blockSize elements, they are merged- See Also:
- Constant Field Values
-
FILL_THRESHOLD
private static final float FILL_THRESHOLD
If an element is added to the list at the head or tail, the block is only filled until it has FILL_THRESHOLD*blockSize elements (so there is room for insertion without need to split).- See Also:
- Constant Field Values
-
CHECK
private static final boolean CHECK
Set to true for debugging during developing- See Also:
- Constant Field Values
-
EMPTY
private static final BigList EMPTY
Unmodifiable empty instance
-
blockSize
private int blockSize
Number of elements stored at maximum in a block
-
size
private int size
Number of elements stored in this BigList
-
rootNode
private BigList.BlockNode<E> rootNode
The root node in the tree
-
currNode
private BigList.BlockNode<E> currNode
Current node
-
currBlockStart
private int currBlockStart
Start index of current block
-
currBlockEnd
private int currBlockEnd
End index of current block
-
currModify
private int currModify
Modify value which must be applied before this block is not current any more
-
-
Constructor Detail
-
BigList
protected BigList(boolean copy, BigList<E> that)
Constructor used internally, e.g. for ImmutableBigList.- Parameters:
copy
- true to copy all instance values from source, if false nothing is donethat
- list to copy
-
BigList
public BigList()
Default constructor. The default block size is used.
-
BigList
public BigList(int blockSize)
Constructor.- Parameters:
blockSize
- block size
-
BigList
public BigList(java.util.Collection<? extends E> coll)
Create new list with specified elements.- Parameters:
coll
- collection with element
-
BigList
private BigList(int blockSize, int firstBlockSize)
Internal constructor.- Parameters:
blockSize
- default block sizefirstBlockSize
- block size of first block
-
-
Method Detail
-
EMPTY
public static <EE> BigList<EE> EMPTY()
- Returns:
- unmodifiable empty instance
-
create
public static <E> BigList<E> create()
Create new list.- Type Parameters:
E
- type of elements stored in the list- Returns:
- created list
-
create
public static <E> BigList<E> create(java.util.Collection<? extends E> coll)
Create new list with specified elements.- Type Parameters:
E
- type of elements stored in the list- Parameters:
coll
- collection with element- Returns:
- created list
-
create
public static <E> BigList<E> create(E... elems)
Create new list with specified elements.- Type Parameters:
E
- type of elements stored in the list- Parameters:
elems
- array with elements- Returns:
- created list
-
blockSize
public int blockSize()
Returns block size used for this BigList.- Returns:
- block size used for this BigList
-
doInit
private void doInit(int blockSize, int firstBlockSize)
Initialize BigList.- Parameters:
blockSize
- default block sizefirstBlockSize
- block size of first block
-
crop
public BigList<E> crop()
Description copied from class:IList
Returns a copy this list but without elements. The new list will have the same type as this list.
-
isReadOnly
public boolean isReadOnly()
Description copied from class:IList
Returns true if this list is either unmodifiable or immutable, false otherwise.- Specified by:
isReadOnly
in classIList<E>
-
copy
public BigList<E> 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.
-
clone
public BigList<E> 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. UseIList.copy()
to .The copy is realized by a copy-on-write approach so also really large lists can efficiently be handled.
-
doAssign
protected void doAssign(IList<E> that)
Description copied from class:IList
Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.
-
doClone
protected void doClone(IList<E> that)
Description copied from class:IList
Initialize this object after the bitwise copy has been made by Object.clone().
-
copy
private BigList.BlockNode<E> copy(BigList.BlockNode<E> node)
Create a copy of the specified node.- Parameters:
node
- source node- Returns:
- newly created copy of source
-
getDefaultElem
public E getDefaultElem()
- Specified by:
getDefaultElem
in classIList<E>
-
finalize
protected void finalize()
- Overrides:
finalize
in classjava.lang.Object
-
spliterator
public java.util.Spliterator<E> spliterator()
-
size
public int size()
Description copied from interface:IListable
Return size of list
-
capacity
public int capacity()
As BigList grows and shrinks automatically, the term capacity does not really make sense. Therefore always -1 is returned.
-
doGet
protected E doGet(int index)
Description copied from class:IList
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.
-
doSet
protected E doSet(int index, E elem)
Description copied from class:IList
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.
-
doReSet
protected E doReSet(int index, E elem)
Description copied from class:IList
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.
-
releaseBlock
private void releaseBlock()
Release current block and apply modification if pending.
-
getBlockIndex
private int getBlockIndex(int index, boolean write, int modify)
Returns index in block where the element with specified index is located. This method also sets currBlock to remember this last used block.- Parameters:
index
- list index (0 <= index <= size())write
- true if the block is needed for a write operation (set, add, remove)modify
- modify instruction (N>0: N elements are added, N<0: N elements are removed, 0 no change)- Returns:
- relative index within block
-
getBlockIndex2
private int getBlockIndex2(int index, boolean write, int modify)
-
isOnlyRootBlock
private boolean isOnlyRootBlock()
- Returns:
- true if there is only the root block, false otherwise
-
doGetBlock
private void doGetBlock(int index, int modify)
Determine node/block for the specified index. The fields currNode, currBlockStart, and currBlockEnd are set. During the traversing the tree node, the nodes relative positions are changed according to the modify instruction.- Parameters:
index
- list index for which block must be determinedmodify
- modify instruction (N>0: N elements are added, N<0: N elements are removed, 0 no change)
-
doGetBlockLeft
private boolean doGetBlockLeft(int modify, BigList.BlockNode<E> nextNode, boolean wasLeft)
-
doGetBlockRight
private boolean doGetBlockRight(int modify, BigList.BlockNode<E> nextNode, boolean wasLeft)
-
addBlock
private void addBlock(int index, BigList.Block<E> obj)
Adds a new element to the list.- Parameters:
index
- the index to add beforeobj
- the element to add
-
doAdd
protected boolean doAdd(int index, E element)
Description copied from class:IList
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.
-
doAddSplitBlock
private void doAddSplitBlock(int index, E element, int pos, BigList.Block<E> newBlock)
-
modify
private void modify(BigList.BlockNode<E> node, int modify)
Modify relativePosition of all nodes starting from the specified node.- Parameters:
node
- node whose position value must be changedmodify
- modify value (>0 for add, <0 for delete)
-
modifyLeftNode
private void modifyLeftNode(BigList.BlockNode<E> node, int modify)
-
modifyRightNode
private void modifyRightNode(BigList.BlockNode<E> node, int modify)
-
doRemove
private BigList.BlockNode<E> doRemove(BigList.BlockNode<E> node)
-
doAddAll
protected boolean doAddAll(int index, IListable<? extends E> list)
Description copied from class:IList
Helper method for adding multiple elements to the list. This default implementation calls doAdd() for adding each element.
-
doAddAllTail
private void doAddAllTail(IListable<? extends E> list, int addPos, int addLen, int space)
-
doAddAllHead
private void doAddAllHead(IListable<? extends E> list, int addPos, int addLen, int space)
-
doRemoveAll
protected void doRemoveAll(int index, int len)
Description copied from class:IList
Remove specified range of elements from list.- Overrides:
doRemoveAll
in classIList<E>
- Parameters:
index
- index of first element to removelen
- number of elements to remove
-
doRemoveAll2
private void doRemoveAll2(int index, int len, int startPos, BigList.BlockNode<E> startNode, BigList.BlockNode<E> endNode)
-
merge
private void merge(BigList.BlockNode<E> node)
Merge the specified node with the left or right neighbor if possible.- Parameters:
node
- candidate node for merge
-
doRemove
protected E doRemove(int index)
Description copied from class:IList
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.
-
unmodifiableList
public BigList<E> unmodifiableList()
Description copied from class:IList
Returns an unmodifiable view of this list. This method allows modules to provide users with "read-only" access to internal lists, where changes made to the original list are visible as query operations on the returned list "read through" to the specified list. Attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException. If this list is already unmodifiable, it is returned unchanged. SeeIList.immutableList()
to get an immutable copy of a list.- Specified by:
unmodifiableList
in classIList<E>
- Returns:
- an unmodifiable view of the specified list
-
immutableList
public BigList<E> immutableList()
Description copied from class:IList
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. SeeIList.unmodifiableList()
to get unmodifiable view of a list.- Specified by:
immutableList
in classIList<E>
- Returns:
- an immutable copy of the specified list
-
doEnsureCapacity
protected void doEnsureCapacity(int minCapacity)
Description copied from class:IList
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 classIList<E>
- 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 classIList<E>
-
doCreate
protected IList<E> doCreate(int capacity)
Description copied from class:IList
Create list with specified capacity.
-
sort
public void sort(int index, int len, java.util.Comparator<? super E> comparator)
Description copied from class:IList
Sort specified elements in the list using the specified comparator.
-
binarySearch
public <K> int binarySearch(int index, int len, K key, java.util.Comparator<? super K> comparator)
Description copied from class:IList
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 classIList<E>
- Parameters:
index
- index of first element to searchlen
- number of elements to searchkey
- the value to be searched forcomparator
- the comparator by which the list is ordered. A null value indicates that the elements' natural ordering should be used.- 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)
-
writeObject
private void writeObject(java.io.ObjectOutputStream oos) throws java.io.IOException
Serialize a BigList object.- Parameters:
oos
- output stream for serialization- Throws:
java.io.IOException
- if serialization fails
-
readObject
private void readObject(java.io.ObjectInputStream ois) throws java.io.IOException, java.lang.ClassNotFoundException
Deserialize a BigList object.- Parameters:
ois
- input stream for serialization- Throws:
java.io.IOException
- if serialization failsjava.lang.ClassNotFoundException
- if serialization fails
-
checkNode
private void checkNode(BigList.BlockNode<E> node)
-
checkHeight
private void checkHeight(BigList.BlockNode<E> node)
-
check
private void check()
-
-