Class BooleanBigList
- java.lang.Object
-
- org.magicwerk.brownies.collections.primitive.IBooleanList
-
- org.magicwerk.brownies.collections.primitive.BooleanBigList
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,IBooleanListable
- Direct Known Subclasses:
BooleanBigList.ReadOnlyBooleanBigList
public class BooleanBigList extends IBooleanList
BooleanBigList 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 BooleanBigList 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 BooleanBigList 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
BooleanBigList.BooleanBlock
A block stores in maximum blockSize number of elements.(package private) static class
BooleanBigList.BooleanBlockNode
Implements an AVLNode storing a BooleanBlock.protected static class
BooleanBigList.ReadOnlyBooleanBigList
A read-only version ofKey1List
.-
Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.primitive.IBooleanList
IBooleanList.IBooleanListableFromArray, IBooleanList.IBooleanListableFromCollection, IBooleanList.IBooleanListableFromList, IBooleanList.IBooleanListableFromMult
-
-
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
currBooleanBlockEnd
End index of current blockprivate int
currBooleanBlockStart
Start index of current blockprivate int
currModify
Modify value which must be applied before this block is not current any moreprivate BooleanBigList.BooleanBlockNode
currNode
Current nodeprivate static int
DEFAULT_BLOCK_SIZE
Default block sizeprivate static BooleanBigList
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 BooleanBigList.BooleanBlockNode
rootNode
The root node in the treeprivate static long
serialVersionUID
UID for serializationprivate int
size
Number of elements stored in this BooleanBigList
-
Constructor Summary
Constructors Modifier Constructor Description BooleanBigList()
Default constructor.protected
BooleanBigList(boolean copy, BooleanBigList that)
Constructor used internally, e.g.BooleanBigList(int blockSize)
Constructor.private
BooleanBigList(int blockSize, int firstBooleanBlockSize)
Internal constructor.BooleanBigList(java.util.Collection<java.lang.Boolean> coll)
Create new list with specified elements.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
addBooleanBlock(int index, BooleanBigList.BooleanBlock obj)
Adds a new element to the list.int
binarySearch(int index, int len, boolean key)
Searches the specified range for an object using the binary search algorithm.int
blockSize()
Returns block size used for this BooleanBigList.int
capacity()
As BooleanBigList grows and shrinks automatically, the term capacity does not really make sense.private void
check()
private void
checkHeight(BooleanBigList.BooleanBlockNode node)
private void
checkNode(BooleanBigList.BooleanBlockNode node)
BooleanBigList
clone()
Returns a shallow copy of this list.BooleanBigList
copy()
Returns a shallow copy of this list.private BooleanBigList.BooleanBlockNode
copy(BooleanBigList.BooleanBlockNode node)
Create a copy of the specified node.static BooleanBigList
create()
static BooleanBigList
create(boolean... elems)
Create new list with specified elements.static BooleanBigList
create(java.util.Collection<java.lang.Boolean> coll)
Create new list with specified elements.BooleanBigList
crop()
Returns a copy this list but without elements.protected boolean
doAdd(int index, boolean element)
Helper method for adding an element to the list.protected boolean
doAddAll(int index, IBooleanListable list)
Helper method for adding multiple elements to the list.private void
doAddAllHead(IBooleanListable list, int addPos, int addLen, int space)
private void
doAddAllMiddle(IBooleanListable list, int addPos)
private void
doAddAllTail(IBooleanListable list, int addPos, int addLen, int space)
private void
doAddSplitBooleanBlock(int index, boolean element, int pos, BooleanBigList.BooleanBlock newBooleanBlock)
protected void
doAssign(IBooleanList that)
Assign this list the content of the that list.protected void
doClear()
protected void
doClone(IBooleanList that)
Initialize this object after the bitwise copy has been made by Object.clone().protected IBooleanList
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 boolean
doGet(int index)
Helper method for getting an element from the list.private void
doGetBooleanBlock(int index, int modify)
Determine node/block for the specified index.private boolean
doGetBooleanBlockLeft(int modify, BooleanBigList.BooleanBlockNode nextNode, boolean wasLeft)
private boolean
doGetBooleanBlockRight(int modify, BooleanBigList.BooleanBlockNode nextNode, boolean wasLeft)
private void
doInit(int blockSize, int firstBooleanBlockSize)
Initialize BooleanBigList.protected boolean
doRemove(int index)
Helper method to remove an element.private BooleanBigList.BooleanBlockNode
doRemove(BooleanBigList.BooleanBlockNode node)
protected void
doRemoveAll(int index, int len)
Remove specified range of elements from list.private void
doRemoveAll2(int index, int len, int startPos, BooleanBigList.BooleanBlockNode startNode, BooleanBigList.BooleanBlockNode endNode)
protected boolean
doReSet(int index, boolean elem)
Sets an element at specified position.protected boolean
doSet(int index, boolean elem)
Helper method for setting an element in the list.static BooleanBigList
EMPTY()
protected void
finalize()
private int
getBooleanBlockIndex(int index, boolean write, int modify)
Returns index in block where the element with specified index is located.private int
getBooleanBlockIndex2(int index, boolean write, int modify)
boolean
getDefaultElem()
BooleanBigList
immutableList()
Returns an immutable copy of this list.private boolean
isOnlyRootBooleanBlock()
boolean
isReadOnly()
Returns true if this list is either unmodifiable or immutable, false otherwise.private void
merge(BooleanBigList.BooleanBlockNode node)
Merge the specified node with the left or right neighbor if possible.private void
modify(BooleanBigList.BooleanBlockNode node, int modify)
Modify relativePosition of all nodes starting from the specified node.private void
modifyLeftNode(BooleanBigList.BooleanBlockNode node, int modify)
private void
modifyRightNode(BooleanBigList.BooleanBlockNode node, int modify)
private void
readObject(java.io.ObjectInputStream ois)
Deserialize a BooleanBigList object.private void
releaseBooleanBlock()
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.BooleanBigList
unmodifiableList()
private void
writeObject(java.io.ObjectOutputStream oos)
Serialize a BooleanBigList object.-
Methods inherited from class org.magicwerk.brownies.collections.primitive.IBooleanList
add, add, addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, asIBooleanListable, 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 BooleanBigList 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 BooleanBigList
-
rootNode
private BooleanBigList.BooleanBlockNode rootNode
The root node in the tree
-
currNode
private BooleanBigList.BooleanBlockNode currNode
Current node
-
currBooleanBlockStart
private int currBooleanBlockStart
Start index of current block
-
currBooleanBlockEnd
private int currBooleanBlockEnd
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
-
BooleanBigList
protected BooleanBigList(boolean copy, BooleanBigList that)
Constructor used internally, e.g. for ImmutableBooleanBigList.- Parameters:
copy
- true to copy all instance values from source, if false nothing is donethat
- list to copy
-
BooleanBigList
public BooleanBigList()
Default constructor. The default block size is used.
-
BooleanBigList
public BooleanBigList(int blockSize)
Constructor.- Parameters:
blockSize
- block size
-
BooleanBigList
public BooleanBigList(java.util.Collection<java.lang.Boolean> coll)
Create new list with specified elements.- Parameters:
coll
- collection with element
-
BooleanBigList
private BooleanBigList(int blockSize, int firstBooleanBlockSize)
Internal constructor.- Parameters:
blockSize
- default block sizefirstBooleanBlockSize
- block size of first block
-
-
Method Detail
-
EMPTY
public static BooleanBigList EMPTY()
- Returns:
- unmodifiable empty instance
-
create
public static BooleanBigList create()
-
create
public static BooleanBigList create(java.util.Collection<java.lang.Boolean> coll)
Create new list with specified elements.- Parameters:
coll
- collection with elementtype
- of elements stored in the list- Returns:
- created list
-
create
public static BooleanBigList create(boolean... 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 BooleanBigList.- Returns:
- block size used for this BooleanBigList
-
doInit
private void doInit(int blockSize, int firstBooleanBlockSize)
Initialize BooleanBigList.- Parameters:
blockSize
- default block sizefirstBooleanBlockSize
- block size of first block
-
crop
public BooleanBigList crop()
Description copied from class:IBooleanList
Returns a copy this list but without elements. The new list will have the same type as this list.- Overrides:
crop
in classIBooleanList
- Returns:
- an empty copy of this list
-
isReadOnly
public boolean isReadOnly()
Description copied from class:IBooleanList
Returns true if this list is either unmodifiable or immutable, false otherwise.- Specified by:
isReadOnly
in classIBooleanList
-
copy
public BooleanBigList 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 classIBooleanList
- Returns:
- a modifiable copy of this list
-
clone
public BooleanBigList 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. UseIBooleanList.copy()
to .The copy is realized by a copy-on-write approach so also really large lists can efficiently be handled.
- Overrides:
clone
in classIBooleanList
- Returns:
- a modifiable copy of this list
-
doAssign
protected void doAssign(IBooleanList that)
Description copied from class:IBooleanList
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 classIBooleanList
- Parameters:
that
- list to copy content from
-
doClone
protected void doClone(IBooleanList that)
Description copied from class:IBooleanList
Initialize this object after the bitwise copy has been made by Object.clone().- Specified by:
doClone
in classIBooleanList
- Parameters:
that
- source object
-
copy
private BooleanBigList.BooleanBlockNode copy(BooleanBigList.BooleanBlockNode node)
Create a copy of the specified node.- Parameters:
node
- source node- Returns:
- newly created copy of source
-
getDefaultElem
public boolean getDefaultElem()
- Specified by:
getDefaultElem
in classIBooleanList
-
finalize
protected void finalize()
- Overrides:
finalize
in classjava.lang.Object
-
size
public int size()
- Specified by:
size
in interfaceIBooleanListable
- Specified by:
size
in classIBooleanList
-
capacity
public int capacity()
As BooleanBigList grows and shrinks automatically, the term capacity does not really make sense. Therefore always -1 is returned.- Specified by:
capacity
in classIBooleanList
- Returns:
- capacity of this list
-
doGet
protected boolean doGet(int index)
Description copied from class:IBooleanList
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 classIBooleanList
- Parameters:
index
- index of element to return- Returns:
- the element at the specified position in this list
-
doSet
protected boolean doSet(int index, boolean elem)
Description copied from class:IBooleanList
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 classIBooleanList
- Parameters:
index
- index where element will be placedelem
- element to set- Returns:
- old element which was at the position
-
doReSet
protected boolean doReSet(int index, boolean elem)
Description copied from class:IBooleanList
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 classIBooleanList
- Parameters:
index
- index where element will be placedelem
- element to set- Returns:
- old element which was at the position
-
releaseBooleanBlock
private void releaseBooleanBlock()
Release current block and apply modification if pending.
-
getBooleanBlockIndex
private int getBooleanBlockIndex(int index, boolean write, int modify)
Returns index in block where the element with specified index is located. This method also sets currBooleanBlock 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
-
getBooleanBlockIndex2
private int getBooleanBlockIndex2(int index, boolean write, int modify)
-
isOnlyRootBooleanBlock
private boolean isOnlyRootBooleanBlock()
- Returns:
- true if there is only the root block, false otherwise
-
doGetBooleanBlock
private void doGetBooleanBlock(int index, int modify)
Determine node/block for the specified index. The fields currNode, currBooleanBlockStart, and currBooleanBlockEnd 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)
-
doGetBooleanBlockLeft
private boolean doGetBooleanBlockLeft(int modify, BooleanBigList.BooleanBlockNode nextNode, boolean wasLeft)
-
doGetBooleanBlockRight
private boolean doGetBooleanBlockRight(int modify, BooleanBigList.BooleanBlockNode nextNode, boolean wasLeft)
-
addBooleanBlock
private void addBooleanBlock(int index, BooleanBigList.BooleanBlock 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, boolean element)
Description copied from class:IBooleanList
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 classIBooleanList
- 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
-
doAddSplitBooleanBlock
private void doAddSplitBooleanBlock(int index, boolean element, int pos, BooleanBigList.BooleanBlock newBooleanBlock)
-
modify
private void modify(BooleanBigList.BooleanBlockNode 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(BooleanBigList.BooleanBlockNode node, int modify)
-
modifyRightNode
private void modifyRightNode(BooleanBigList.BooleanBlockNode node, int modify)
-
doRemove
private BooleanBigList.BooleanBlockNode doRemove(BooleanBigList.BooleanBlockNode node)
-
doAddAll
protected boolean doAddAll(int index, IBooleanListable list)
Description copied from class:IBooleanList
Helper method for adding multiple elements to the list. This default implementation calls doAdd() for adding each element.- Overrides:
doAddAll
in classIBooleanList
- 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
-
doAddAllTail
private void doAddAllTail(IBooleanListable list, int addPos, int addLen, int space)
-
doAddAllHead
private void doAddAllHead(IBooleanListable list, int addPos, int addLen, int space)
-
doAddAllMiddle
private void doAddAllMiddle(IBooleanListable list, int addPos)
-
doClear
protected void doClear()
- Overrides:
doClear
in classIBooleanList
-
doRemoveAll
protected void doRemoveAll(int index, int len)
Description copied from class:IBooleanList
Remove specified range of elements from list.- Overrides:
doRemoveAll
in classIBooleanList
- Parameters:
index
- index of first element to removelen
- number of elements to remove
-
doRemoveAll2
private void doRemoveAll2(int index, int len, int startPos, BooleanBigList.BooleanBlockNode startNode, BooleanBigList.BooleanBlockNode endNode)
-
merge
private void merge(BooleanBigList.BooleanBlockNode node)
Merge the specified node with the left or right neighbor if possible.- Parameters:
node
- candidate node for merge
-
doRemove
protected boolean doRemove(int index)
Description copied from class:IBooleanList
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 classIBooleanList
- Parameters:
index
- index of element to remove- Returns:
- removed element
-
unmodifiableList
public BooleanBigList unmodifiableList()
- Specified by:
unmodifiableList
in classIBooleanList
-
immutableList
public BooleanBigList immutableList()
Description copied from class:IBooleanList
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. SeeIBooleanList.unmodifiableList()
to get unmodifiable view of a list.- Specified by:
immutableList
in classIBooleanList
- Returns:
- an immutable copy of the specified list
-
doEnsureCapacity
protected void doEnsureCapacity(int minCapacity)
Description copied from class:IBooleanList
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 classIBooleanList
- 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 classIBooleanList
-
doCreate
protected IBooleanList doCreate(int capacity)
Description copied from class:IBooleanList
Create list with specified capacity.- Specified by:
doCreate
in classIBooleanList
- Parameters:
capacity
- initial capacity (use -1 for default capacity)- Returns:
- created list
-
sort
public void sort(int index, int len)
Description copied from class:IBooleanList
Sort specified elements in the list using the specified comparator.- Specified by:
sort
in classIBooleanList
- Parameters:
index
- index of first element to sortlen
- number of elements to sort- See Also:
Arrays.sort(int[])
-
binarySearch
public int binarySearch(int index, int len, boolean key)
Description copied from class:IBooleanList
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 classIBooleanList
- 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 BooleanBigList 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 BooleanBigList object.- Parameters:
ois
- input stream for serialization- Throws:
java.io.IOException
- if serialization failsjava.lang.ClassNotFoundException
- if serialization fails
-
checkNode
private void checkNode(BooleanBigList.BooleanBlockNode node)
-
checkHeight
private void checkHeight(BooleanBigList.BooleanBlockNode node)
-
check
private void check()
-
-