Immutable, strict, finite sequence of values that supports efficient index-based random access of elements, is memory efficient for all sizes, and avoids unnecessary copying.
Chunk
s can be created from a variety of collection types using methods on the Chunk
companion
(e.g., Chunk.array
, Chunk.seq
, Chunk.vector
).
Chunks can be appended via the ++
method. The returned chunk is a composite of the input
chunks -- that is, there's no copying of the source chunks. For example, Chunk(1, 2) ++ Chunk(3, 4) ++ Chunk(5, 6)
returns a Chunk.Queue(Chunk(1, 2), Chunk(3, 4), Chunk(5, 6))
. As a result, indexed based lookup of
an appended chunk is amortized O(log2(number of underlying chunks))
. In the worst case, where each constituent chunk
has size 1, indexed lookup is O(log2(size))
. To restore O(1)
lookup, call compact
, which copies all the underlying
chunk elements to a single array backed chunk. Note compact
requires a ClassTag
of the element type.
Alternatively, a collection of chunks can be directly copied to a new array backed chunk via
Chunk.concat(chunks)
. Like compact
, Chunk.concat
requires a ClassTag
for the element type.
Various subtypes of Chunk
are exposed for efficiency reasons:
Chunk.Singleton
Chunk.ArraySlice
Chunk.Queue
In particular, calling .toArraySlice
on a chunk returns a Chunk.ArraySlice
, which provides
access to the underlying backing array, along with an offset and length, referring to a slice
of that array.
- Companion:
- object
- Source:
- Chunk.scala
Value members
Abstract methods
Returns the element at the specified index. Throws if index is < 0 or >= size.
Returns the element at the specified index. Throws if index is < 0 or >= size.
- Source:
- Chunk.scala
Copies the elements of this chunk in to the specified array at the specified start index.
Copies the elements of this chunk in to the specified array at the specified start index.
- Source:
- Chunk.scala
Returns the number of elements in this chunk.
Returns the number of elements in this chunk.
- Source:
- Chunk.scala
Concrete methods
Returns a chunk which consists of the elements of this chunk and the elements of the supplied chunk. This operation is amortized O(1).
Returns a chunk which consists of the elements of this chunk and the elements of the supplied chunk. This operation is amortized O(1).
- Source:
- Chunk.scala
More efficient version of filter(pf.isDefinedAt).map(pf)
.
More efficient version of filter(pf.isDefinedAt).map(pf)
.
- Source:
- Chunk.scala
Converts this chunk to a chunk backed by a single array.
Converts this chunk to a chunk backed by a single array.
Alternatively, call toIndexedChunk
to get back a chunk with guaranteed O(1) indexed lookup
while also minimizing copying.
- Source:
- Chunk.scala
Drops the first n
elements of this chunk.
Drops the first n
elements of this chunk.
- Source:
- Chunk.scala
Drops the right-most n
elements of this chunk queue in a way that preserves chunk structure.
Drops the right-most n
elements of this chunk queue in a way that preserves chunk structure.
- Source:
- Chunk.scala
Returns a chunk that has only the elements that satisfy the supplied predicate.
Returns a chunk that has only the elements that satisfy the supplied predicate.
- Source:
- Chunk.scala
Returns the first element for which the predicate returns true or None
if no elements satisfy the predicate.
Returns the first element for which the predicate returns true or None
if no elements satisfy the predicate.
- Source:
- Chunk.scala
Maps f
over the elements of this chunk and concatenates the result.
Maps f
over the elements of this chunk and concatenates the result.
- Source:
- Chunk.scala
Returns true if the predicate passes for all elements.
Returns true if the predicate passes for all elements.
- Source:
- Chunk.scala
Invokes the supplied function for each element of this chunk.
Invokes the supplied function for each element of this chunk.
- Source:
- Chunk.scala
Like foreach
but includes the index of the element.
Like foreach
but includes the index of the element.
- Source:
- Chunk.scala
Returns the index of the first element which passes the specified predicate (i.e., p(i) == true
)
or None
if no elements pass the predicate.
Returns the index of the first element which passes the specified predicate (i.e., p(i) == true
)
or None
if no elements pass the predicate.
- Source:
- Chunk.scala
Creates an iterator that iterates the elements of this chunk. The returned iterator is not thread safe.
Creates an iterator that iterates the elements of this chunk. The returned iterator is not thread safe.
- Source:
- Chunk.scala
Creates a new chunk by applying f
to each element in this chunk.
Creates a new chunk by applying f
to each element in this chunk.
- Source:
- Chunk.scala
Maps the supplied stateful function over each element, outputting the final state and the accumulated outputs.
The first invocation of f
uses init
as the input state value. Each successive invocation uses
the output state of the previous invocation.
Maps the supplied stateful function over each element, outputting the final state and the accumulated outputs.
The first invocation of f
uses init
as the input state value. Each successive invocation uses
the output state of the previous invocation.
- Source:
- Chunk.scala
Maps the supplied function over each element and returns a chunk of just the defined results.
Maps the supplied function over each element and returns a chunk of just the defined results.
- Source:
- Chunk.scala
Creates an iterator that iterates the elements of this chunk in reverse order. The returned iterator is not thread safe.
Creates an iterator that iterates the elements of this chunk in reverse order. The returned iterator is not thread safe.
- Source:
- Chunk.scala
Like foldLeft
but emits each intermediate result of f
.
Like foldLeft
but emits each intermediate result of f
.
- Source:
- Chunk.scala
Like scanLeft
except the final element is emitted as a standalone value instead of as
the last element of the accumulated chunk.
Like scanLeft
except the final element is emitted as a standalone value instead of as
the last element of the accumulated chunk.
Equivalent to val b = a.scanLeft(z)(f); val (c, carry) = b.splitAt(b.size - 1)
.
- Source:
- Chunk.scala
Splits this chunk in to two chunks at the specified index.
Splits this chunk in to two chunks at the specified index.
- Source:
- Chunk.scala
Check to see if this starts with the items in the given seq.
Check to see if this starts with the items in the given seq.
- Source:
- Chunk.scala
Takes the first n
elements of this chunk.
Takes the first n
elements of this chunk.
- Source:
- Chunk.scala
Takes the right-most n
elements of this chunk queue in a way that preserves chunk structure.
Takes the right-most n
elements of this chunk queue in a way that preserves chunk structure.
- Source:
- Chunk.scala
Converts this chunk to a new collection using the supplied collector.
Converts this chunk to a new collection using the supplied collector.
- Example:
scala> Chunk(1, 2, 3).to(Set)
- Source:
- Chunk.scala
Copies the elements of this chunk to an array.
Copies the elements of this chunk to an array.
- Source:
- Chunk.scala
Converts this chunk to a Chunk.ArraySlice
.
Converts this chunk to a Chunk.ArraySlice
.
- Source:
- Chunk.scala
Converts this chunk to a scodec-bits BitVector.
Converts this chunk to a scodec-bits BitVector.
- Source:
- Chunk.scala
Converts this chunk to a java.nio.ByteBuffer
.
Converts this chunk to a java.nio.ByteBuffer
.
- Source:
- Chunk.scala
Converts this chunk to a scodec-bits ByteVector.
Converts this chunk to a scodec-bits ByteVector.
- Source:
- Chunk.scala
Returns a chunk with guaranteed O(1) lookup by index.
Returns a chunk with guaranteed O(1) lookup by index.
Unlike compact
, this operation does not copy any elements unless this chunk
does not provide O(1) lookup by index -- e.g., a chunk built via 1 or more usages
of ++
.
- Source:
- Chunk.scala
Zips this chunk the the supplied chunk, returning a chunk of tuples.
Zips this chunk the the supplied chunk, returning a chunk of tuples.
- Source:
- Chunk.scala
Zips this chunk with the supplied chunk, passing each pair to f
, resulting in
an output chunk.
Zips this chunk with the supplied chunk, passing each pair to f
, resulting in
an output chunk.
- Source:
- Chunk.scala
Zips the elements of the input chunk with its indices, and returns the new chunk.
Zips the elements of the input chunk with its indices, and returns the new chunk.
- Example:
scala> Chunk("The", "quick", "brown", "fox").zipWithIndex.toList res0: List[(String, Int)] = List((The,0), (quick,1), (brown,2), (fox,3))
- Source:
- Chunk.scala
Deprecated methods
Like compact
but does not require a ClassTag
. Elements are boxed and stored in an Array[Any]
.
Like compact
but does not require a ClassTag
. Elements are boxed and stored in an Array[Any]
.
- Deprecated
- Source:
- Chunk.scala