T
- Component type of the Queuepublic final class Queue<T> extends Object implements LinearSeq<T>
Queue
stores elements allowing a first-in-first-out (FIFO) retrieval.
Queue API:
dequeue()
dequeueOption()
enqueue(Object)
enqueue(Object[])
enqueueAll(Iterable)
peek()
peekOption()
When the front list is empty, front and rear are swapped and rear is reversed. This implies the following queue
invariant: front.isEmpty() => rear.isEmpty()
.
See Okasaki, Chris: Purely Functional Data Structures (p. 42 ff.). Cambridge, 2003.
Modifier and Type | Method and Description |
---|---|
Queue<T> |
append(T element)
Appends an element to this.
|
Queue<T> |
appendAll(Iterable<? extends T> elements)
Appends all given elements to this.
|
List<T> |
asJava()
Creates an immutable
List view on top of this Seq ,
i.e. |
Queue<T> |
asJava(Consumer<? super List<T>> action)
|
List<T> |
asJavaMutable()
Creates a mutable
List view on top of this Seq ,
i.e. |
Queue<T> |
asJavaMutable(Consumer<? super List<T>> action)
|
<R> Queue<R> |
collect(PartialFunction<? super T,? extends R> partialFunction)
Collects all elements that are in the domain of the given
partialFunction by mapping the elements to type R . |
static <T> Collector<T,ArrayList<T>,Queue<T>> |
collector()
Returns a
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a Queue
. |
Queue<Queue<T>> |
combinations()
Returns the union of all combinations from k = 0 to length().
|
Queue<Queue<T>> |
combinations(int k)
Returns the k-combination of this traversable, i.e.
|
Iterator<Queue<T>> |
crossProduct(int power)
Calculates the n-ary cartesian power (or cross product or simply product) of this.
|
Tuple2<T,Q> |
dequeue()
Removes an element from this Queue.
|
Option<Tuple2<T,Q>> |
dequeueOption()
Removes an element from this Queue.
|
Queue<T> |
distinct()
Returns a new version of this which contains no duplicates.
|
Queue<T> |
distinctBy(Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.
|
<U> Queue<T> |
distinctBy(Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.
|
Queue<T> |
drop(int n)
Drops the first n elements of this or all elements, if this length < n.
|
Queue<T> |
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.
|
Queue<T> |
dropRightUntil(Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element, starting from the end.
|
Queue<T> |
dropRightWhile(Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element, starting from the end.
|
Q |
dropUntil(Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.
|
Queue<T> |
dropWhile(Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.
|
static <T> Queue<T> |
empty()
Returns the empty Queue.
|
Q |
enqueue(T... elements)
Enqueues the given elements.
|
Queue<T> |
enqueue(T element)
Enqueues a new element.
|
Queue<T> |
enqueueAll(Iterable<? extends T> elements)
Enqueues the given elements.
|
boolean |
equals(Object o)
In Vavr there are four basic classes of collections:
Seq (sequential elements)
Set (distinct elements)
Map (indexed elements)
Multimap (indexed collections)
Two collection instances of these classes are equal if and only if both collections
belong to the same basic collection class (Seq, Set, Map or Multimap)
contain the same elements
have the same element order, if the collections are of type Seq
Two Map/Multimap elements, resp.
|
static <T> Queue<T> |
fill(int n,
Supplier<? extends T> s)
Returns a Queue containing
n values supplied by a given Supplier s . |
static <T> Queue<T> |
fill(int n,
T element)
Returns a Queue containing
n times the given element |
Queue<T> |
filter(Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.
|
<U> Queue<U> |
flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)
FlatMaps this Traversable.
|
T |
get(int index)
Returns the element at the specified index.
|
<C> Map<C,Queue<T>> |
groupBy(Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.
|
Iterator<Queue<T>> |
grouped(int size)
Groups this
Traversable into fixed size blocks. |
boolean |
hasDefiniteSize()
Checks if this Traversable is known to have a finite size.
|
int |
hashCode()
Returns the hash code of this collection.
|
T |
head()
Returns the first element of a non-empty Traversable.
|
int |
indexOf(T element,
int from)
Returns the index of the first occurrence of the given element after or at some start index
or -1 if this does not contain the given element.
|
Queue<T> |
init()
Dual of tail(), returning all elements except the last.
|
Option<Q> |
initOption()
Dual of tailOption(), returning all elements except the last as
Option . |
Queue<T> |
insert(int index,
T element)
Inserts the given element at the specified index.
|
Queue<T> |
insertAll(int index,
Iterable<? extends T> elements)
Inserts the given elements at the specified index.
|
Queue<T> |
intersperse(T element)
Inserts an element between all elements of this Traversable.
|
boolean |
isAsync()
A
Queue is computed synchronously. |
boolean |
isEmpty()
Checks if this Traversable is empty.
|
boolean |
isLazy()
A
Queue is computed eagerly. |
boolean |
isTraversableAgain()
Checks if this Traversable can be repeatedly traversed.
|
T |
last()
Dual of Traversable.head(), returning the last element.
|
int |
lastIndexOf(T element,
int end)
Returns the index of the last occurrence of the given element before or at a given end index
or -1 if this does not contain the given element.
|
Queue<T> |
leftPadTo(int length,
T element)
A copy of this sequence with an element prepended until a given target length is reached.
|
int |
length()
Computes the number of elements of this Traversable.
|
<U> Queue<U> |
map(Function<? super T,? extends U> mapper)
Maps the elements of this
Traversable to elements of a new type preserving their order, if any. |
static <T> Queue<T> |
narrow(Queue<? extends T> queue)
Narrows a widened
Queue<? extends T> to Queue<T>
by performing a type-safe cast. |
static <T> Queue<T> |
of(T... elements)
Creates a Queue of the given elements.
|
static <T> Queue<T> |
of(T element)
Returns a singleton
Queue , i.e. |
static Queue<Boolean> |
ofAll(boolean... elements)
Creates a Queue from boolean values.
|
static Queue<Byte> |
ofAll(byte... elements)
Creates a Queue from byte values.
|
static Queue<Character> |
ofAll(char... elements)
Creates a Queue from char values.
|
static Queue<Double> |
ofAll(double... elements)
Creates a Queue from double values.
|
static Queue<Float> |
ofAll(float... elements)
Creates a Queue from float values.
|
static Queue<Integer> |
ofAll(int... elements)
Creates a Queue from int values.
|
static <T> Queue<T> |
ofAll(Iterable<? extends T> elements)
Creates a Queue of the given elements.
|
static Queue<Long> |
ofAll(long... elements)
Creates a Queue from long values.
|
static Queue<Short> |
ofAll(short... elements)
Creates a Queue from short values.
|
static <T> Queue<T> |
ofAll(Stream<? extends T> javaStream)
Creates a Queue that contains the elements of the given
Stream . |
Queue<T> |
orElse(Iterable<? extends T> other)
Returns this
Traversable if it is nonempty, otherwise return the alternative. |
Queue<T> |
orElse(Supplier<? extends Iterable<? extends T>> supplier)
Returns this
Traversable if it is nonempty, otherwise return the result of evaluating supplier. |
Queue<T> |
padTo(int length,
T element)
A copy of this sequence with an element appended until a given target length is reached.
|
Tuple2<Queue<T>,Queue<T>> |
partition(Predicate<? super T> predicate)
Creates a partition of this
Traversable by splitting this elements in two in distinct traversables
according to a predicate. |
Queue<T> |
patch(int from,
Iterable<? extends T> that,
int replaced)
Produces a new list where a slice of elements in this list is replaced by another sequence.
|
T |
peek()
Returns the first element without modifying it.
|
Q |
peek(Consumer<? super T> action)
Performs the given
action on the first element if this is an eager implementation. |
Option<T> |
peekOption()
Returns the first element without modifying the Queue.
|
Queue<Queue<T>> |
permutations()
Computes all unique permutations.
|
Queue<T> |
prepend(T element)
Prepends an element to this.
|
Queue<T> |
prependAll(Iterable<? extends T> elements)
Prepends all given elements to this.
|
static Queue<Character> |
range(char from,
char toExclusive) |
static Queue<Integer> |
range(int from,
int toExclusive)
Creates a Queue of int numbers starting from
from , extending to toExclusive - 1 . |
static Queue<Long> |
range(long from,
long toExclusive)
Creates a Queue of long numbers starting from
from , extending to toExclusive - 1 . |
static Queue<Character> |
rangeBy(char from,
char toExclusive,
int step) |
static Queue<Double> |
rangeBy(double from,
double toExclusive,
double step) |
static Queue<Integer> |
rangeBy(int from,
int toExclusive,
int step)
Creates a Queue of int numbers starting from
from , extending to toExclusive - 1 ,
with step . |
static Queue<Long> |
rangeBy(long from,
long toExclusive,
long step)
Creates a Queue of long numbers starting from
from , extending to toExclusive - 1 ,
with step . |
static Queue<Character> |
rangeClosed(char from,
char toInclusive) |
static Queue<Integer> |
rangeClosed(int from,
int toInclusive)
Creates a Queue of int numbers starting from
from , extending to toInclusive . |
static Queue<Long> |
rangeClosed(long from,
long toInclusive)
Creates a Queue of long numbers starting from
from , extending to toInclusive . |
static Queue<Character> |
rangeClosedBy(char from,
char toInclusive,
int step) |
static Queue<Double> |
rangeClosedBy(double from,
double toInclusive,
double step) |
static Queue<Integer> |
rangeClosedBy(int from,
int toInclusive,
int step)
Creates a Queue of int numbers starting from
from , extending to toInclusive ,
with step . |
static Queue<Long> |
rangeClosedBy(long from,
long toInclusive,
long step)
Creates a Queue of long numbers starting from
from , extending to toInclusive ,
with step . |
Q |
reject(Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which do not satisfy the given predicate.
|
Queue<T> |
remove(T element)
Removes the first occurrence of the given element.
|
Q |
removeAll(Iterable<? extends T> elements) |
Q |
removeAll(Predicate<? super T> predicate)
Deprecated.
|
Queue<T> |
removeAll(T element)
Removes all occurrences of the given element.
|
Queue<T> |
removeAt(int index)
Removes the element at the specified position in this sequence.
|
Queue<T> |
removeFirst(Predicate<T> predicate)
Removes the first occurrence that satisfy predicate
|
Queue<T> |
removeLast(Predicate<T> predicate)
Removes the last occurrence that satisfy predicate
|
Queue<T> |
replace(T currentElement,
T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.
|
Queue<T> |
replaceAll(T currentElement,
T newElement)
Replaces all occurrences of the given currentElement with newElement.
|
Q |
retainAll(Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.
|
Queue<T> |
reverse()
Reverses the order of elements.
|
Queue<T> |
rotateLeft(int n)
Circular rotates the elements by the specified distance to the left direction.
|
Queue<T> |
rotateRight(int n)
Circular rotates the elements by the specified distance to the right direction.
|
Queue<T> |
scan(T zero,
BiFunction<? super T,? super T,? extends T> operation)
Computes a prefix scan of the elements of the collection.
|
<U> Queue<U> |
scanLeft(U zero,
BiFunction<? super U,? super T,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going left to right.
|
<U> Queue<U> |
scanRight(U zero,
BiFunction<? super T,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going right to left.
|
Queue<T> |
shuffle()
Randomize the order of the elements in the current sequence.
|
Queue<T> |
slice(int beginIndex,
int endIndex)
Returns a Seq that is a slice of this.
|
Iterator<Queue<T>> |
slideBy(Function<? super T,?> classifier)
Slides a non-overlapping window of a variable size over this
Traversable . |
Iterator<Queue<T>> |
sliding(int size)
Slides a window of a specific
size and step size 1 over this Traversable by calling
Traversable.sliding(int, int) . |
Iterator<Queue<T>> |
sliding(int size,
int step)
Slides a window of a specific
size and step size over this Traversable . |
<U> Queue<T> |
sortBy(Comparator<? super U> comparator,
Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper . |
<U extends Comparable<? super U>> |
sortBy(Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper . |
Queue<T> |
sorted()
Sorts this elements according to their natural order.
|
Queue<T> |
sorted(Comparator<? super T> comparator)
Sorts this elements according to the provided
Comparator . |
Tuple2<Queue<T>,Queue<T>> |
span(Predicate<? super T> predicate)
Returns a tuple where the first element is the longest prefix of elements that satisfy the given
predicate and the second element is the remainder. |
Tuple2<Queue<T>,Queue<T>> |
splitAt(int n)
Splits a Seq at the specified index.
|
Tuple2<Queue<T>,Queue<T>> |
splitAt(Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate , e.g. |
Tuple2<Queue<T>,Queue<T>> |
splitAtInclusive(Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate , e.g. |
boolean |
startsWith(Iterable<? extends T> that,
int offset)
Tests whether this list contains the given sequence at a given index.
|
String |
stringPrefix()
Returns the name of this Value type, which is used by toString().
|
Queue<T> |
subSequence(int beginIndex)
Returns a Seq that is a subsequence of this.
|
Queue<T> |
subSequence(int beginIndex,
int endIndex)
Returns a Seq that is a subsequence of this.
|
static <T> Queue<T> |
tabulate(int n,
Function<? super Integer,? extends T> f)
Returns a Queue containing
n values of a given Function f
over a range of integer values from 0 to n - 1 . |
Queue<T> |
tail()
Drops the first element of a non-empty Traversable.
|
Option<Q> |
tailOption()
Drops the first element of a non-empty Traversable and returns an
Option . |
Queue<T> |
take(int n)
Takes the first n elements of this or all elements, if this length < n.
|
Queue<T> |
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.
|
Queue<T> |
takeRightUntil(Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element, starting from the end.
|
Queue<T> |
takeRightWhile(Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element, starting from the end.
|
Queue<T> |
takeUntil(Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.
|
Q |
takeWhile(Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.
|
String |
toString()
Clarifies that values have a proper toString() method implemented.
|
<U> U |
transform(Function<? super Queue<T>,? extends U> f)
Transforms this
Queue . |
static <T> Queue<Queue<T>> |
transpose(Queue<Queue<T>> matrix)
Transposes the rows and columns of a
Queue matrix. |
static <T> Queue<T> |
unfold(T seed,
Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
Creates a Queue from a seed value and a function.
|
static <T,U> Queue<U> |
unfoldLeft(T seed,
Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
Creates a Queue from a seed value and a function.
|
static <T,U> Queue<U> |
unfoldRight(T seed,
Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
Creates a Queue from a seed value and a function.
|
<T1,T2> Tuple2<Queue<T1>,Queue<T2>> |
unzip(Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct
sets.
|
<T1,T2,T3> Tuple3<Queue<T1>,Queue<T2>,Queue<T3>> |
unzip3(Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct
sets.
|
Queue<T> |
update(int index,
Function<? super T,? extends T> updater)
Updates the given element at the specified index using the specified function.
|
Queue<T> |
update(int index,
T element)
Updates the given element at the specified index.
|
<U> Queue<Tuple2<T,U>> |
zip(Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining
corresponding elements in pairs.
|
<U> Queue<Tuple2<T,U>> |
zipAll(Iterable<? extends U> that,
T thisElem,
U thatElem)
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in
pairs.
|
<U,R> Queue<R> |
zipWith(Iterable<? extends U> that,
BiFunction<? super T,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
|
Queue<Tuple2<T,Integer>> |
zipWithIndex()
Zips this traversable with its indices.
|
<U> Queue<U> |
zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asPartialFunction, dropUntil, indexOfSlice, indexWhere, initOption, isDefinedAt, lastIndexOfSlice, lastIndexWhere, narrow, peek, reject, removeAll, removeAll, retainAll, reverseIterator, search, search, segmentLength, tailOption, takeWhile
apply, containsSlice, crossProduct, crossProduct, endsWith, foldRight, indexOf, indexOfOption, indexOfOption, indexOfSlice, indexOfSliceOption, indexOfSliceOption, indexWhere, indexWhereOption, indexWhereOption, isSequential, iterator, lastIndexOf, lastIndexOfOption, lastIndexOfOption, lastIndexOfSlice, lastIndexOfSliceOption, lastIndexOfSliceOption, lastIndexWhere, lastIndexWhereOption, lastIndexWhereOption, lift, narrow, prefixLength, startsWith, withDefault, withDefaultValue
arrangeBy, average, containsAll, count, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, headOption, isDistinct, isOrdered, isSingleValued, iterator, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, narrow, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum
fold, reduce, reduceOption
collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, narrow, out, out, stderr, stdout, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toString, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
getIfDefined, unlift
public static <T> Collector<T,ArrayList<T>,Queue<T>> collector()
Collector
which may be used in conjunction with
Stream.collect(java.util.stream.Collector)
to obtain a Queue
.T
- Component type of the Queue.public static <T> Queue<T> empty()
T
- Component typepublic static <T> Queue<T> narrow(Queue<? extends T> queue)
Queue<? extends T>
to Queue<T>
by performing a type-safe cast. This is eligible because immutable/read-only
collections are covariant.T
- Component type of the Queue
.queue
- An Queue
.queue
instance as narrowed type Queue<T>
.public static <T> Queue<T> of(T element)
Queue
, i.e. a Queue
of one element.@SafeVarargs public static <T> Queue<T> of(T... elements)
T
- Component type of the Queue.elements
- Zero or more elements.NullPointerException
- if elements
is nullpublic static <T> Queue<T> ofAll(Iterable<? extends T> elements)
T
- Component type of the Queue.elements
- An Iterable of elements.NullPointerException
- if elements
is nullpublic static <T> Queue<T> ofAll(Stream<? extends T> javaStream)
Stream
.T
- Component type of the Stream.javaStream
- A Stream
public static Queue<Boolean> ofAll(boolean... elements)
elements
- boolean valuesNullPointerException
- if elements is nullpublic static Queue<Byte> ofAll(byte... elements)
elements
- byte valuesNullPointerException
- if elements is nullpublic static Queue<Character> ofAll(char... elements)
elements
- char valuesNullPointerException
- if elements is nullpublic static Queue<Double> ofAll(double... elements)
elements
- double valuesNullPointerException
- if elements is nullpublic static Queue<Float> ofAll(float... elements)
elements
- float valuesNullPointerException
- if elements is nullpublic static Queue<Integer> ofAll(int... elements)
elements
- int valuesNullPointerException
- if elements is nullpublic static Queue<Long> ofAll(long... elements)
elements
- long valuesNullPointerException
- if elements is nullpublic static Queue<Short> ofAll(short... elements)
elements
- short valuesNullPointerException
- if elements is nullpublic static <T> Queue<T> tabulate(int n, Function<? super Integer,? extends T> f)
n
values of a given Function f
over a range of integer values from 0 to n - 1
.T
- Component type of the Queuen
- The number of elements in the Queuef
- The Function computing element valuesf(0),f(1), ..., f(n - 1)
NullPointerException
- if f
is nullpublic static <T> Queue<T> fill(int n, Supplier<? extends T> s)
n
values supplied by a given Supplier s
.T
- Component type of the Queuen
- The number of elements in the Queues
- The Supplier computing element valuesn
, where each element contains the result supplied by s
.NullPointerException
- if s
is nullpublic static <T> Queue<T> fill(int n, T element)
n
times the given element
T
- Component type of the Queuen
- The number of elements in the Queueelement
- The elementn
, where each element is the given element
.@GwtIncompatible public static Queue<Double> rangeBy(double from, double toExclusive, double step)
public static Queue<Integer> range(int from, int toExclusive)
from
, extending to toExclusive - 1
.
Examples:
Queue.range(0, 0) // = Queue()
Queue.range(2, 0) // = Queue()
Queue.range(-2, 2) // = Queue(-2, -1, 0, 1)
from
- the first numbertoExclusive
- the last number + 1Nil
if from >= toExclusive
public static Queue<Integer> rangeBy(int from, int toExclusive, int step)
from
, extending to toExclusive - 1
,
with step
.
Examples:
Queue.rangeBy(1, 3, 1) // = Queue(1, 2)
Queue.rangeBy(1, 4, 2) // = Queue(1, 3)
Queue.rangeBy(4, 1, -2) // = Queue(4, 2)
Queue.rangeBy(4, 1, 2) // = Queue()
from
- the first numbertoExclusive
- the last number + 1step
- the stepNil
iffrom >= toInclusive
and step > 0
orfrom <= toInclusive
and step < 0
IllegalArgumentException
- if step
is zeropublic static Queue<Long> range(long from, long toExclusive)
from
, extending to toExclusive - 1
.
Examples:
Queue.range(0L, 0L) // = Queue()
Queue.range(2L, 0L) // = Queue()
Queue.range(-2L, 2L) // = Queue(-2L, -1L, 0L, 1L)
from
- the first numbertoExclusive
- the last number + 1Nil
if from >= toExclusive
public static Queue<Long> rangeBy(long from, long toExclusive, long step)
from
, extending to toExclusive - 1
,
with step
.
Examples:
Queue.rangeBy(1L, 3L, 1L) // = Queue(1L, 2L)
Queue.rangeBy(1L, 4L, 2L) // = Queue(1L, 3L)
Queue.rangeBy(4L, 1L, -2L) // = Queue(4L, 2L)
Queue.rangeBy(4L, 1L, 2L) // = Queue()
from
- the first numbertoExclusive
- the last number + 1step
- the stepNil
iffrom >= toInclusive
and step > 0
orfrom <= toInclusive
and step < 0
IllegalArgumentException
- if step
is zero@GwtIncompatible public static Queue<Double> rangeClosedBy(double from, double toInclusive, double step)
public static Queue<Integer> rangeClosed(int from, int toInclusive)
from
, extending to toInclusive
.
Examples:
Queue.rangeClosed(0, 0) // = Queue(0)
Queue.rangeClosed(2, 0) // = Queue()
Queue.rangeClosed(-2, 2) // = Queue(-2, -1, 0, 1, 2)
from
- the first numbertoInclusive
- the last numberNil
if from > toInclusive
public static Queue<Integer> rangeClosedBy(int from, int toInclusive, int step)
from
, extending to toInclusive
,
with step
.
Examples:
Queue.rangeClosedBy(1, 3, 1) // = Queue(1, 2, 3)
Queue.rangeClosedBy(1, 4, 2) // = Queue(1, 3)
Queue.rangeClosedBy(4, 1, -2) // = Queue(4, 2)
Queue.rangeClosedBy(4, 1, 2) // = Queue()
from
- the first numbertoInclusive
- the last numberstep
- the stepNil
iffrom > toInclusive
and step > 0
orfrom < toInclusive
and step < 0
IllegalArgumentException
- if step
is zeropublic static Queue<Long> rangeClosed(long from, long toInclusive)
from
, extending to toInclusive
.
Examples:
Queue.rangeClosed(0L, 0L) // = Queue(0L)
Queue.rangeClosed(2L, 0L) // = Queue()
Queue.rangeClosed(-2L, 2L) // = Queue(-2L, -1L, 0L, 1L, 2L)
from
- the first numbertoInclusive
- the last numberNil
if from > toInclusive
public static <T> Queue<Queue<T>> transpose(Queue<Queue<T>> matrix)
Queue
matrix.T
- matrix element typematrix
- to be transposed.Queue
matrix.IllegalArgumentException
- if the row lengths of matrix
differ.
ex: Queue.transpose(Queue(Queue(1,2,3), Queue(4,5,6))) → Queue(Queue(1,4), Queue(2,5), Queue(3,6))
public static Queue<Long> rangeClosedBy(long from, long toInclusive, long step)
from
, extending to toInclusive
,
with step
.
Examples:
Queue.rangeClosedBy(1L, 3L, 1L) // = Queue(1L, 2L, 3L)
Queue.rangeClosedBy(1L, 4L, 2L) // = Queue(1L, 3L)
Queue.rangeClosedBy(4L, 1L, -2L) // = Queue(4L, 2L)
Queue.rangeClosedBy(4L, 1L, 2L) // = Queue()
from
- the first numbertoInclusive
- the last numberstep
- the stepNil
iffrom > toInclusive
and step > 0
orfrom < toInclusive
and step < 0
IllegalArgumentException
- if step
is zeropublic static <T,U> Queue<U> unfoldRight(T seed, Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
None
when it's
done generating the Queue, otherwise Some
Tuple
of the element for the next call and the value to add to the
resulting Queue.
Example:
Queue.unfoldRight(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<>(x, x-1)));
// Queue(10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
T
- type of seedsU
- type of unfolded valuesseed
- the start value for the iterationf
- the function to get the next step of the iterationNullPointerException
- if f
is nullpublic static <T,U> Queue<U> unfoldLeft(T seed, Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
None
when it's
done generating the Queue, otherwise Some
Tuple
of the value to add to the resulting Queue and
the element for the next call.
Example:
Queue.unfoldLeft(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<>(x-1, x)));
// Queue(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
T
- type of seedsU
- type of unfolded valuesseed
- the start value for the iterationf
- the function to get the next step of the iterationNullPointerException
- if f
is nullpublic static <T> Queue<T> unfold(T seed, Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
None
when it's
done generating the Queue, otherwise Some
Tuple
of the value to add to the resulting Queue and
the element for the next call.
Example:
Queue.unfold(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<>(x-1, x)));
// Queue(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
T
- type of seeds and unfolded valuesseed
- the start value for the iterationf
- the function to get the next step of the iterationNullPointerException
- if f
is nullpublic Queue<T> enqueue(T element)
element
- The new elementQueue
instance, containing the new elementpublic Queue<T> enqueueAll(Iterable<? extends T> elements)
elements
- An Iterable of elements, may be emptyQueue
instance, containing the new elementsNullPointerException
- if elements is nullpublic Queue<T> append(T element)
Seq
public Queue<T> appendAll(Iterable<? extends T> elements)
Seq
@GwtIncompatible public List<T> asJava()
Seq
List
view on top of this Seq
,
i.e. calling mutators will result in UnsupportedOperationException
at runtime.
The difference to conversion methods toJava*()
is that
java.util.List
view throws UnsupportedOperationException
before
checking method arguments. Java does handle this case inconsistently.asJava
in interface Seq<T>
Collection
view on this Traversable
.@GwtIncompatible public Queue<T> asJava(Consumer<? super List<T>> action)
Seq
@GwtIncompatible public List<T> asJavaMutable()
Seq
List
view on top of this Seq
,
i.e. all mutator methods of the List
are implemented.asJavaMutable
in interface Seq<T>
Collection
view on this Traversable
.Seq.asJava()
@GwtIncompatible public Queue<T> asJavaMutable(Consumer<? super List<T>> action)
Seq
asJavaMutable
in interface LinearSeq<T>
asJavaMutable
in interface Seq<T>
action
- A side-effecting unit of work that operates on a mutable java.util.List
view.java.util.List
view or a new instance of this type, if write operations are performed on the java.util.List
view.Seq.asJavaMutable()
public <R> Queue<R> collect(PartialFunction<? super T,? extends R> partialFunction)
Traversable
partialFunction
by mapping the elements to type R
.
More specifically, for each of this elements in iteration order first it is checked
partialFunction.isDefinedAt(element)
If the elements makes it through that filter, the mapped instance is added to the result collection
R newElement = partialFunction.apply(element)
Note:If this Traversable
is ordered (i.e. extends Ordered
,
the caller of collect
has to ensure that the elements are comparable (i.e. extend Comparable
).collect
in interface LinearSeq<T>
collect
in interface Seq<T>
collect
in interface Traversable<T>
R
- The new element typepartialFunction
- A function that is not necessarily defined of all elements of this traversable.Traversable
instance containing elements of type R
public Queue<Queue<T>> combinations()
Seq
Examples:
[].combinations() = [[]]
[1,2,3].combinations() = [
[], // k = 0
[1], [2], [3], // k = 1
[1,2], [1,3], [2,3], // k = 2
[1,2,3] // k = 3
]
combinations
in interface LinearSeq<T>
combinations
in interface Seq<T>
public Queue<Queue<T>> combinations(int k)
Seq
combinations
in interface LinearSeq<T>
combinations
in interface Seq<T>
k
- Size of subsetspublic Iterator<Queue<T>> crossProduct(int power)
Seq
Example:
// = ((A,A), (A,B), (A,C), ..., (B,A), (B,B), ..., (Z,Y), (Z,Z))
CharSeq.rangeClosed('A', 'Z').crossProduct(2);
Cartesian power of negative value will return empty iterator.
Example:
// = ()
CharSeq.rangeClosed('A', 'Z').crossProduct(-1);
crossProduct
in interface LinearSeq<T>
crossProduct
in interface Seq<T>
power
- the number of cartesian multiplicationspublic Queue<T> distinct()
Traversable
equals
.public Queue<T> distinctBy(Comparator<? super T> comparator)
Traversable
comparator
.distinctBy
in interface LinearSeq<T>
distinctBy
in interface Seq<T>
distinctBy
in interface Traversable<T>
comparator
- A comparatorTraversable
containing this elements without duplicatespublic <U> Queue<T> distinctBy(Function<? super T,? extends U> keyExtractor)
Traversable
equals
.
The elements of the result are determined in the order of their occurrence - first match wins.
distinctBy
in interface LinearSeq<T>
distinctBy
in interface Seq<T>
distinctBy
in interface Traversable<T>
U
- key typekeyExtractor
- A key extractorTraversable
containing this elements without duplicatespublic Queue<T> drop(int n)
Traversable
drop
in interface LinearSeq<T>
drop
in interface Seq<T>
drop
in interface Traversable<T>
n
- The number of elements to drop.public Queue<T> dropWhile(Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as dropUntil(predicate.negate())
.
It is intended to be used with method references, which cannot be negated directly.
dropWhile
in interface LinearSeq<T>
dropWhile
in interface Seq<T>
dropWhile
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Queue<T> dropRight(int n)
Traversable
dropRight
in interface LinearSeq<T>
dropRight
in interface Seq<T>
dropRight
in interface Traversable<T>
n
- The number of elements to drop.public Queue<T> dropRightUntil(Predicate<? super T> predicate)
Seq
dropRightUntil
in interface LinearSeq<T>
dropRightUntil
in interface Seq<T>
predicate
- A condition tested subsequently for this elements, starting from the end.public Queue<T> dropRightWhile(Predicate<? super T> predicate)
Seq
Note: This is essentially the same as dropRightUntil(predicate.negate())
.
It is intended to be used with method references, which cannot be negated directly.
dropRightWhile
in interface LinearSeq<T>
dropRightWhile
in interface Seq<T>
predicate
- A condition tested subsequently for this elements, starting from the end.public Queue<T> filter(Predicate<? super T> predicate)
Traversable
public <U> Queue<U> flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)
Traversable
public T get(int index)
Seq
public <C> Map<C,Queue<T>> groupBy(Function<? super T,? extends C> classifier)
Traversable
groupBy
in interface LinearSeq<T>
groupBy
in interface Seq<T>
groupBy
in interface Traversable<T>
C
- classified class typeclassifier
- A function which classifies elements into classesTraversable.arrangeBy(Function)
public Iterator<Queue<T>> grouped(int size)
Traversable
Traversable
into fixed size blocks.
Let length be the length of this Iterable. Then grouped is defined as follows:
this.isEmpty()
, the resulting Iterator
is empty.size <= length
, the resulting Iterator
will contain length / size
blocks of size
size
and maybe a non-empty block of size length % size
, if there are remaining elements.size > length
, the resulting Iterator
will contain one block of size length
.
[].grouped(1) = []
[].grouped(0) throws
[].grouped(-1) throws
[1,2,3,4].grouped(2) = [[1,2],[3,4]]
[1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]]
[1,2,3,4].grouped(5) = [[1,2,3,4]]
Please note that grouped(int)
is a special case of Traversable.sliding(int, int), i.e.
grouped(size)
is the same as sliding(size, size)
.public boolean hasDefiniteSize()
Traversable
This method should be implemented by classes only, i.e. not by interfaces.
hasDefiniteSize
in interface Traversable<T>
public T head()
Traversable
head
in interface Traversable<T>
public int indexOf(T element, int from)
Seq
public Queue<T> insert(int index, T element)
Seq
public Queue<T> insertAll(int index, Iterable<? extends T> elements)
Seq
public Queue<T> intersperse(T element)
Seq
intersperse
in interface LinearSeq<T>
intersperse
in interface Seq<T>
element
- An element.public boolean isAsync()
Queue
is computed synchronously.public boolean isEmpty()
Traversable
public boolean isLazy()
Queue
is computed eagerly.public boolean isTraversableAgain()
Traversable
This method should be implemented by classes only, i.e. not by interfaces.
isTraversableAgain
in interface Traversable<T>
public T last()
Traversable
last
in interface Traversable<T>
public int lastIndexOf(T element, int end)
Seq
lastIndexOf
in interface Seq<T>
element
- an elementend
- the end indexpublic int length()
Traversable
Same as Traversable.size()
.
length
in interface Traversable<T>
public <U> Queue<U> map(Function<? super T,? extends U> mapper)
Traversable
Traversable
to elements of a new type preserving their order, if any.public Queue<T> orElse(Iterable<? extends T> other)
Traversable
Traversable
if it is nonempty, otherwise return the alternative.public Queue<T> orElse(Supplier<? extends Iterable<? extends T>> supplier)
Traversable
Traversable
if it is nonempty, otherwise return the result of evaluating supplier.public Queue<T> padTo(int length, T element)
Seq
Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
padTo
in interface LinearSeq<T>
padTo
in interface Seq<T>
length
- the target lengthelement
- the padding elementelement
so that the resulting sequence has a length of at least length
.public Queue<T> leftPadTo(int length, T element)
Seq
Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
leftPadTo
in interface Seq<T>
length
- the target lengthelement
- the padding elementelement
so that the resulting sequence has a length of at least length
.public Queue<T> patch(int from, Iterable<? extends T> that, int replaced)
Seq
public Tuple2<Queue<T>,Queue<T>> partition(Predicate<? super T> predicate)
Traversable
Traversable
by splitting this elements in two in distinct traversables
according to a predicate.partition
in interface LinearSeq<T>
partition
in interface Seq<T>
partition
in interface Traversable<T>
predicate
- A predicate which classifies an element if it is in the first or the second traversable.Traversable
contains all elements that satisfy the given predicate
, the second Traversable
contains all elements that don't. The original order of elements is preserved.public Queue<Queue<T>> permutations()
Seq
Example:
[].permutations() = []
[1,2,3].permutations() = [
[1,2,3],
[1,3,2],
[2,1,3],
[2,3,1],
[3,1,2],
[3,2,1]
]
permutations
in interface LinearSeq<T>
permutations
in interface Seq<T>
public Queue<T> prepend(T element)
Seq
public Queue<T> prependAll(Iterable<? extends T> elements)
Seq
prependAll
in interface LinearSeq<T>
prependAll
in interface Seq<T>
elements
- An Iterable of elementspublic Queue<T> remove(T element)
Seq
public Queue<T> removeFirst(Predicate<T> predicate)
Seq
removeFirst
in interface LinearSeq<T>
removeFirst
in interface Seq<T>
predicate
- an predicatepublic Queue<T> removeLast(Predicate<T> predicate)
Seq
removeLast
in interface LinearSeq<T>
removeLast
in interface Seq<T>
predicate
- an predicatepublic Queue<T> removeAt(int index)
Seq
public Queue<T> removeAll(T element)
Seq
public Queue<T> replace(T currentElement, T newElement)
Traversable
replace
in interface LinearSeq<T>
replace
in interface Seq<T>
replace
in interface Traversable<T>
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.public Queue<T> replaceAll(T currentElement, T newElement)
Traversable
replaceAll
in interface LinearSeq<T>
replaceAll
in interface Seq<T>
replaceAll
in interface Traversable<T>
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.public Queue<T> reverse()
Seq
public Queue<T> rotateLeft(int n)
Seq
// = List(3, 4, 5, 1, 2)
List.of(1, 2, 3, 4, 5).rotateLeft(2);
rotateLeft
in interface LinearSeq<T>
rotateLeft
in interface Seq<T>
n
- distance of left rotationpublic Queue<T> rotateRight(int n)
Seq
// = List(4, 5, 1, 2, 3)
List.of(1, 2, 3, 4, 5).rotateRight(2);
rotateRight
in interface LinearSeq<T>
rotateRight
in interface Seq<T>
n
- distance of right rotationpublic Queue<T> scan(T zero, BiFunction<? super T,? super T,? extends T> operation)
Traversable
scan
in interface LinearSeq<T>
scan
in interface Seq<T>
scan
in interface Traversable<T>
zero
- neutral element for the operator opoperation
- the associative operator for the scanpublic <U> Queue<U> scanLeft(U zero, BiFunction<? super U,? super T,? extends U> operation)
Traversable
scanLeft
in interface LinearSeq<T>
scanLeft
in interface Seq<T>
scanLeft
in interface Traversable<T>
U
- the type of the elements in the resulting collectionzero
- the initial valueoperation
- the binary operator applied to the intermediate result and the elementpublic <U> Queue<U> scanRight(U zero, BiFunction<? super T,? super U,? extends U> operation)
Traversable
scanRight
in interface LinearSeq<T>
scanRight
in interface Seq<T>
scanRight
in interface Traversable<T>
U
- the type of the elements in the resulting collectionzero
- the initial valueoperation
- the binary operator applied to the intermediate result and the elementpublic Queue<T> shuffle()
Seq
public Queue<T> slice(int beginIndex, int endIndex)
Seq
beginIndex
and extends to the element at index endIndex - 1
.
Examples:
List.of(1, 2, 3, 4).slice(1, 3); // = (2, 3)
List.of(1, 2, 3, 4).slice(0, 4); // = (1, 2, 3, 4)
List.of(1, 2, 3, 4).slice(2, 2); // = ()
List.of(1, 2).slice(1, 0); // = ()
List.of(1, 2).slice(-10, 10); // = (1, 2)
See also Seq.subSequence(int, int)
which throws in some cases instead of returning a sequence.public Iterator<Queue<T>> slideBy(Function<? super T,?> classifier)
Traversable
Traversable
.
Each window contains elements with the same class, as determined by classifier
. Two consecutive
values in this Traversable
will be in the same window only if classifier
returns equal
values for them. Otherwise, the values will constitute the last element of the previous window and the
first element of the next window.
Examples:
[].slideBy(Function.identity()) = []
[1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]]
[1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
public Iterator<Queue<T>> sliding(int size)
Traversable
size
and step size 1 over this Traversable
by calling
Traversable.sliding(int, int)
.public Iterator<Queue<T>> sliding(int size, int step)
Traversable
size
and step
size over this Traversable
.
Examples:
[].sliding(1,1) = []
[1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]]
[1,2,3,4,5].sliding(2,4) = [[1,2],[5]]
[1,2,3,4,5].sliding(2,5) = [[1,2]]
[1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]]
public Queue<T> sorted()
Seq
Comparable
, a java.lang.ClassCastException
may be thrown.public Queue<T> sorted(Comparator<? super T> comparator)
Seq
Comparator
. If this elements are not
Comparable
, a java.lang.ClassCastException
may be thrown.public <U extends Comparable<? super U>> Queue<T> sortBy(Function<? super T,? extends U> mapper)
Seq
mapper
.public <U> Queue<T> sortBy(Comparator<? super U> comparator, Function<? super T,? extends U> mapper)
Seq
mapper
.public Tuple2<Queue<T>,Queue<T>> span(Predicate<? super T> predicate)
Traversable
predicate
and the second element is the remainder.public Tuple2<Queue<T>,Queue<T>> splitAt(int n)
Seq
splitAt(n)
is equivalent to
Tuple.of(take(n), drop(n))
.public Tuple2<Queue<T>,Queue<T>> splitAt(Predicate<? super T> predicate)
Seq
Predicate
, e.g. Tuple(init, element+tail).public Tuple2<Queue<T>,Queue<T>> splitAtInclusive(Predicate<? super T> predicate)
Seq
Predicate
, e.g. Tuple(init+element, tail).splitAtInclusive
in interface Seq<T>
predicate
- An predicateTuple
containing divided sequencespublic boolean startsWith(Iterable<? extends T> that, int offset)
Seq
Note: If the both the receiver object this and the argument that are infinite sequences this method may not terminate.
startsWith
in interface Seq<T>
that
- the sequence to testoffset
- the index where the sequence is searched.public Queue<T> subSequence(int beginIndex)
Seq
beginIndex
and extends to the end of this Seq.
Examples:
List.of(1, 2).subSequence(0); // = (1, 2)
List.of(1, 2).subSequence(1); // = (2)
List.of(1, 2).subSequence(2); // = ()
List.of(1, 2).subSequence(10); // throws IndexOutOfBoundsException
List.of(1, 2).subSequence(-10); // throws IndexOutOfBoundsException
See also Seq.drop(int)
which is similar but does not throw.subSequence
in interface LinearSeq<T>
subSequence
in interface Seq<T>
beginIndex
- the beginning index, inclusivepublic Queue<T> subSequence(int beginIndex, int endIndex)
Seq
beginIndex
and extends to the element at index endIndex - 1
.
Examples:
List.of(1, 2, 3, 4).subSequence(1, 3); // = (2, 3)
List.of(1, 2, 3, 4).subSequence(0, 4); // = (1, 2, 3, 4)
List.of(1, 2, 3, 4).subSequence(2, 2); // = ()
List.of(1, 2).subSequence(1, 0); // throws IndexOutOfBoundsException
List.of(1, 2).subSequence(-10, 1); // throws IndexOutOfBoundsException
List.of(1, 2).subSequence(0, 10); // throws IndexOutOfBoundsException
See also Seq.slice(int, int)
which returns an empty sequence instead of throwing.subSequence
in interface LinearSeq<T>
subSequence
in interface Seq<T>
beginIndex
- the beginning index, inclusiveendIndex
- the end index, exclusivepublic Queue<T> take(int n)
Traversable
The result is equivalent to sublist(0, max(0, min(length(), n)))
but does not throw if n < 0
or
n > length()
.
In the case of n < 0
the empty instance is returned, in the case of n > length()
this is returned.
public Queue<T> takeUntil(Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as takeWhile(predicate.negate())
. It is intended to be used with
method references, which cannot be negated directly.
takeUntil
in interface LinearSeq<T>
takeUntil
in interface Seq<T>
takeUntil
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Queue<T> takeRight(int n)
Traversable
The result is equivalent to sublist(max(0, min(length(), length() - n)), n)
, i.e. takeRight will not
throw if n < 0
or n > length()
.
In the case of n < 0
the empty instance is returned, in the case of n > length()
this is returned.
takeRight
in interface LinearSeq<T>
takeRight
in interface Seq<T>
takeRight
in interface Traversable<T>
n
- The number of elements to take.public Queue<T> takeRightUntil(Predicate<? super T> predicate)
Seq
takeRightUntil
in interface LinearSeq<T>
takeRightUntil
in interface Seq<T>
predicate
- A condition tested subsequently for this elements, starting from the end.public Queue<T> takeRightWhile(Predicate<? super T> predicate)
Seq
Note: This is essentially the same as takeRightUntil(predicate.negate())
.
It is intended to be used with method references, which cannot be negated directly.
takeRightWhile
in interface LinearSeq<T>
takeRightWhile
in interface Seq<T>
predicate
- A condition tested subsequently for this elements, starting from the end.public <U> U transform(Function<? super Queue<T>,? extends U> f)
Queue
.U
- Type of transformation resultf
- A transformationU
NullPointerException
- if f
is nullpublic <T1,T2> Tuple2<Queue<T1>,Queue<T2>> unzip(Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Traversable
unzip
in interface LinearSeq<T>
unzip
in interface Seq<T>
unzip
in interface Traversable<T>
T1
- 1st element type of a pair returned by unzipperT2
- 2nd element type of a pair returned by unzipperunzipper
- a function which converts elements of this to pairspublic <T1,T2,T3> Tuple3<Queue<T1>,Queue<T2>,Queue<T3>> unzip3(Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Traversable
unzip3
in interface Seq<T>
unzip3
in interface Traversable<T>
T1
- 1st element type of a triplet returned by unzipperT2
- 2nd element type of a triplet returned by unzipperT3
- 3rd element type of a triplet returned by unzipperunzipper
- a function which converts elements of this to pairspublic Queue<T> update(int index, T element)
Seq
public Queue<T> update(int index, Function<? super T,? extends T> updater)
Seq
public <U> Queue<Tuple2<T,U>> zip(Iterable<? extends U> that)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zip
in interface LinearSeq<T>
zip
in interface Seq<T>
zip
in interface Traversable<T>
U
- The type of the second half of the returned pairs.that
- The Iterable providing the second half of each result pair.that
iterable.public <U,R> Queue<R> zipWith(Iterable<? extends U> that, BiFunction<? super T,? super U,? extends R> mapper)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zipWith
in interface LinearSeq<T>
zipWith
in interface Seq<T>
zipWith
in interface Traversable<T>
U
- The type of the second parameter of the mapper.R
- The type of the mapped elements.that
- The Iterable providing the second parameter of the mapper.mapper
- a mapper.that
iterable.public <U> Queue<Tuple2<T,U>> zipAll(Iterable<? extends U> that, T thisElem, U thatElem)
Traversable
The length of the returned traversable is the maximum of the lengths of this traversable and that
iterable.
Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
zipAll
in interface LinearSeq<T>
zipAll
in interface Seq<T>
zipAll
in interface Traversable<T>
U
- The type of the second half of the returned pairs.that
- The Iterable providing the second half of each result pair.thisElem
- The element to be used to fill up the result if this traversable is shorter than that.thatElem
- The element to be used to fill up the result if that is shorter than this traversable.public Queue<Tuple2<T,Integer>> zipWithIndex()
Traversable
zipWithIndex
in interface LinearSeq<T>
zipWithIndex
in interface Seq<T>
zipWithIndex
in interface Traversable<T>
public <U> Queue<U> zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zipWithIndex
in interface LinearSeq<T>
zipWithIndex
in interface Seq<T>
zipWithIndex
in interface Traversable<T>
U
- The type of the mapped elements.mapper
- a mapper.that
iterable.public String stringPrefix()
Value
stringPrefix
in interface Value<T>
public boolean equals(Object o)
Traversable
Notes:
public int hashCode()
Traversable
int hash = 1;
for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }
Collections with arbitrary iteration order are hashed in a way such that the hash of a fixed number of elements is independent of their iteration order.
int hash = 1;
for (T t : this) { hash += Objects.hashCode(t); }
Please note that the particular hashing algorithms may change in a future version of Vavr.
public final class Hashed<K> {
private final K key;
private final Lazy<Integer> hashCode;
public Hashed(K key) {
this.key = key;
this.hashCode = Lazy.of(() -> Objects.hashCode(key));
}
public K key() {
return key;
}
@Override
public boolean equals(Object o) {
if (o == key) {
return true;
} else if (key != null && o instanceof Hashed) {
final Hashed that = (Hashed) o;
return key.equals(that.key);
} else {
return false;
}
}
@Override
public int hashCode() {
return hashCode.get();
}
@Override
public String toString() {
return "Hashed(" + (key == null ? "null" : key.toString()) + ")";
}
}
public Tuple2<T,Q> dequeue()
NoSuchElementException
- if this Queue is emptypublic Option<Tuple2<T,Q>> dequeueOption()
None
if this Queue is empty, otherwise Some
Tuple
containing the first element and the remaining elements of this Queuepublic Q enqueue(T... elements)
elements
- Elements, may be emptyQueue
instance, containing the new elementsNullPointerException
- if elements is nullpublic T peek()
NoSuchElementException
- if this Queue is emptypublic Option<T> peekOption()
None
if this Queue is empty, otherwise a Some
containing the first elementpublic Q dropUntil(Predicate<? super T> predicate)
Traversable
dropUntil
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Option<Q> initOption()
Option
.initOption
in interface Traversable<T>
Some(Q)
or None
if this is empty.public Option<Q> tailOption()
Traversable
Option
.tailOption
in interface Traversable<T>
Some(traversable)
or None
if this is empty.public Q retainAll(Iterable<? extends T> elements)
Traversable
retainAll
in interface Traversable<T>
elements
- Elements to be kept.public Q removeAll(Iterable<? extends T> elements)
@Deprecated public Q removeAll(Predicate<? super T> predicate)
public Q reject(Predicate<? super T> predicate)
Traversable
The default implementation is equivalent to
filter(predicate.negate()
reject
in interface Traversable<T>
predicate
- A predicatepublic Q takeWhile(Predicate<? super T> predicate)
Traversable
takeWhile
in interface Traversable<T>
predicate
- A condition tested subsequently for the contained elements.public Q peek(Consumer<? super T> action)
Value
action
on the first element if this is an eager implementation.
Performs the given action
on all elements (the first immediately, successive deferred),
if this is a lazy implementation.peek
in interface Traversable<T>
peek
in interface Value<T>
action
- The action that will be performed on the element(s).Copyright © 2020. All Rights Reserved.