Package com.carrotsearch.hppc
Class ByteArrayList
- java.lang.Object
-
- com.carrotsearch.hppc.ByteArrayList
-
- All Implemented Interfaces:
ByteCollection
,ByteContainer
,ByteIndexedContainer
,Preallocable
,java.lang.Cloneable
,java.lang.Iterable<ByteCursor>
,java.util.RandomAccess
- Direct Known Subclasses:
ByteStack
@Generated(date="2021-05-28T03:45:41+0000", value="KTypeArrayList.java") public class ByteArrayList extends java.lang.Object implements ByteIndexedContainer, Preallocable, java.lang.Cloneable
An array-backed list of bytes.
-
-
Field Summary
Fields Modifier and Type Field Description byte[]
buffer
Internal array for storing the list.int
elementsCount
Current number of elements stored inbuffer
.static byte[]
EMPTY_ARRAY
An immutable empty buffer (array).protected ArraySizingStrategy
resizer
Buffer resizing strategy.
-
Constructor Summary
Constructors Constructor Description ByteArrayList()
New instance with sane defaults.ByteArrayList(int expectedElements)
New instance with sane defaults.ByteArrayList(int expectedElements, ArraySizingStrategy resizer)
New instance with sane defaults.ByteArrayList(ByteContainer container)
Creates a new list from the elements of another container in its iteration order.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(byte e1)
Adds an element to the end of this container (the last index is incremented by one).void
add(byte... elements)
Vararg-signature method for adding elements at the end of the list.void
add(byte[] elements, int start, int length)
Add all elements from a range of given array to the list.void
add(byte e1, byte e2)
Appends two elements at the end of the list.int
addAll(ByteContainer container)
Adds all elements from another container.int
addAll(java.lang.Iterable<? extends ByteCursor> iterable)
Adds all elements from another iterable.void
clear()
Sets the number of stored elements to zero.ByteArrayList
clone()
Clone this object.boolean
contains(byte e1)
Lookup a given element in the container.protected void
ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to storeexpectedAdditions
.void
ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of elements without resizing its buffers.protected boolean
equalElements(ByteArrayList other)
Compare index-aligned elements against anotherByteIndexedContainer
.boolean
equals(java.lang.Object obj)
Returnstrue
only if the other object is an instance of the same class and with the same elements.<T extends ByteProcedure>
TforEach(T procedure)
Applies aprocedure
to all container elements.<T extends ByteProcedure>
TforEach(T procedure, int fromIndex, int toIndex)
Appliesprocedure
to a slice of the list,fromIndex
, inclusive, totoIndex
, exclusive.static ByteArrayList
from(byte... elements)
Create a list from a variable number of arguments or an array ofbyte
.byte
get(int index)
int
hashCode()
int
indexOf(byte e1)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.void
insert(int index, byte e1)
Inserts the specified element at the specified position in this list.boolean
isEmpty()
Shortcut forsize() == 0
.java.util.Iterator<ByteCursor>
iterator()
Returns an iterator to a cursor traversing the collection.int
lastIndexOf(byte e1)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.void
release()
Sets the number of stored elements to zero and releases the internal storage array.byte
remove(int index)
Removes the element at the specified position in this container and returns it.int
removeAll(byte e1)
Removes all occurrences ofe
from this collection.int
removeAll(ByteLookupContainer c)
Default implementation uses a predicate for removal.int
removeAll(BytePredicate predicate)
Removes all elements in this collection for which the given predicate returnstrue
.int
removeFirst(byte e1)
Removes the first element that equalse1
, returning its deleted position or-1
if the element was not found.int
removeLast(byte e1)
Removes the last element that equalse1
, returning its deleted position or-1
if the element was not found.void
removeRange(int fromIndex, int toIndex)
Removes from this container all of the elements with indexes betweenfromIndex
, inclusive, andtoIndex
, exclusive.void
resize(int newSize)
Truncate or expand the list to the new size.int
retainAll(ByteLookupContainer c)
Default implementation uses a predicate for retaining.int
retainAll(BytePredicate predicate)
Default implementation redirects toByteCollection.removeAll(BytePredicate)
and negates the predicate.byte
set(int index, byte e1)
Replaces the element at the specified position in this list with the specified element.int
size()
Return the current number of elements in this container.byte[]
toArray()
Default implementation of copying to an array.java.lang.String
toString()
Convert the contents of this container to a human-friendly string.void
trimToSize()
Trim the internal buffer to the current size.-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.carrotsearch.hppc.ByteCollection
removeAll, retainAll, retainAll
-
-
-
-
Field Detail
-
EMPTY_ARRAY
public static final byte[] EMPTY_ARRAY
An immutable empty buffer (array).
-
buffer
public byte[] buffer
Internal array for storing the list. The array may be larger than the current size (size()
).
-
elementsCount
public int elementsCount
Current number of elements stored inbuffer
.
-
resizer
protected final ArraySizingStrategy resizer
Buffer resizing strategy.
-
-
Constructor Detail
-
ByteArrayList
public ByteArrayList()
New instance with sane defaults.
-
ByteArrayList
public ByteArrayList(int expectedElements)
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
ByteArrayList
public ByteArrayList(int expectedElements, ArraySizingStrategy resizer)
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).resizer
- Underlying buffer sizing strategy.
-
ByteArrayList
public ByteArrayList(ByteContainer container)
Creates a new list from the elements of another container in its iteration order.
-
-
Method Detail
-
add
public void add(byte e1)
Adds an element to the end of this container (the last index is incremented by one).- Specified by:
add
in interfaceByteIndexedContainer
-
add
public void add(byte e1, byte e2)
Appends two elements at the end of the list. To add more than two elements, useadd
(vararg-version) or access the buffer directly (tight loop).
-
add
public void add(byte[] elements, int start, int length)
Add all elements from a range of given array to the list.
-
add
public final void add(byte... elements)
Vararg-signature method for adding elements at the end of the list.This method is handy, but costly if used in tight loops (anonymous array passing)
-
addAll
public int addAll(ByteContainer container)
Adds all elements from another container.
-
addAll
public int addAll(java.lang.Iterable<? extends ByteCursor> iterable)
Adds all elements from another iterable.
-
insert
public void insert(int index, byte e1)
Inserts the specified element at the specified position in this list.- Specified by:
insert
in interfaceByteIndexedContainer
- Parameters:
index
- The index at which the element should be inserted, shifting any existing and subsequent elements to the right.
-
get
public byte get(int index)
- Specified by:
get
in interfaceByteIndexedContainer
- Returns:
- Returns the element at index
index
from the list.
-
set
public byte set(int index, byte e1)
Replaces the element at the specified position in this list with the specified element.- Specified by:
set
in interfaceByteIndexedContainer
- Returns:
- Returns the previous value in the list.
-
remove
public byte remove(int index)
Removes the element at the specified position in this container and returns it.- Specified by:
remove
in interfaceByteIndexedContainer
- See Also:
ByteIndexedContainer.removeFirst(byte)
,ByteIndexedContainer.removeLast(byte)
,ByteCollection.removeAll(byte)
-
removeRange
public void removeRange(int fromIndex, int toIndex)
Removes from this container all of the elements with indexes betweenfromIndex
, inclusive, andtoIndex
, exclusive.- Specified by:
removeRange
in interfaceByteIndexedContainer
-
removeFirst
public int removeFirst(byte e1)
Removes the first element that equalse1
, returning its deleted position or-1
if the element was not found.- Specified by:
removeFirst
in interfaceByteIndexedContainer
-
removeLast
public int removeLast(byte e1)
Removes the last element that equalse1
, returning its deleted position or-1
if the element was not found.- Specified by:
removeLast
in interfaceByteIndexedContainer
-
removeAll
public int removeAll(byte e1)
Removes all occurrences ofe
from this collection.- Specified by:
removeAll
in interfaceByteCollection
- Parameters:
e1
- Element to be removed from this collection, if present.- Returns:
- The number of removed elements as a result of this call.
-
contains
public boolean contains(byte e1)
Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).- Specified by:
contains
in interfaceByteContainer
- Returns:
- Returns
true
if this container has an element equal toe
.
-
indexOf
public int indexOf(byte e1)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
indexOf
in interfaceByteIndexedContainer
-
lastIndexOf
public int lastIndexOf(byte e1)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
lastIndexOf
in interfaceByteIndexedContainer
-
isEmpty
public boolean isEmpty()
Shortcut forsize() == 0
.- Specified by:
isEmpty
in interfaceByteContainer
-
ensureCapacity
public void ensureCapacity(int expectedElements)
Ensure this container can hold at least the given number of elements without resizing its buffers.- Specified by:
ensureCapacity
in interfacePreallocable
- Parameters:
expectedElements
- The total number of elements, inclusive.
-
ensureBufferSpace
protected void ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to storeexpectedAdditions
. Increases internal buffer size if needed.
-
resize
public void resize(int newSize)
Truncate or expand the list to the new size. If the list is truncated, the buffer will not be reallocated (usetrimToSize()
if you need a truncated buffer), but the truncated values will be reset to the default value (zero). If the list is expanded, the elements beyond the current size are initialized with JVM-defaults (zero ornull
values).
-
size
public int size()
Return the current number of elements in this container. The time for calculating the container's size may takeO(n)
time, although implementing classes should try to maintain the current size and return in constant time.- Specified by:
size
in interfaceByteContainer
-
trimToSize
public void trimToSize()
Trim the internal buffer to the current size.
-
clear
public void clear()
Sets the number of stored elements to zero. Releases and initializes the internal storage array to default values. To clear the list without cleaning the buffer, simply set theelementsCount
field to zero.- Specified by:
clear
in interfaceByteCollection
- See Also:
ByteCollection.release()
-
release
public void release()
Sets the number of stored elements to zero and releases the internal storage array.- Specified by:
release
in interfaceByteCollection
- See Also:
ByteCollection.clear()
-
toArray
public byte[] toArray()
Default implementation of copying to an array.The returned array is sized to match exactly the number of elements of the stack.
- Specified by:
toArray
in interfaceByteContainer
-
clone
public ByteArrayList clone()
Clone this object. The returned clone will reuse the same hash function and array resizing strategy.- Overrides:
clone
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
Returnstrue
only if the other object is an instance of the same class and with the same elements.- Overrides:
equals
in classjava.lang.Object
-
equalElements
protected boolean equalElements(ByteArrayList other)
Compare index-aligned elements against anotherByteIndexedContainer
.
-
iterator
public java.util.Iterator<ByteCursor> iterator()
Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.The iterator is implemented as a cursor and it returns the same cursor instance on every call to
Iterator.next()
(to avoid boxing of primitive types). To read the current list's value (or index in the list) use the cursor's public fields. An example is shown below.for (ByteCursor<byte> c : container) { System.out.println("index=" + c.index + " value=" + c.value); }
- Specified by:
iterator
in interfaceByteContainer
- Specified by:
iterator
in interfacejava.lang.Iterable<ByteCursor>
-
forEach
public <T extends ByteProcedure> T forEach(T procedure)
Applies aprocedure
to all container elements. Returns the argument (any subclass ofByteProcedure
. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer):int count = container.forEach(new IntProcedure() { int count; // this is a field declaration in an anonymous class. public void apply(int value) { count++; } }).count;
- Specified by:
forEach
in interfaceByteContainer
-
forEach
public <T extends ByteProcedure> T forEach(T procedure, int fromIndex, int toIndex)
Appliesprocedure
to a slice of the list,fromIndex
, inclusive, totoIndex
, exclusive.
-
removeAll
public int removeAll(BytePredicate predicate)
Removes all elements in this collection for which the given predicate returnstrue
.- Specified by:
removeAll
in interfaceByteCollection
- Returns:
- Returns the number of removed elements.
-
forEach
public <T extends BytePredicate> T forEach(T predicate)
Applies apredicate
to container elements as long, as the predicate returnstrue
. The iteration is interrupted otherwise.- Specified by:
forEach
in interfaceByteContainer
-
forEach
public <T extends BytePredicate> T forEach(T predicate, int fromIndex, int toIndex)
Appliespredicate
to a slice of the list,fromIndex
, inclusive, totoIndex
, exclusive, or until predicate returnsfalse
.
-
from
public static ByteArrayList from(byte... elements)
Create a list from a variable number of arguments or an array ofbyte
. The elements are copied from the argument to the internal buffer.
-
removeAll
public int removeAll(ByteLookupContainer c)
Default implementation uses a predicate for removal.- Specified by:
removeAll
in interfaceByteCollection
- Returns:
- Returns the number of removed elements.
-
retainAll
public int retainAll(ByteLookupContainer c)
Default implementation uses a predicate for retaining.- Specified by:
retainAll
in interfaceByteCollection
- Returns:
- Returns the number of removed elements.
-
retainAll
public int retainAll(BytePredicate predicate)
Default implementation redirects toByteCollection.removeAll(BytePredicate)
and negates the predicate.- Specified by:
retainAll
in interfaceByteCollection
- Returns:
- Returns the number of removed elements.
-
toString
public java.lang.String toString()
Convert the contents of this container to a human-friendly string.- Overrides:
toString
in classjava.lang.Object
-
-