Class LongBigList
- java.lang.Object
-
- org.magicwerk.brownies.collections.primitive.ILongList
-
- org.magicwerk.brownies.collections.primitive.LongBigList
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,ILongListable
- Direct Known Subclasses:
LongBigList.ReadOnlyLongBigList
public class LongBigList extends ILongList
LongBigList 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 LongBigList 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 LongBigList 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
LongBigList.LongBlock
A block stores in maximum blockSize number of elements.(package private) static class
LongBigList.LongBlockNode
Implements an AVLNode storing a LongBlock.protected static class
LongBigList.ReadOnlyLongBigList
A read-only version ofKey1List
.-
Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.primitive.ILongList
ILongList.ILongListableFromArray, ILongList.ILongListableFromCollection, ILongList.ILongListableFromList, ILongList.ILongListableFromMult
-
-
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
currLongBlockEnd
End index of current blockprivate int
currLongBlockStart
Start index of current blockprivate int
currModify
Modify value which must be applied before this block is not current any moreprivate LongBigList.LongBlockNode
currNode
Current nodeprivate static int
DEFAULT_BLOCK_SIZE
Default block sizeprivate static LongBigList
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 LongBigList.LongBlockNode
rootNode
The root node in the treeprivate static long
serialVersionUID
UID for serializationprivate int
size
Number of elements stored in this LongBigList
-
Constructor Summary
Constructors Modifier Constructor Description LongBigList()
Default constructor.protected
LongBigList(boolean copy, LongBigList that)
Constructor used internally, e.g.LongBigList(int blockSize)
Constructor.private
LongBigList(int blockSize, int firstLongBlockSize)
Internal constructor.LongBigList(java.util.Collection<java.lang.Long> coll)
Create new list with specified elements.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
addLongBlock(int index, LongBigList.LongBlock obj)
Adds a new element to the list.int
binarySearch(int index, int len, long key)
Searches the specified range for an object using the binary search algorithm.int
blockSize()
Returns block size used for this LongBigList.int
capacity()
As LongBigList grows and shrinks automatically, the term capacity does not really make sense.private void
check()
private void
checkHeight(LongBigList.LongBlockNode node)
private void
checkNode(LongBigList.LongBlockNode node)
LongBigList
clone()
Returns a shallow copy of this list.LongBigList
copy()
Returns a shallow copy of this list.private LongBigList.LongBlockNode
copy(LongBigList.LongBlockNode node)
Create a copy of the specified node.static LongBigList
create()
static LongBigList
create(long... elems)
Create new list with specified elements.static LongBigList
create(java.util.Collection<java.lang.Long> coll)
Create new list with specified elements.LongBigList
crop()
Returns a copy this list but without elements.protected boolean
doAdd(int index, long element)
Helper method for adding an element to the list.protected boolean
doAddAll(int index, ILongListable list)
Helper method for adding multiple elements to the list.private void
doAddAllHead(ILongListable list, int addPos, int addLen, int space)
private void
doAddAllMiddle(ILongListable list, int addPos)
private void
doAddAllTail(ILongListable list, int addPos, int addLen, int space)
private void
doAddSplitLongBlock(int index, long element, int pos, LongBigList.LongBlock newLongBlock)
protected void
doAssign(ILongList that)
Assign this list the content of the that list.protected void
doClear()
protected void
doClone(ILongList that)
Initialize this object after the bitwise copy has been made by Object.clone().protected ILongList
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 long
doGet(int index)
Helper method for getting an element from the list.private void
doGetLongBlock(int index, int modify)
Determine node/block for the specified index.private boolean
doGetLongBlockLeft(int modify, LongBigList.LongBlockNode nextNode, boolean wasLeft)
private boolean
doGetLongBlockRight(int modify, LongBigList.LongBlockNode nextNode, boolean wasLeft)
private void
doInit(int blockSize, int firstLongBlockSize)
Initialize LongBigList.protected long
doRemove(int index)
Helper method to remove an element.private LongBigList.LongBlockNode
doRemove(LongBigList.LongBlockNode node)
protected void
doRemoveAll(int index, int len)
Remove specified range of elements from list.private void
doRemoveAll2(int index, int len, int startPos, LongBigList.LongBlockNode startNode, LongBigList.LongBlockNode endNode)
protected long
doReSet(int index, long elem)
Sets an element at specified position.protected long
doSet(int index, long elem)
Helper method for setting an element in the list.static LongBigList
EMPTY()
protected void
finalize()
long
getDefaultElem()
private int
getLongBlockIndex(int index, boolean write, int modify)
Returns index in block where the element with specified index is located.private int
getLongBlockIndex2(int index, boolean write, int modify)
LongBigList
immutableList()
Returns an immutable copy of this list.private boolean
isOnlyRootLongBlock()
boolean
isReadOnly()
Returns true if this list is either unmodifiable or immutable, false otherwise.private void
merge(LongBigList.LongBlockNode node)
Merge the specified node with the left or right neighbor if possible.private void
modify(LongBigList.LongBlockNode node, int modify)
Modify relativePosition of all nodes starting from the specified node.private void
modifyLeftNode(LongBigList.LongBlockNode node, int modify)
private void
modifyRightNode(LongBigList.LongBlockNode node, int modify)
private void
readObject(java.io.ObjectInputStream ois)
Deserialize a LongBigList object.private void
releaseLongBlock()
Release current block and apply modification if pending.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.LongBigList
unmodifiableList()
private void
writeObject(java.io.ObjectOutputStream oos)
Serialize a LongBigList object.-
Methods inherited from class org.magicwerk.brownies.collections.primitive.ILongList
add, add, addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, asILongListable, 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, 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, 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, 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 LongBigList 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 LongBigList
-
rootNode
private LongBigList.LongBlockNode rootNode
The root node in the tree
-
currNode
private LongBigList.LongBlockNode currNode
Current node
-
currLongBlockStart
private int currLongBlockStart
Start index of current block
-
currLongBlockEnd
private int currLongBlockEnd
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
-
LongBigList
protected LongBigList(boolean copy, LongBigList that)
Constructor used internally, e.g. for ImmutableLongBigList.- Parameters:
copy
- true to copy all instance values from source, if false nothing is donethat
- list to copy
-
LongBigList
public LongBigList()
Default constructor. The default block size is used.
-
LongBigList
public LongBigList(int blockSize)
Constructor.- Parameters:
blockSize
- block size
-
LongBigList
public LongBigList(java.util.Collection<java.lang.Long> coll)
Create new list with specified elements.- Parameters:
coll
- collection with element
-
LongBigList
private LongBigList(int blockSize, int firstLongBlockSize)
Internal constructor.- Parameters:
blockSize
- default block sizefirstLongBlockSize
- block size of first block
-
-
Method Detail
-
EMPTY
public static LongBigList EMPTY()
- Returns:
- unmodifiable empty instance
-
create
public static LongBigList create()
-
create
public static LongBigList create(java.util.Collection<java.lang.Long> coll)
Create new list with specified elements.- Parameters:
coll
- collection with elementtype
- of elements stored in the list- Returns:
- created list
-
create
public static LongBigList create(long... elems)
Create new list with specified elements.- Parameters:
elems
- array with elementstype
- of elements stored in the list- Returns:
- created list
-
blockSize
public int blockSize()
Returns block size used for this LongBigList.- Returns:
- block size used for this LongBigList
-
doInit
private void doInit(int blockSize, int firstLongBlockSize)
Initialize LongBigList.- Parameters:
blockSize
- default block sizefirstLongBlockSize
- block size of first block
-
crop
public LongBigList crop()
Description copied from class:ILongList
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:ILongList
Returns true if this list is either unmodifiable or immutable, false otherwise.- Specified by:
isReadOnly
in classILongList
-
copy
public LongBigList 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 LongBigList 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. UseILongList.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(ILongList that)
Description copied from class:ILongList
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(ILongList that)
Description copied from class:ILongList
Initialize this object after the bitwise copy has been made by Object.clone().
-
copy
private LongBigList.LongBlockNode copy(LongBigList.LongBlockNode node)
Create a copy of the specified node.- Parameters:
node
- source node- Returns:
- newly created copy of source
-
getDefaultElem
public long getDefaultElem()
- Specified by:
getDefaultElem
in classILongList
-
finalize
protected void finalize()
- Overrides:
finalize
in classjava.lang.Object
-
size
public int size()
- Specified by:
size
in interfaceILongListable
- Specified by:
size
in classILongList
-
capacity
public int capacity()
As LongBigList grows and shrinks automatically, the term capacity does not really make sense. Therefore always -1 is returned.
-
doGet
protected long doGet(int index)
Description copied from class:ILongList
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 long doSet(int index, long elem)
Description copied from class:ILongList
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 long doReSet(int index, long elem)
Description copied from class:ILongList
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.
-
releaseLongBlock
private void releaseLongBlock()
Release current block and apply modification if pending.
-
getLongBlockIndex
private int getLongBlockIndex(int index, boolean write, int modify)
Returns index in block where the element with specified index is located. This method also sets currLongBlock 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
-
getLongBlockIndex2
private int getLongBlockIndex2(int index, boolean write, int modify)
-
isOnlyRootLongBlock
private boolean isOnlyRootLongBlock()
- Returns:
- true if there is only the root block, false otherwise
-
doGetLongBlock
private void doGetLongBlock(int index, int modify)
Determine node/block for the specified index. The fields currNode, currLongBlockStart, and currLongBlockEnd 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)
-
doGetLongBlockLeft
private boolean doGetLongBlockLeft(int modify, LongBigList.LongBlockNode nextNode, boolean wasLeft)
-
doGetLongBlockRight
private boolean doGetLongBlockRight(int modify, LongBigList.LongBlockNode nextNode, boolean wasLeft)
-
addLongBlock
private void addLongBlock(int index, LongBigList.LongBlock 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, long element)
Description copied from class:ILongList
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.
-
doAddSplitLongBlock
private void doAddSplitLongBlock(int index, long element, int pos, LongBigList.LongBlock newLongBlock)
-
modify
private void modify(LongBigList.LongBlockNode 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(LongBigList.LongBlockNode node, int modify)
-
modifyRightNode
private void modifyRightNode(LongBigList.LongBlockNode node, int modify)
-
doRemove
private LongBigList.LongBlockNode doRemove(LongBigList.LongBlockNode node)
-
doAddAll
protected boolean doAddAll(int index, ILongListable list)
Description copied from class:ILongList
Helper method for adding multiple elements to the list. This default implementation calls doAdd() for adding each element.
-
doAddAllTail
private void doAddAllTail(ILongListable list, int addPos, int addLen, int space)
-
doAddAllHead
private void doAddAllHead(ILongListable list, int addPos, int addLen, int space)
-
doAddAllMiddle
private void doAddAllMiddle(ILongListable list, int addPos)
-
doRemoveAll
protected void doRemoveAll(int index, int len)
Description copied from class:ILongList
Remove specified range of elements from list.- Overrides:
doRemoveAll
in classILongList
- Parameters:
index
- index of first element to removelen
- number of elements to remove
-
doRemoveAll2
private void doRemoveAll2(int index, int len, int startPos, LongBigList.LongBlockNode startNode, LongBigList.LongBlockNode endNode)
-
merge
private void merge(LongBigList.LongBlockNode node)
Merge the specified node with the left or right neighbor if possible.- Parameters:
node
- candidate node for merge
-
doRemove
protected long doRemove(int index)
Description copied from class:ILongList
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 LongBigList unmodifiableList()
- Specified by:
unmodifiableList
in classILongList
-
immutableList
public LongBigList immutableList()
Description copied from class:ILongList
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. SeeILongList.unmodifiableList()
to get unmodifiable view of a list.- Specified by:
immutableList
in classILongList
- Returns:
- an immutable copy of the specified list
-
doEnsureCapacity
protected void doEnsureCapacity(int minCapacity)
Description copied from class:ILongList
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 classILongList
- 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 classILongList
-
doCreate
protected ILongList doCreate(int capacity)
Description copied from class:ILongList
Create list with specified capacity.
-
sort
public void sort(int index, int len)
Description copied from class:ILongList
Sort specified elements in the list using the specified comparator.
-
binarySearch
public int binarySearch(int index, int len, long key)
Description copied from class:ILongList
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 classILongList
- Parameters:
index
- index of first element to searchlen
- number of elements to searchkey
- 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)
-
writeObject
private void writeObject(java.io.ObjectOutputStream oos) throws java.io.IOException
Serialize a LongBigList 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 LongBigList object.- Parameters:
ois
- input stream for serialization- Throws:
java.io.IOException
- if serialization failsjava.lang.ClassNotFoundException
- if serialization fails
-
checkNode
private void checkNode(LongBigList.LongBlockNode node)
-
checkHeight
private void checkHeight(LongBigList.LongBlockNode node)
-
check
private void check()
-
-