Class ByteGapList
- java.lang.Object
-
- org.magicwerk.brownies.collections.primitive.IByteList
-
- org.magicwerk.brownies.collections.primitive.ByteGapList
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,IByteListable
- Direct Known Subclasses:
ByteBigList.ByteBlock
,ByteGapList.ReadOnlyList
public class ByteGapList extends IByteList
Class {link ByteGapList} combines the strengths of bothArrayList
andLinkedList
. It is implemented to offer both efficient random access to elements by index (as ArrayList does) and at the same time efficient adding and removing elements to and from beginning and end (as LinkedList does). It also exploits the locality of reference often seen in applications to further improve performance, e.g. for iterating over the list.The class can be used as drop-in replacement for ArrayList. It is also source compatible to LinkedList/Deque as it implements all needed methods. It cannot implement
Deque
however, use#asDeque
to get a view implementing it.Note that this implementation is not synchronized.
Note that the iterators provided are not fail-fast.
- See Also:
List
,ArrayList
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
ByteGapList.ReadOnlyList
A read-only version ofByteGapList
.-
Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.primitive.IByteList
IByteList.IByteListableFromArray, IByteList.IByteListableFromCollection, IByteList.IByteListableFromList, IByteList.IByteListableFromMult
-
-
Field Summary
Fields Modifier and Type Field Description private static boolean
DEBUG_CHECK
If true the invariants the ByteGapList are checked for debuggingprivate static boolean
DEBUG_DUMP
If true the internal state of the ByteGapList is traced out for debuggingprivate static boolean
DEBUG_TRACE
If true the calls to some methods are traced out for debuggingstatic int
DEFAULT_CAPACITY
Default capacity for listprivate static ByteGapList
EMPTY
Unmodifiable empty instanceprivate static byte[]
EMPTY_VALUES
Empty array used for default initializationprivate int
end
Physical position after last elementprivate boolean
gapAddRight
If false (default) an element is added on the left side of the gap (favorable for adding after an insertion point, e.g.private int
gapIndex
Logical index of first element after gap (ignored if gapSize=0)private int
gapSize
Size of gap (0 if there is no gap)private int
gapStart
Physical position of first slot in gap (ignored if gapSize=0)private static long
serialVersionUID
UID for serializationprivate int
size
Number of elements stored in this ByteGapListprivate int
start
Physical position of first elementprivate byte[]
values
Array holding raw data
-
Constructor Summary
Constructors Modifier Constructor Description ByteGapList()
Construct a list with the default initial capacity.protected
ByteGapList(boolean copy, ByteGapList that)
Constructor used internally, e.g.ByteGapList(int capacity)
Construct a list with specified initial capacity.ByteGapList(java.util.Collection<java.lang.Byte> coll)
Construct a list to contain the specified elements.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(byte elem)
void
add(int index, byte elem)
Inserts the specified element at the specified position in this list.int
binarySearch(int index, int len, byte key)
Searches the specified range for an object using the binary search algorithm.(package private) int
calculateNewCapacity(int minCapacity)
Calculate new capacity.int
capacity()
Returns capacity of this list.ByteGapList
clone()
Returns a shallow copy of this list.ByteGapList
copy()
Returns a shallow copy of this list.static ByteGapList
create()
static ByteGapList
create(byte... elems)
Create new list with specified elements.static ByteGapList
create(java.util.Collection<java.lang.Byte> coll)
Create new list with specified elements.ByteGapList
crop()
Returns a copy this list but without elements.private void
debugCheck()
Private method to check invariant of ByteGapList.private void
debugDump()
Private method to dump fields of ByteGapList.private void
debugLog(java.lang.String msg)
Private method write logging output.private java.lang.String
debugPrint(byte[] values)
Print array values into string.private int
debugState()
Private method to determine state of ByteGapList.protected boolean
doAdd(int index, byte elem)
Helper method for adding an element to the list.private int
doAddCreateNewGap(int index, int physIdx)
private int
doAddCreateNewGap2(int index, int physIdx)
private int
doAddMoveExistingGap(int index, int physIdx)
private int
doAddMoveExistingGap2(int index, int physIdx, int gapEnd, boolean moveLeft)
protected void
doAssign(IByteList that)
Assign this list the content of the that list.protected void
doClear()
protected void
doClone(IByteList that)
Initialize this object after the bitwise copy has been made by Object.clone().ByteGapList
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 byte
doGet(int index)
Helper method for getting an element from the list.protected void
doGetAll(byte[] array, int index, int len)
Helper method to fill the specified elements in an array.private int[]
doPhysIndex(int pidx0, int pidx1)
private int[]
doPhysIndex2(int pidx0, int pidx1)
protected byte
doRemove(int index)
Helper method to remove an element.protected void
doRemoveAll(int index, int len)
Remove specified range of elements from list.protected boolean
doRemoveAllFast(int index, int len)
Remove specified range of elements from list as specialized fast operation.private void
doRemoveMiddle(int index, int physIdx)
private void
doRemoveMoveExistingGap(int index, int physIdx)
protected byte
doReSet(int index, byte elem)
Sets an element at specified position.protected byte
doSet(int index, byte elem)
Helper method for setting an element in the list.static ByteGapList
EMPTY()
(package private) void
ensureNormalized(int minCapacity)
Normalize data of ByteGapList so the elements are found from values[0] to values[size-1].byte
get(int index)
ByteGapList
getAll(byte elem)
Returns all elements in the list equal to the specified element.ByteGapList
getAll(int index, int len)
Returns specified range of elements from list.byte
getDefaultElem()
static ByteGapList
immutable(byte... elems)
Create new immutable list with specified elements.static ByteGapList
immutable(java.util.Collection<java.lang.Byte> coll)
Create new immutable list with specified elements.ByteGapList
immutableList()
Returns an immutable copy of this list.(package private) void
init()
Initialize the list to be empty.(package private) void
init(byte... elems)
Initialize the list to contain the specified elements only.(package private) void
init(byte[] values, int size)
Initialize all instance fields.(package private) void
init(java.util.Collection<java.lang.Byte> coll)
Initialize the list to contain the specified elements only.(package private) boolean
isNormalized()
Checks whether elements are stored normalized, i.e.boolean
isReadOnly()
Returns true if this list is either unmodifiable or immutable, false otherwise.<R> GapList<R>
map(java.util.function.Function<java.lang.Byte,R> mapper)
private void
moveData(int src, int dst, int len)
Move a range of elements in the values array.private void
moveDataWithGap(int src, int dst, int len)
Move a range of elements in the values array and adjust the gap.private int
physIndex(int idx)
Calculate index for physical access to an element.private int[]
physIndex(int idx0, int idx1)
Calculate indexes for physical access to a range of elements.(package private) byte[]
prepareAddBuffer(int index, int len)
Prepare direct access to an array buffer for fast adding elements to the list.private void
readObject(java.io.ObjectInputStream ois)
Deserialize a ByteGapList object.(package private) void
releaseAddBuffer(int index, int len)
Releases the buffer retrieved byprepareAddBuffer(int, int)
.byte
remove(int index)
int
size()
void
sort(int index, int len)
Sort specified elements in the list using the specified comparator.void
trimToSize()
Trims the capacity of this ByteGapList instance to be the list's current size.ByteGapList
unmodifiableList()
private void
writeObject(java.io.ObjectOutputStream oos)
Serialize a ByteGapList object.-
Methods inherited from class org.magicwerk.brownies.collections.primitive.IByteList
addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, asIByteListable, binarySearch, checkIndex, checkIndexAdd, checkLength, checkLengths, checkNonNull, checkRange, clear, contains, containsAll, containsAny, containsIf, copy, count, countIf, doAddAll, doCreateArray, doIndexOf, doIndexOfIf, doInitAll, doLastIndexOf, doLastIndexOfIf, doModify, doPutAll, doReplace, doRotate, doTransfer, doTransferSwap, drag, element, ensureCapacity, equals, equalsElem, extract, extractIf, fill, filter, filterMap, flatMap, getDistinct, getFirst, getFirstOrNull, getIf, getLast, getLastOrNull, getSingle, getSingleOrNull, hashCode, hashCodeElem, indexOf, indexOf, indexOfIf, indexOfIf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, lastIndexOfIf, lastIndexOfIf, mapFilter, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, 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
-
DEBUG_CHECK
private static final boolean DEBUG_CHECK
If true the invariants the ByteGapList are checked for debugging- See Also:
- Constant Field Values
-
DEBUG_TRACE
private static final boolean DEBUG_TRACE
If true the calls to some methods are traced out for debugging- See Also:
- Constant Field Values
-
DEBUG_DUMP
private static final boolean DEBUG_DUMP
If true the internal state of the ByteGapList is traced out for debugging- See Also:
- Constant Field Values
-
EMPTY_VALUES
private static byte[] EMPTY_VALUES
Empty array used for default initialization
-
EMPTY
private static final ByteGapList EMPTY
Unmodifiable empty instance
-
serialVersionUID
private static final long serialVersionUID
UID for serialization- See Also:
- Constant Field Values
-
DEFAULT_CAPACITY
public static final int DEFAULT_CAPACITY
Default capacity for list- See Also:
- Constant Field Values
-
values
private byte[] values
Array holding raw data
-
size
private int size
Number of elements stored in this ByteGapList
-
start
private int start
Physical position of first element
-
end
private int end
Physical position after last element
-
gapSize
private int gapSize
Size of gap (0 if there is no gap)
-
gapIndex
private int gapIndex
Logical index of first element after gap (ignored if gapSize=0)
-
gapStart
private int gapStart
Physical position of first slot in gap (ignored if gapSize=0)
-
gapAddRight
private boolean gapAddRight
If false (default) an element is added on the left side of the gap (favorable for adding after an insertion point, e.g. indexes 5, 6, 7), if true the element is added on the right side of the gap (favorable for adding before an insertion point, e.g. indexes 5, 5, 5)
-
-
Constructor Detail
-
ByteGapList
protected ByteGapList(boolean copy, ByteGapList that)
Constructor used internally, e.g. for ImmutableByteGapList.- Parameters:
copy
- true to copy all instance values from source, if false nothing is donethat
- list to copy
-
ByteGapList
public ByteGapList()
Construct a list with the default initial capacity.
-
ByteGapList
public ByteGapList(int capacity)
Construct a list with specified initial capacity.- Parameters:
capacity
- capacity
-
ByteGapList
public ByteGapList(java.util.Collection<java.lang.Byte> coll)
Construct a list to contain the specified elements. The list will have an initial capacity to hold these elements.- Parameters:
coll
- collection with elements
-
-
Method Detail
-
EMPTY
public static ByteGapList EMPTY()
- Returns:
- unmodifiable empty instance
-
create
public static ByteGapList create()
-
create
public static ByteGapList create(java.util.Collection<java.lang.Byte> coll)
Create new list with specified elements.- Parameters:
coll
- collection with elementstype
- of elements stored in the list- Returns:
- created list
-
create
@SafeVarargs public static ByteGapList create(byte... elems)
Create new list with specified elements.- Parameters:
elems
- array with elementstype
- of elements stored in the list- Returns:
- created list
-
immutable
public static ByteGapList immutable(java.util.Collection<java.lang.Byte> coll)
Create new immutable list with specified elements. To reduce the needed memory, the list's capacity will be equal to its size.- Parameters:
coll
- collection with elementstype
- of elements stored in the list- Returns:
- created list
-
immutable
@SafeVarargs public static ByteGapList immutable(byte... elems)
Create new immutable list with specified elements. To reduce the needed memory, the list's capacity will be equal to its size.- Parameters:
elems
- array with elementstype
- of elements stored in the list- Returns:
- created list
-
physIndex
private final int physIndex(int idx)
Calculate index for physical access to an element.- Parameters:
idx
- logical index of element- Returns:
- physical index to access element in values[]
-
physIndex
private int[] physIndex(int idx0, int idx1)
Calculate indexes for physical access to a range of elements. The method returns between one and three ranges of physical indexes.- Parameters:
idx0
- start indexidx1
- end index- Returns:
- array with physical start and end indexes (may contain 0, 2, 4, or 6 elements)
-
doPhysIndex
private int[] doPhysIndex(int pidx0, int pidx1)
-
doPhysIndex2
private int[] doPhysIndex2(int pidx0, int pidx1)
-
doAssign
protected void doAssign(IByteList that)
Description copied from class:IByteList
Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.
-
init
void init()
Initialize the list to be empty. The list will have the default initial capacity.
-
init
void init(java.util.Collection<java.lang.Byte> coll)
Initialize the list to contain the specified elements only. The list will have an initial capacity to hold these elements.- Parameters:
coll
- collection with elements
-
init
void init(byte... elems)
Initialize the list to contain the specified elements only. The list will have an initial capacity to hold these elements.- Parameters:
elems
- array with elements
-
getDefaultElem
public byte getDefaultElem()
- Specified by:
getDefaultElem
in classIByteList
-
crop
public ByteGapList crop()
Description copied from class:IByteList
Returns a copy this list but without elements. The new list will have the same type as this list.
-
copy
public ByteGapList copy()
Description copied from class:IByteList
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.
-
clone
public ByteGapList clone()
Description copied from class:IByteList
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. UseIByteList.copy()
to .
-
isReadOnly
public boolean isReadOnly()
Description copied from class:IByteList
Returns true if this list is either unmodifiable or immutable, false otherwise.- Specified by:
isReadOnly
in classIByteList
-
unmodifiableList
public ByteGapList unmodifiableList()
- Specified by:
unmodifiableList
in classIByteList
-
immutableList
public ByteGapList immutableList()
Description copied from class:IByteList
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. SeeIByteList.unmodifiableList()
to get unmodifiable view of a list.- Specified by:
immutableList
in classIByteList
- Returns:
- an immutable copy of the specified list
-
doClone
protected void doClone(IByteList that)
Description copied from class:IByteList
Initialize this object after the bitwise copy has been made by Object.clone().
-
ensureNormalized
void ensureNormalized(int minCapacity)
Normalize data of ByteGapList so the elements are found from values[0] to values[size-1]. This method can help to speed up operations like sort or binarySearch.
-
isNormalized
boolean isNormalized()
Checks whether elements are stored normalized, i.e. start is at position 0 and there is no gap.
-
init
void init(byte[] values, int size)
Initialize all instance fields.- Parameters:
values
- new values arraysize
- new size
-
size
public int size()
- Specified by:
size
in interfaceIByteListable
- Specified by:
size
in classIByteList
-
capacity
public int capacity()
Description copied from class:IByteList
Returns capacity of this list. Note that two lists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.
-
get
public byte get(int index)
- Specified by:
get
in interfaceIByteListable
- Overrides:
get
in classIByteList
-
doGet
protected byte doGet(int index)
Description copied from class:IByteList
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 byte doSet(int index, byte elem)
Description copied from class:IByteList
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 byte doReSet(int index, byte elem)
Description copied from class:IByteList
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.
-
add
public void add(int index, byte elem)
Description copied from class:IByteList
Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
-
getAll
public ByteGapList getAll(int index, int len)
Description copied from class:IByteList
Returns specified range of elements from list.
-
getAll
public ByteGapList getAll(byte elem)
Description copied from class:IByteList
Returns all elements in the list equal to the specified element.
-
map
public <R> GapList<R> map(java.util.function.Function<java.lang.Byte,R> mapper)
-
prepareAddBuffer
byte[] prepareAddBuffer(int index, int len)
Prepare direct access to an array buffer for fast adding elements to the list. The size of the list will be increased by len being index+len after the call. The added elements will be initialized to their default value. If not all elements prepared are used, callreleaseAddBuffer(int, int)
to release them.Example:
int index = list.size() int len = 1000; byte[] values = list.getAddBuffer(index, len) int read = inputstream.read(values, index, len) list.releaseAddBuffer(index, read)
- Parameters:
index
- index of first buffer position (must be equal to the size of the list)len
- number of elements which the buffer can held- Returns:
- array holding the elements of the list
-
releaseAddBuffer
void releaseAddBuffer(int index, int len)
Releases the buffer retrieved byprepareAddBuffer(int, int)
. The size of the list will be index+len after the call.- Parameters:
index
- index of first buffer position as passed toprepareAddBuffer(int, int)
len
- number of elements used in the buffer
-
doAdd
protected boolean doAdd(int index, byte elem)
Description copied from class:IByteList
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.
-
doAddCreateNewGap
private int doAddCreateNewGap(int index, int physIdx)
-
doAddCreateNewGap2
private int doAddCreateNewGap2(int index, int physIdx)
-
doAddMoveExistingGap
private int doAddMoveExistingGap(int index, int physIdx)
-
doAddMoveExistingGap2
private int doAddMoveExistingGap2(int index, int physIdx, int gapEnd, boolean moveLeft)
-
moveDataWithGap
private void moveDataWithGap(int src, int dst, int len)
Move a range of elements in the values array and adjust the gap. The elements are first copied and the source range is then filled with null.- Parameters:
src
- start index of source rangedst
- start index of destination rangelen
- number of elements to move
-
moveData
private void moveData(int src, int dst, int len)
Move a range of elements in the values array. The elements are first copied and the source range is then filled with null.- Parameters:
src
- start index of source rangedst
- start index of destination rangelen
- number of elements to move
-
doRemove
protected byte doRemove(int index)
Description copied from class:IByteList
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.
-
doRemoveMiddle
private void doRemoveMiddle(int index, int physIdx)
-
doRemoveMoveExistingGap
private void doRemoveMoveExistingGap(int index, int physIdx)
-
doEnsureCapacity
protected void doEnsureCapacity(int minCapacity)
Description copied from class:IByteList
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 classIByteList
- Parameters:
minCapacity
- the desired minimum capacity
-
calculateNewCapacity
int calculateNewCapacity(int minCapacity)
Calculate new capacity. The capacity will not shrink, so the returned capacity can be equal to values.length.- Parameters:
minCapacity
- the desired minimum capacity- Returns:
- the new capacity to use
-
trimToSize
public void trimToSize()
Trims the capacity of this ByteGapList instance to be the list's current size. An application can use this operation to minimize the storage of an instance.- Specified by:
trimToSize
in classIByteList
-
doGetAll
protected void doGetAll(byte[] array, int index, int len)
Description copied from class:IByteList
Helper method to fill the specified elements in an array.
-
writeObject
private void writeObject(java.io.ObjectOutputStream oos) throws java.io.IOException
Serialize a ByteGapList 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 ByteGapList object.- Parameters:
ois
- input stream for serialization- Throws:
java.io.IOException
- if serialization failsjava.lang.ClassNotFoundException
- if serialization fails
-
doCreate
public ByteGapList doCreate(int capacity)
Description copied from class:IByteList
Create list with specified capacity.
-
doRemoveAll
protected void doRemoveAll(int index, int len)
Description copied from class:IByteList
Remove specified range of elements from list.- Overrides:
doRemoveAll
in classIByteList
- Parameters:
index
- index of first element to removelen
- number of elements to remove
-
doRemoveAllFast
protected boolean doRemoveAllFast(int index, int len)
Remove specified range of elements from list as specialized fast operation.- Parameters:
index
- index of first element to removelen
- number of elements to remove- Returns:
- true if removal could be done, false otherwise
-
sort
public void sort(int index, int len)
Description copied from class:IByteList
Sort specified elements in the list using the specified comparator.
-
binarySearch
public int binarySearch(int index, int len, byte key)
Description copied from class:IByteList
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 classIByteList
- 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)
-
debugCheck
private void debugCheck()
Private method to check invariant of ByteGapList. It is only used for debugging.
-
debugState
private int debugState()
Private method to determine state of ByteGapList. It is only used for debugging.- Returns:
- state in which ByteGapList is
-
debugDump
private void debugDump()
Private method to dump fields of ByteGapList. It is only called if the code is run in development mode.
-
debugPrint
private java.lang.String debugPrint(byte[] values)
Print array values into string.- Parameters:
values
- array with values- Returns:
- string representing array values
-
debugLog
private void debugLog(java.lang.String msg)
Private method write logging output. It is only used for debugging.- Parameters:
msg
- message to write out
-
-