Class CharBigList
java.lang.Object
org.magicwerk.brownies.collections.primitive.ICharList
org.magicwerk.brownies.collections.primitive.CharBigList
- All Implemented Interfaces:
Serializable
,CharSequence
,Cloneable
,ICharListable
- Direct Known Subclasses:
CharBigList.ReadOnlyCharBigList
CharBigList 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 CharBigList 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 CharBigList is accessed by several threads at different positions.
Note that the iterators provided are not fail-fast.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
A block stores in maximum blockSize number of elements.(package private) static class
Implements an AVLNode storing a CharBlock.protected static class
A read-only version ofinvalid reference
Key1List
Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.primitive.ICharList
ICharList.ICharListableFromArray, ICharList.ICharListableFromCollection, ICharList.ICharListableFromList, ICharList.ICharListableFromMult
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
Number of elements stored at maximum in a blockprivate static final boolean
Set to true for debugging during developingprivate int
End index of current blockprivate int
Start index of current blockprivate int
Modify value which must be applied before this block is not current any moreprivate CharBigList.CharBlockNode
Current nodeprivate static final int
Default block sizeprivate static final CharBigList
Unmodifiable empty instanceprivate static final float
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 final float
If two adjacent blocks both less than MERGE_THRESHOLD*blockSize elements, they are mergedprivate CharBigList.CharBlockNode
The root node in the treeprivate static final long
UID for serializationprivate int
Number of elements stored in this CharBigList -
Constructor Summary
ConstructorsModifierConstructorDescriptionDefault constructor.protected
CharBigList
(boolean copy, CharBigList that) Constructor used internally, e.g.CharBigList
(int blockSize) Constructor.private
CharBigList
(int blockSize, int firstCharBlockSize) Internal constructor.CharBigList
(String str) CharBigList
(Collection<Character> coll) Create new list with specified elements. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addCharBlock
(int index, CharBigList.CharBlock obj) Adds a new element to the list.int
binarySearch
(int index, int len, char key) Searches the specified range for an object using the binary search algorithm.int
Returns block size used for this CharBigList.int
capacity()
As CharBigList grows and shrinks automatically, the term capacity does not really make sense.private void
check()
private void
private void
clone()
Returns a shallow copy of this list.copy()
Returns a shallow copy of this list.private CharBigList.CharBlockNode
Create a copy of the specified node.static CharBigList
create()
static CharBigList
create
(char... elems) Create new list with specified elements.static CharBigList
static CharBigList
create
(Collection<Character> coll) Create new list with specified elements.crop()
Returns a copy this list but without elements.protected boolean
doAdd
(int index, char element) Helper method for adding an element to the list.protected boolean
doAddAll
(int index, ICharListable list) Helper method for adding multiple elements to the list.private void
doAddAllHead
(ICharListable list, int addPos, int addLen, int space) private void
doAddAllMiddle
(ICharListable list, int addPos) private void
doAddAllTail
(ICharListable list, int addPos, int addLen, int space) private void
doAddSplitCharBlock
(int index, char element, int pos, CharBigList.CharBlock newCharBlock) protected void
Assign this list the content of the that list.protected void
doClear()
protected void
Initialize this object after the bitwise copy has been made by Object.clone().protected ICharList
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 char
doGet
(int index) Helper method for getting an element from the list.private void
doGetCharBlock
(int index, int modify) Determine node/block for the specified index.private boolean
doGetCharBlockLeft
(int modify, CharBigList.CharBlockNode nextNode, boolean wasLeft) private boolean
doGetCharBlockRight
(int modify, CharBigList.CharBlockNode nextNode, boolean wasLeft) private void
doInit
(int blockSize, int firstCharBlockSize) Initialize CharBigList.protected char
doRemove
(int index) Helper method to remove an element.private CharBigList.CharBlockNode
protected void
doRemoveAll
(int index, int len) Remove specified range of elements from list.private void
doRemoveAll2
(int index, int len, int startPos, CharBigList.CharBlockNode startNode, CharBigList.CharBlockNode endNode) protected char
doReSet
(int index, char elem) Sets an element at specified position.protected char
doSet
(int index, char elem) Helper method for setting an element in the list.static CharBigList
EMPTY()
protected void
finalize()
private int
getCharBlockIndex
(int index, boolean write, int modify) Returns index in block where the element with specified index is located.private int
getCharBlockIndex2
(int index, boolean write, int modify) char
Returns an immutable copy of this list.void
private boolean
boolean
Returns true if this list is either unmodifiable or immutable, false otherwise.private void
Merge the specified node with the left or right neighbor if possible.private void
modify
(CharBigList.CharBlockNode node, int modify) Modify relativePosition of all nodes starting from the specified node.private void
modifyLeftNode
(CharBigList.CharBlockNode node, int modify) private void
modifyRightNode
(CharBigList.CharBlockNode node, int modify) private void
Deserialize a CharBigList object.private void
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
Pack as many elements in the blocks as allowed.private void
Serialize a CharBigList object.Methods inherited from class org.magicwerk.brownies.collections.primitive.ICharList
add, add, addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, asICharListable, binarySearch, charAt, 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, length, 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, subSequence, swap, toArray, toArray, toArray, toArray, toArray, toArray, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap, transform, transformedList
Methods inherited from interface java.lang.CharSequence
chars, codePoints
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDUID for serialization- See Also:
-
DEFAULT_BLOCK_SIZE
private static final int DEFAULT_BLOCK_SIZEDefault block size- See Also:
-
MERGE_THRESHOLD
private static final float MERGE_THRESHOLDIf two adjacent blocks both less than MERGE_THRESHOLD*blockSize elements, they are merged- See Also:
-
FILL_THRESHOLD
private static final float FILL_THRESHOLDIf 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:
-
CHECK
private static final boolean CHECKSet to true for debugging during developing- See Also:
-
EMPTY
Unmodifiable empty instance -
blockSize
private int blockSizeNumber of elements stored at maximum in a block -
size
private int sizeNumber of elements stored in this CharBigList -
rootNode
The root node in the tree -
currNode
Current node -
currCharBlockStart
private int currCharBlockStartStart index of current block -
currCharBlockEnd
private int currCharBlockEndEnd index of current block -
currModify
private int currModifyModify value which must be applied before this block is not current any more
-
-
Constructor Details
-
CharBigList
Constructor used internally, e.g. for ImmutableCharBigList.- Parameters:
copy
- true to copy all instance values from source, if false nothing is donethat
- list to copy
-
CharBigList
public CharBigList()Default constructor. The default block size is used. -
CharBigList
public CharBigList(int blockSize) Constructor.- Parameters:
blockSize
- block size
-
CharBigList
Create new list with specified elements.- Parameters:
coll
- collection with element
-
CharBigList
private CharBigList(int blockSize, int firstCharBlockSize) Internal constructor.- Parameters:
blockSize
- default block sizefirstCharBlockSize
- block size of first block
-
CharBigList
-
-
Method Details
-
EMPTY
- Returns:
- unmodifiable empty instance
-
create
-
create
Create new list with specified elements.- Parameters:
coll
- collection with elementtype
- of elements stored in the list- Returns:
- created list
-
create
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 CharBigList.- Returns:
- block size used for this CharBigList
-
doInit
private void doInit(int blockSize, int firstCharBlockSize) Initialize CharBigList.- Parameters:
blockSize
- default block sizefirstCharBlockSize
- block size of first block
-
crop
Description copied from class:ICharList
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:ICharList
Returns true if this list is either unmodifiable or immutable, false otherwise.- Specified by:
isReadOnly
in classICharList
-
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
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. UseICharList.copy()
to .The copy is realized by a copy-on-write approach so also really large lists can efficiently be handled.
-
doAssign
Description copied from class:ICharList
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
Description copied from class:ICharList
Initialize this object after the bitwise copy has been made by Object.clone(). -
copy
Create a copy of the specified node.- Parameters:
node
- source node- Returns:
- newly created copy of source
-
getDefaultElem
public char getDefaultElem()- Specified by:
getDefaultElem
in classICharList
-
finalize
protected void finalize() -
size
public int size()- Specified by:
size
in interfaceICharListable
- Specified by:
size
in classICharList
-
capacity
public int capacity()As CharBigList grows and shrinks automatically, the term capacity does not really make sense. Therefore always -1 is returned. -
doGet
protected char doGet(int index) Description copied from class:ICharList
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 char doSet(int index, char elem) Description copied from class:ICharList
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 char doReSet(int index, char elem) Description copied from class:ICharList
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. -
releaseCharBlock
private void releaseCharBlock()Release current block and apply modification if pending. -
getCharBlockIndex
private int getCharBlockIndex(int index, boolean write, int modify) Returns index in block where the element with specified index is located. This method also sets currCharBlock to remember this last used block.- Parameters:
index
- list index (0 invalid input: '<'= index invalid input: '<'= size())write
- true if the block is needed for a write operation (set, add, remove)modify
- modify instruction (N>0: N elements are added, Ninvalid input: '<'0: N elements are removed, 0 no change)- Returns:
- relative index within block
-
getCharBlockIndex2
private int getCharBlockIndex2(int index, boolean write, int modify) -
isOnlyRootCharBlock
private boolean isOnlyRootCharBlock()- Returns:
- true if there is only the root block, false otherwise
-
doGetCharBlock
private void doGetCharBlock(int index, int modify) Determine node/block for the specified index. The fields currNode, currCharBlockStart, and currCharBlockEnd 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, Ninvalid input: '<'0: N elements are removed, 0 no change)
-
doGetCharBlockLeft
-
doGetCharBlockRight
private boolean doGetCharBlockRight(int modify, CharBigList.CharBlockNode nextNode, boolean wasLeft) -
addCharBlock
Adds a new element to the list.- Parameters:
index
- the index to add beforeobj
- the element to add
-
doAdd
protected boolean doAdd(int index, char element) Description copied from class:ICharList
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. -
doAddSplitCharBlock
private void doAddSplitCharBlock(int index, char element, int pos, CharBigList.CharBlock newCharBlock) -
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, invalid input: '<'0 for delete)
-
modifyLeftNode
-
modifyRightNode
-
doRemove
-
doAddAll
Description copied from class:ICharList
Helper method for adding multiple elements to the list. This default implementation calls doAdd() for adding each element. -
doAddAllTail
-
doAddAllHead
-
doAddAllMiddle
-
doClear
protected void doClear() -
doRemoveAll
protected void doRemoveAll(int index, int len) Description copied from class:ICharList
Remove specified range of elements from list.- Overrides:
doRemoveAll
in classICharList
- Parameters:
index
- index of first element to removelen
- number of elements to remove
-
doRemoveAll2
private void doRemoveAll2(int index, int len, int startPos, CharBigList.CharBlockNode startNode, CharBigList.CharBlockNode endNode) -
merge
Merge the specified node with the left or right neighbor if possible.- Parameters:
node
- candidate node for merge
-
doRemove
protected char doRemove(int index) Description copied from class:ICharList
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
- Specified by:
unmodifiableList
in classICharList
-
immutableList
Description copied from class:ICharList
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. SeeICharList.unmodifiableList()
to get unmodifiable view of a list.- Specified by:
immutableList
in classICharList
- Returns:
- an immutable copy of the specified list
-
doEnsureCapacity
protected void doEnsureCapacity(int minCapacity) Description copied from class:ICharList
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 classICharList
- 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 classICharList
-
doCreate
Description copied from class:ICharList
Create list with specified capacity. -
sort
public void sort(int index, int len) Description copied from class:ICharList
Sort specified elements in the list using the specified comparator. -
binarySearch
public int binarySearch(int index, int len, char key) Description copied from class:ICharList
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 classICharList
- 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:
-
writeObject
Serialize a CharBigList object.- Parameters:
oos
- output stream for serialization- Throws:
IOException
- if serialization fails
-
readObject
Deserialize a CharBigList object.- Parameters:
ois
- input stream for serialization- Throws:
IOException
- if serialization failsClassNotFoundException
- if serialization fails
-
checkNode
-
checkHeight
-
check
private void check() -
create
-
init
-