T
- Component type of the Vector.public final class Vector<T> extends java.lang.Object implements IndexedSeq<T>, java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static interface |
Lambda.Memoized
Zero Abstract Method (ZAM) interface for marking functions as memoized using intersection types.
|
Modifier and Type | Method and Description |
---|---|
Vector<T> |
append(T element)
Appends an element to this.
|
Vector<T> |
appendAll(java.lang.Iterable<? extends T> iterable)
Appends all given elements to this.
|
java.util.List<T> |
asJava()
Creates an immutable
List view on top of this Seq ,
i.e. |
Vector<T> |
asJava(java.util.function.Consumer<? super java.util.List<T>> action)
Creates an immutable
List view on top of this Seq
that is passed to the given action . |
java.util.List<T> |
asJavaMutable()
Creates a mutable
List view on top of this Seq ,
i.e. |
Vector<T> |
asJavaMutable(java.util.function.Consumer<? super java.util.List<T>> action)
Creates a mutable
List view on top of this Seq
that is passed to the given action . |
<R> Vector<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> java.util.stream.Collector<T,java.util.ArrayList<T>,Vector<T>> |
collector()
Returns a
Collector which may be used in conjunction with
Stream.collect(Collector) to obtain a Vector . |
Vector<Vector<T>> |
combinations()
Returns the union of all combinations from k = 0 to length().
|
Vector<Vector<T>> |
combinations(int k)
Returns the k-combination of this traversable, i.e.
|
Iterator<Vector<T>> |
crossProduct(int power)
Calculates the n-ary cartesian power (or cross product or simply product) of this.
|
Vector<T> |
distinct()
Returns a new version of this which contains no duplicates.
|
Vector<T> |
distinctBy(java.util.Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.
|
<U> Vector<T> |
distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.
|
Vector<T> |
drop(int n)
Drops the first n elements of this or all elements, if this length < n.
|
Vector<T> |
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.
|
Vector<T> |
dropRightUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element, starting from the end.
|
Vector<T> |
dropRightWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element, starting from the end.
|
Vector<T> |
dropUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.
|
Vector<T> |
dropWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.
|
static <T> Vector<T> |
empty()
Returns the empty Vector.
|
boolean |
equals(java.lang.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> Vector<T> |
fill(int n,
java.util.function.Supplier<? extends T> s)
Returns a Vector containing
n values supplied by a given Supplier s . |
Vector<T> |
filter(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.
|
<U> Vector<U> |
flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
FlatMaps this Traversable.
|
T |
get(int index)
Returns the element at the specified index.
|
<C> Map<C,Vector<T>> |
groupBy(java.util.function.Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.
|
Iterator<Vector<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.
|
Vector<T> |
init()
Dual of Traversable.tail(), returning all elements except the last.
|
Option<Vector<T>> |
initOption()
Dual of Traversable.tailOption(), returning all elements except the last as
Option . |
Vector<T> |
insert(int index,
T element)
Inserts the given element at the specified index.
|
Vector<T> |
insertAll(int index,
java.lang.Iterable<? extends T> elements)
Inserts the given elements at the specified index.
|
Vector<T> |
intersperse(T element)
Inserts an element between all elements of this Traversable.
|
boolean |
isAsync()
A
Vector is computed synchronously. |
boolean |
isEmpty()
Checks if this Traversable is empty.
|
boolean |
isLazy()
A
Vector is computed eagerly. |
default boolean |
isMemoized()
Checks if this function is memoizing (= caching) computed values.
|
boolean |
isTraversableAgain()
Checks if this Traversable can be repeatedly traversed.
|
Iterator<T> |
iterator()
An iterator by means of head() and tail().
|
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.
|
Vector<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> Vector<U> |
map(java.util.function.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> Vector<T> |
narrow(Vector<? extends T> vector)
Narrows a widened
Vector<? extends T> to Vector<T>
by performing a type-safe cast. |
static <T> Vector<T> |
of(T... elements)
Creates a Vector of the given elements.
|
static <T> Vector<T> |
of(T element)
Returns a singleton
Vector , i.e. |
static Vector<java.lang.Boolean> |
ofAll(boolean... elements)
Creates a Vector from boolean values.
|
static Vector<java.lang.Byte> |
ofAll(byte... elements)
Creates a Vector from byte values.
|
static Vector<java.lang.Character> |
ofAll(char... elements)
Creates a Vector from char values.
|
static Vector<java.lang.Double> |
ofAll(double... elements)
Creates a Vector from double values.
|
static Vector<java.lang.Float> |
ofAll(float... elements)
Creates a Vector from float values.
|
static Vector<java.lang.Integer> |
ofAll(int... elements)
Creates a Vector from int values.
|
static <T> Vector<T> |
ofAll(java.lang.Iterable<? extends T> iterable)
Creates a Vector of the given elements.
|
static Vector<java.lang.Long> |
ofAll(long... elements)
Creates a Vector from long values.
|
static Vector<java.lang.Short> |
ofAll(short... elements)
Creates a Vector from short values.
|
static <T> Vector<T> |
ofAll(java.util.stream.Stream<? extends T> javaStream)
Creates a Vector that contains the elements of the given
Stream . |
Vector<T> |
orElse(java.lang.Iterable<? extends T> other)
Returns this
Traversable if it is nonempty, otherwise return the alternative. |
Vector<T> |
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Returns this
Traversable if it is nonempty, otherwise return the result of evaluating supplier. |
Vector<T> |
padTo(int length,
T element)
A copy of this sequence with an element appended until a given target length is reached.
|
Tuple2<Vector<T>,Vector<T>> |
partition(java.util.function.Predicate<? super T> predicate)
Creates a partition of this
Traversable by splitting this elements in two in distinct tarversables
according to a predicate. |
Vector<T> |
patch(int from,
java.lang.Iterable<? extends T> that,
int replaced)
Produces a new list where a slice of elements in this list is replaced by another sequence.
|
Vector<T> |
peek(java.util.function.Consumer<? super T> action)
Performs the given
action on the first element if this is an eager implementation. |
Vector<Vector<T>> |
permutations()
Computes all unique permutations.
|
Vector<T> |
prepend(T element)
Prepends an element to this.
|
Vector<T> |
prependAll(java.lang.Iterable<? extends T> iterable)
Prepends all given elements to this.
|
static Vector<java.lang.Character> |
range(char from,
char toExclusive) |
static Vector<java.lang.Integer> |
range(int from,
int toExclusive)
Creates a Vector of int numbers starting from
from , extending to toExclusive - 1 . |
static Vector<java.lang.Long> |
range(long from,
long toExclusive)
Creates a Vector of long numbers starting from
from , extending to toExclusive - 1 . |
static Vector<java.lang.Character> |
rangeBy(char from,
char toExclusive,
int step) |
static Vector<java.lang.Double> |
rangeBy(double from,
double toExclusive,
double step) |
static Vector<java.lang.Integer> |
rangeBy(int from,
int toExclusive,
int step)
Creates a Vector of int numbers starting from
from , extending to toExclusive - 1 ,
with step . |
static Vector<java.lang.Long> |
rangeBy(long from,
long toExclusive,
long step)
Creates a Vector of long numbers starting from
from , extending to toExclusive - 1 ,
with step . |
static Vector<java.lang.Character> |
rangeClosed(char from,
char toInclusive) |
static Vector<java.lang.Integer> |
rangeClosed(int from,
int toInclusive)
Creates a Vector of int numbers starting from
from , extending to toInclusive . |
static Vector<java.lang.Long> |
rangeClosed(long from,
long toInclusive)
Creates a Vector of long numbers starting from
from , extending to toInclusive . |
static Vector<java.lang.Character> |
rangeClosedBy(char from,
char toInclusive,
int step) |
static Vector<java.lang.Double> |
rangeClosedBy(double from,
double toInclusive,
double step) |
static Vector<java.lang.Integer> |
rangeClosedBy(int from,
int toInclusive,
int step)
Creates a Vector of int numbers starting from
from , extending to toInclusive ,
with step . |
static Vector<java.lang.Long> |
rangeClosedBy(long from,
long toInclusive,
long step)
Creates a Vector of long numbers starting from
from , extending to toInclusive ,
with step . |
Vector<T> |
remove(T element)
Removes the first occurrence of the given element.
|
Vector<T> |
removeAll(java.lang.Iterable<? extends T> elements)
Removes all occurrences of the given elements.
|
Vector<T> |
removeAll(java.util.function.Predicate<? super T> predicate)
Returns a new Seq consisting of all elements which do not satisfy the given predicate.
|
Vector<T> |
removeAll(T element)
Removes all occurrences of the given element.
|
Vector<T> |
removeAt(int index)
Removes the element at the specified position in this sequence.
|
Vector<T> |
removeFirst(java.util.function.Predicate<T> predicate)
Removes the first occurrence that satisfy predicate
|
Vector<T> |
removeLast(java.util.function.Predicate<T> predicate)
Removes the last occurrence that satisfy predicate
|
Vector<T> |
replace(T currentElement,
T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.
|
Vector<T> |
replaceAll(T currentElement,
T newElement)
Replaces all occurrences of the given currentElement with newElement.
|
Vector<T> |
retainAll(java.lang.Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.
|
Vector<T> |
reverse()
Reverses the order of elements.
|
Vector<T> |
scan(T zero,
java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Computes a prefix scan of the elements of the collection.
|
<U> Vector<U> |
scanLeft(U zero,
java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going left to right.
|
<U> Vector<U> |
scanRight(U zero,
java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going right to left.
|
Vector<T> |
shuffle()
Randomize the order of the elements in the current sequence.
|
Vector<T> |
slice(int beginIndex,
int endIndex)
Returns a Seq that is a slice of this.
|
Iterator<Vector<T>> |
slideBy(java.util.function.Function<? super T,?> classifier)
Slides a non-overlapping window of a variable size over this
Traversable . |
Iterator<Vector<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<Vector<T>> |
sliding(int size,
int step)
Slides a window of a specific
size and step size over this Traversable . |
<U> Vector<T> |
sortBy(java.util.Comparator<? super U> comparator,
java.util.function.Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper . |
<U extends java.lang.Comparable<? super U>> |
sortBy(java.util.function.Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper . |
Vector<T> |
sorted()
Sorts this elements according to their natural order.
|
Vector<T> |
sorted(java.util.Comparator<? super T> comparator)
Sorts this elements according to the provided
Comparator . |
Tuple2<Vector<T>,Vector<T>> |
span(java.util.function.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<Vector<T>,Vector<T>> |
splitAt(int n)
Splits a Seq at the specified index.
|
Tuple2<Vector<T>,Vector<T>> |
splitAt(java.util.function.Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate , e.g. |
Tuple2<Vector<T>,Vector<T>> |
splitAtInclusive(java.util.function.Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate , e.g. |
java.lang.String |
stringPrefix()
Returns the name of this Value type, which is used by toString().
|
Vector<T> |
subSequence(int beginIndex)
Returns a Seq that is a subsequence of this.
|
Vector<T> |
subSequence(int beginIndex,
int endIndex)
Returns a Seq that is a subsequence of this.
|
static <T> Vector<T> |
tabulate(int n,
java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a Vector containing
n values of a given Function f
over a range of integer values from 0 to n - 1 . |
Vector<T> |
tail()
Drops the first element of a non-empty Traversable.
|
Option<Vector<T>> |
tailOption()
Drops the first element of a non-empty Traversable and returns an
Option . |
Vector<T> |
take(int n)
Takes the first n elements of this or all elements, if this length < n.
|
Vector<T> |
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.
|
Vector<T> |
takeUntil(java.util.function.Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.
|
Vector<T> |
takeWhile(java.util.function.Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.
|
java.lang.String |
toString()
Clarifies that values have a proper toString() method implemented.
|
<U> U |
transform(java.util.function.Function<? super Vector<T>,? extends U> f)
Transforms this
Vector . |
static <T> Vector<Vector<T>> |
transpose(Vector<Vector<T>> matrix)
Transposes the rows and columns of a
Vector matrix. |
static <T> Vector<T> |
unfold(T seed,
java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
Creates a Vector from a seed value and a function.
|
static <T,U> Vector<U> |
unfoldLeft(T seed,
java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
Creates a Vector from a seed value and a function.
|
static <T,U> Vector<U> |
unfoldRight(T seed,
java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
Creates a Vector from a seed value and a function.
|
<T1,T2> Tuple2<Vector<T1>,Vector<T2>> |
unzip(java.util.function.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<Vector<T1>,Vector<T2>,Vector<T3>> |
unzip3(java.util.function.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.
|
Vector<T> |
update(int index,
java.util.function.Function<? super T,? extends T> updater)
Updates the given element at the specified index using the specified function.
|
Vector<T> |
update(int index,
T element)
Updates the given element at the specified index.
|
<U> Vector<Tuple2<T,U>> |
zip(java.lang.Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining
corresponding elements in pairs.
|
<U> Vector<Tuple2<T,U>> |
zipAll(java.lang.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> Vector<R> |
zipWith(java.lang.Iterable<? extends U> that,
java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
|
Vector<Tuple2<T,java.lang.Integer>> |
zipWithIndex()
Zips this traversable with its indices.
|
<U> Vector<U> |
zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.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
endsWith, indexOfSlice, indexWhere, last, lastIndexOfSlice, lastIndexWhere, narrow, reverseIterator, search, search, segmentLength, startsWith
apply, containsSlice, crossProduct, crossProduct, 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, get, headOption, isDistinct, isOrdered, isSingleValued, 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, 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, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
public static <T> Vector<T> empty()
T
- Component type.public static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,Vector<T>> collector()
Collector
which may be used in conjunction with
Stream.collect(Collector)
to obtain a Vector
.T
- Component type of the Vector.public static <T> Vector<T> narrow(Vector<? extends T> vector)
Vector<? extends T>
to Vector<T>
by performing a type-safe cast. This is eligible because immutable/read-only
collections are covariant.T
- Component type of the Vector
.vector
- An Vector
.vector
instance as narrowed type Vector<T>
.public static <T> Vector<T> of(T element)
Vector
, i.e. a Vector
of one element.@SafeVarargs public static <T> Vector<T> of(T... elements)
T
- Component type of the Vector.elements
- Zero or more elements.java.lang.NullPointerException
- if elements
is nullpublic static <T> Vector<T> tabulate(int n, java.util.function.Function<? super java.lang.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 Vectorn
- The number of elements in the Vectorf
- The Function computing element valuesf(0),f(1), ..., f(n - 1)
java.lang.NullPointerException
- if f
is nullpublic static <T> Vector<T> fill(int n, java.util.function.Supplier<? extends T> s)
n
values supplied by a given Supplier s
.T
- Component type of the Vectorn
- The number of elements in the Vectors
- The Supplier computing element valuesn
, where each element contains the result supplied by s
.java.lang.NullPointerException
- if s
is nullpublic static <T> Vector<T> ofAll(java.lang.Iterable<? extends T> iterable)
The resulting vector has the same iteration order as the given iterable of elements if the iteration order of the elements is stable.
T
- Component type of the Vector.iterable
- An Iterable of elements.java.lang.NullPointerException
- if elements
is nullpublic static <T> Vector<T> ofAll(java.util.stream.Stream<? extends T> javaStream)
Stream
.T
- Component type of the Stream.javaStream
- A Stream
public static Vector<java.lang.Boolean> ofAll(boolean... elements)
elements
- boolean valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Byte> ofAll(byte... elements)
elements
- byte valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Character> ofAll(char... elements)
elements
- char valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Double> ofAll(double... elements)
elements
- double valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Float> ofAll(float... elements)
elements
- float valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Integer> ofAll(int... elements)
elements
- int valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Long> ofAll(long... elements)
elements
- long valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Short> ofAll(short... elements)
elements
- short valuesjava.lang.NullPointerException
- if elements is nullpublic static Vector<java.lang.Character> range(char from, char toExclusive)
public static Vector<java.lang.Character> rangeBy(char from, char toExclusive, int step)
@GwtIncompatible public static Vector<java.lang.Double> rangeBy(double from, double toExclusive, double step)
public static Vector<java.lang.Integer> range(int from, int toExclusive)
from
, extending to toExclusive - 1
.
Examples:
Vector.range(0, 0) // = Vector()
Vector.range(2, 0) // = Vector()
Vector.range(-2, 2) // = Vector(-2, -1, 0, 1)
from
- the first numbertoExclusive
- the last number + 1from >= toExclusive
public static Vector<java.lang.Integer> rangeBy(int from, int toExclusive, int step)
from
, extending to toExclusive - 1
,
with step
.
Examples:
Vector.rangeBy(1, 3, 1) // = Vector(1, 2)
Vector.rangeBy(1, 4, 2) // = Vector(1, 3)
Vector.rangeBy(4, 1, -2) // = Vector(4, 2)
Vector.rangeBy(4, 1, 2) // = Vector()
from
- the first numbertoExclusive
- the last number + 1step
- the stepfrom >= toInclusive
and step > 0
orfrom <= toInclusive
and step < 0
java.lang.IllegalArgumentException
- if step
is zeropublic static Vector<java.lang.Long> range(long from, long toExclusive)
from
, extending to toExclusive - 1
.
Examples:
Vector.range(0L, 0L) // = Vector()
Vector.range(2L, 0L) // = Vector()
Vector.range(-2L, 2L) // = Vector(-2L, -1L, 0L, 1L)
from
- the first numbertoExclusive
- the last number + 1from >= toExclusive
public static Vector<java.lang.Long> rangeBy(long from, long toExclusive, long step)
from
, extending to toExclusive - 1
,
with step
.
Examples:
Vector.rangeBy(1L, 3L, 1L) // = Vector(1L, 2L)
Vector.rangeBy(1L, 4L, 2L) // = Vector(1L, 3L)
Vector.rangeBy(4L, 1L, -2L) // = Vector(4L, 2L)
Vector.rangeBy(4L, 1L, 2L) // = Vector()
from
- the first numbertoExclusive
- the last number + 1step
- the stepfrom >= toInclusive
and step > 0
orfrom <= toInclusive
and step < 0
java.lang.IllegalArgumentException
- if step
is zeropublic static Vector<java.lang.Character> rangeClosed(char from, char toInclusive)
public static Vector<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
@GwtIncompatible public static Vector<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
public static Vector<java.lang.Integer> rangeClosed(int from, int toInclusive)
from
, extending to toInclusive
.
Examples:
Vector.rangeClosed(0, 0) // = Vector(0)
Vector.rangeClosed(2, 0) // = Vector()
Vector.rangeClosed(-2, 2) // = Vector(-2, -1, 0, 1, 2)
from
- the first numbertoInclusive
- the last numberfrom > toInclusive
public static Vector<java.lang.Integer> rangeClosedBy(int from, int toInclusive, int step)
from
, extending to toInclusive
,
with step
.
Examples:
Vector.rangeClosedBy(1, 3, 1) // = Vector(1, 2, 3)
Vector.rangeClosedBy(1, 4, 2) // = Vector(1, 3)
Vector.rangeClosedBy(4, 1, -2) // = Vector(4, 2)
Vector.rangeClosedBy(4, 1, 2) // = Vector()
from
- the first numbertoInclusive
- the last numberstep
- the stepfrom > toInclusive
and step > 0
orfrom < toInclusive
and step < 0
java.lang.IllegalArgumentException
- if step
is zeropublic static Vector<java.lang.Long> rangeClosed(long from, long toInclusive)
from
, extending to toInclusive
.
Examples:
Vector.rangeClosed(0L, 0L) // = Vector(0L)
Vector.rangeClosed(2L, 0L) // = Vector()
Vector.rangeClosed(-2L, 2L) // = Vector(-2L, -1L, 0L, 1L, 2L)
from
- the first numbertoInclusive
- the last numberfrom > toInclusive
public static Vector<java.lang.Long> rangeClosedBy(long from, long toInclusive, long step)
from
, extending to toInclusive
,
with step
.
Examples:
Vector.rangeClosedBy(1L, 3L, 1L) // = Vector(1L, 2L, 3L)
Vector.rangeClosedBy(1L, 4L, 2L) // = Vector(1L, 3L)
Vector.rangeClosedBy(4L, 1L, -2L) // = Vector(4L, 2L)
Vector.rangeClosedBy(4L, 1L, 2L) // = Vector()
from
- the first numbertoInclusive
- the last numberstep
- the stepfrom > toInclusive
and step > 0
orfrom < toInclusive
and step < 0
java.lang.IllegalArgumentException
- if step
is zeropublic static <T> Vector<Vector<T>> transpose(Vector<Vector<T>> matrix)
Vector
matrix.T
- matrix element typematrix
- to be transposed.Vector
matrix.java.lang.IllegalArgumentException
- if the row lengths of matrix
differ.
ex: Vector.transpose(Vector(Vector(1,2,3), Vector(4,5,6))) → Vector(Vector(1,4), Vector(2,5), Vector(3,6))
public static <T,U> Vector<U> unfoldRight(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
None
when it's
done generating the Vector, otherwise Some
Tuple
of the element for the next call and the value to add to the
resulting Vector.
Example:
Vector.unfoldRight(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<>(x, x-1)));
// Vector(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 iterationjava.lang.NullPointerException
- if f
is nullpublic static <T,U> Vector<U> unfoldLeft(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
None
when it's
done generating the Vector, otherwise Some
Tuple
of the value to add to the resulting Vector and
the element for the next call.
Example:
Vector.unfoldLeft(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<>(x-1, x)));
// Vector(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 iterationjava.lang.NullPointerException
- if f
is nullpublic static <T> Vector<T> unfold(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
None
when it's
done generating the Vector, otherwise Some
Tuple
of the value to add to the resulting Vector and
the element for the next call.
Example:
Vector.unfold(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<>(x-1, x)));
// Vector(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 iterationjava.lang.NullPointerException
- if f
is nullpublic Vector<T> append(T element)
Seq
public Vector<T> appendAll(java.lang.Iterable<? extends T> iterable)
Seq
@GwtIncompatible public java.util.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.@GwtIncompatible public Vector<T> asJava(java.util.function.Consumer<? super java.util.List<T>> action)
Seq
List
view on top of this Seq
that is passed to the given action
.asJava
in interface IndexedSeq<T>
asJava
in interface Seq<T>
action
- A side-effecting unit of work that operates on an immutable java.util.List
view.Seq.asJava()
@GwtIncompatible public java.util.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 Vector<T> asJavaMutable(java.util.function.Consumer<? super java.util.List<T>> action)
Seq
List
view on top of this Seq
that is passed to the given action
.asJavaMutable
in interface IndexedSeq<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> Vector<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 IndexedSeq<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 Vector<Vector<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 IndexedSeq<T>
combinations
in interface Seq<T>
public Vector<Vector<T>> combinations(int k)
Seq
combinations
in interface IndexedSeq<T>
combinations
in interface Seq<T>
k
- Size of subsetspublic Iterator<Vector<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 IndexedSeq<T>
crossProduct
in interface Seq<T>
power
- the number of cartesian multiplicationspublic Vector<T> distinct()
Traversable
equals
.distinct
in interface IndexedSeq<T>
distinct
in interface Seq<T>
distinct
in interface Traversable<T>
Traversable
containing this elements without duplicatespublic Vector<T> distinctBy(java.util.Comparator<? super T> comparator)
Traversable
comparator
.distinctBy
in interface IndexedSeq<T>
distinctBy
in interface Seq<T>
distinctBy
in interface Traversable<T>
comparator
- A comparatorTraversable
containing this elements without duplicatespublic <U> Vector<T> distinctBy(java.util.function.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 IndexedSeq<T>
distinctBy
in interface Seq<T>
distinctBy
in interface Traversable<T>
U
- key typekeyExtractor
- A key extractorTraversable
containing this elements without duplicatespublic Vector<T> drop(int n)
Traversable
drop
in interface IndexedSeq<T>
drop
in interface Seq<T>
drop
in interface Traversable<T>
n
- The number of elements to drop.public Vector<T> dropUntil(java.util.function.Predicate<? super T> predicate)
Traversable
dropUntil
in interface IndexedSeq<T>
dropUntil
in interface Seq<T>
dropUntil
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Vector<T> dropWhile(java.util.function.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 IndexedSeq<T>
dropWhile
in interface Seq<T>
dropWhile
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Vector<T> dropRight(int n)
Traversable
dropRight
in interface IndexedSeq<T>
dropRight
in interface Seq<T>
dropRight
in interface Traversable<T>
n
- The number of elements to drop.public Vector<T> dropRightUntil(java.util.function.Predicate<? super T> predicate)
Seq
dropRightUntil
in interface IndexedSeq<T>
dropRightUntil
in interface Seq<T>
predicate
- A condition tested subsequently for this elements, starting from the end.public Vector<T> dropRightWhile(java.util.function.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 IndexedSeq<T>
dropRightWhile
in interface Seq<T>
predicate
- A condition tested subsequently for this elements, starting from the end.public Vector<T> filter(java.util.function.Predicate<? super T> predicate)
Traversable
filter
in interface IndexedSeq<T>
filter
in interface Seq<T>
filter
in interface Traversable<T>
predicate
- A predicatepublic <U> Vector<U> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Traversable
flatMap
in interface IndexedSeq<T>
flatMap
in interface Seq<T>
flatMap
in interface Traversable<T>
U
- The resulting component type.mapper
- A mapperpublic T get(int index)
Seq
public T head()
Traversable
head
in interface Traversable<T>
public <C> Map<C,Vector<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
Traversable
groupBy
in interface IndexedSeq<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<Vector<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)
.grouped
in interface IndexedSeq<T>
grouped
in interface Seq<T>
grouped
in interface Traversable<T>
size
- a positive block sizepublic boolean hasDefiniteSize()
Traversable
This method should be implemented by classes only, i.e. not by interfaces.
hasDefiniteSize
in interface Traversable<T>
public int indexOf(T element, int from)
Seq
public Vector<T> init()
Traversable
init
in interface IndexedSeq<T>
init
in interface Seq<T>
init
in interface Traversable<T>
public Option<Vector<T>> initOption()
Traversable
Option
.initOption
in interface IndexedSeq<T>
initOption
in interface Seq<T>
initOption
in interface Traversable<T>
Some(traversable)
or None
if this is empty.public Vector<T> insert(int index, T element)
Seq
public Vector<T> insertAll(int index, java.lang.Iterable<? extends T> elements)
Seq
public Vector<T> intersperse(T element)
Seq
intersperse
in interface IndexedSeq<T>
intersperse
in interface Seq<T>
element
- An element.public boolean isAsync()
Vector
is computed synchronously.public boolean isEmpty()
Traversable
public boolean isLazy()
Vector
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 Iterator<T> iterator()
Traversable
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> Vector<U> map(java.util.function.Function<? super T,? extends U> mapper)
Traversable
Traversable
to elements of a new type preserving their order, if any.public Vector<T> orElse(java.lang.Iterable<? extends T> other)
Traversable
Traversable
if it is nonempty, otherwise return the alternative.orElse
in interface IndexedSeq<T>
orElse
in interface Seq<T>
orElse
in interface Traversable<T>
other
- An alternative Traversable
Traversable
if it is nonempty, otherwise return the alternative.public Vector<T> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Traversable
Traversable
if it is nonempty, otherwise return the result of evaluating supplier.orElse
in interface IndexedSeq<T>
orElse
in interface Seq<T>
orElse
in interface Traversable<T>
supplier
- An alternative Traversable
supplierTraversable
if it is nonempty, otherwise return the result of evaluating supplier.public Vector<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 IndexedSeq<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 Vector<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 Vector<T> patch(int from, java.lang.Iterable<? extends T> that, int replaced)
Seq
public Tuple2<Vector<T>,Vector<T>> partition(java.util.function.Predicate<? super T> predicate)
Traversable
Traversable
by splitting this elements in two in distinct tarversables
according to a predicate.partition
in interface IndexedSeq<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 Vector<T> peek(java.util.function.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.public Vector<Vector<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 IndexedSeq<T>
permutations
in interface Seq<T>
public Vector<T> prepend(T element)
Seq
public Vector<T> prependAll(java.lang.Iterable<? extends T> iterable)
Seq
prependAll
in interface IndexedSeq<T>
prependAll
in interface Seq<T>
iterable
- An Iterable of elementspublic Vector<T> remove(T element)
Seq
public Vector<T> removeFirst(java.util.function.Predicate<T> predicate)
Seq
removeFirst
in interface IndexedSeq<T>
removeFirst
in interface Seq<T>
predicate
- an predicatepublic Vector<T> removeLast(java.util.function.Predicate<T> predicate)
Seq
removeLast
in interface IndexedSeq<T>
removeLast
in interface Seq<T>
predicate
- an predicatepublic Vector<T> removeAt(int index)
Seq
public Vector<T> removeAll(T element)
Seq
public Vector<T> removeAll(java.lang.Iterable<? extends T> elements)
Seq
public Vector<T> removeAll(java.util.function.Predicate<? super T> predicate)
Seq
public Vector<T> replace(T currentElement, T newElement)
Traversable
replace
in interface IndexedSeq<T>
replace
in interface Seq<T>
replace
in interface Traversable<T>
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.public Vector<T> replaceAll(T currentElement, T newElement)
Traversable
replaceAll
in interface IndexedSeq<T>
replaceAll
in interface Seq<T>
replaceAll
in interface Traversable<T>
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.public Vector<T> retainAll(java.lang.Iterable<? extends T> elements)
Traversable
retainAll
in interface IndexedSeq<T>
retainAll
in interface Seq<T>
retainAll
in interface Traversable<T>
elements
- Elements to be kept.public Vector<T> reverse()
Seq
public Vector<T> scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Traversable
scan
in interface IndexedSeq<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> Vector<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Traversable
scanLeft
in interface IndexedSeq<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> Vector<U> scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Traversable
scanRight
in interface IndexedSeq<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 Vector<T> shuffle()
Seq
public Vector<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<Vector<T>> slideBy(java.util.function.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]]
slideBy
in interface IndexedSeq<T>
slideBy
in interface Seq<T>
slideBy
in interface Traversable<T>
classifier
- A function which classifies elements into classespublic Iterator<Vector<T>> sliding(int size)
Traversable
size
and step size 1 over this Traversable
by calling
Traversable.sliding(int, int)
.sliding
in interface IndexedSeq<T>
sliding
in interface Seq<T>
sliding
in interface Traversable<T>
size
- a positive window sizepublic Iterator<Vector<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]]
sliding
in interface IndexedSeq<T>
sliding
in interface Seq<T>
sliding
in interface Traversable<T>
size
- a positive window sizestep
- a positive step sizepublic Vector<T> sorted()
Seq
Comparable
, a java.lang.ClassCastException
may be thrown.public Vector<T> sorted(java.util.Comparator<? super T> comparator)
Seq
Comparator
. If this elements are not
Comparable
, a java.lang.ClassCastException
may be thrown.public <U extends java.lang.Comparable<? super U>> Vector<T> sortBy(java.util.function.Function<? super T,? extends U> mapper)
Seq
mapper
.public <U> Vector<T> sortBy(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
Seq
mapper
.public Tuple2<Vector<T>,Vector<T>> span(java.util.function.Predicate<? super T> predicate)
Traversable
predicate
and the second element is the remainder.span
in interface IndexedSeq<T>
span
in interface Seq<T>
span
in interface Traversable<T>
predicate
- A predicate.Tuple
containing the longest prefix of elements that satisfy p and the remainder.public Tuple2<Vector<T>,Vector<T>> splitAt(int n)
Seq
splitAt(n)
is equivalent to
Tuple.of(take(n), drop(n))
.public Tuple2<Vector<T>,Vector<T>> splitAt(java.util.function.Predicate<? super T> predicate)
Seq
Predicate
, e.g. Tuple(init, element+tail).public Tuple2<Vector<T>,Vector<T>> splitAtInclusive(java.util.function.Predicate<? super T> predicate)
Seq
Predicate
, e.g. Tuple(init+element, tail).splitAtInclusive
in interface Seq<T>
predicate
- An predicateTuple
containing divided sequencespublic Vector<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 IndexedSeq<T>
subSequence
in interface Seq<T>
beginIndex
- the beginning index, inclusivepublic Vector<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 IndexedSeq<T>
subSequence
in interface Seq<T>
beginIndex
- the beginning index, inclusiveendIndex
- the end index, exclusivepublic Vector<T> tail()
Traversable
tail
in interface IndexedSeq<T>
tail
in interface Seq<T>
tail
in interface Traversable<T>
public Option<Vector<T>> tailOption()
Traversable
Option
.tailOption
in interface IndexedSeq<T>
tailOption
in interface Seq<T>
tailOption
in interface Traversable<T>
Some(traversable)
or None
if this is empty.public Vector<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.
take
in interface IndexedSeq<T>
take
in interface Seq<T>
take
in interface Traversable<T>
n
- The number of elements to take.public Vector<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 IndexedSeq<T>
takeRight
in interface Seq<T>
takeRight
in interface Traversable<T>
n
- The number of elements to take.public Vector<T> takeUntil(java.util.function.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 IndexedSeq<T>
takeUntil
in interface Seq<T>
takeUntil
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Vector<T> takeWhile(java.util.function.Predicate<? super T> predicate)
Traversable
takeWhile
in interface IndexedSeq<T>
takeWhile
in interface Seq<T>
takeWhile
in interface Traversable<T>
predicate
- A condition tested subsequently for the contained elements.public <U> U transform(java.util.function.Function<? super Vector<T>,? extends U> f)
Vector
.U
- Type of transformation resultf
- A transformationU
java.lang.NullPointerException
- if f
is nullpublic <T1,T2> Tuple2<Vector<T1>,Vector<T2>> unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Traversable
unzip
in interface IndexedSeq<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<Vector<T1>,Vector<T2>,Vector<T3>> unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Traversable
unzip3
in interface IndexedSeq<T>
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 Vector<T> update(int index, T element)
Seq
public Vector<T> update(int index, java.util.function.Function<? super T,? extends T> updater)
Seq
public <U> Vector<Tuple2<T,U>> zip(java.lang.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 IndexedSeq<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> Vector<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.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 IndexedSeq<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> Vector<Tuple2<T,U>> zipAll(java.lang.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 IndexedSeq<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 Vector<Tuple2<T,java.lang.Integer>> zipWithIndex()
Traversable
zipWithIndex
in interface IndexedSeq<T>
zipWithIndex
in interface Seq<T>
zipWithIndex
in interface Traversable<T>
public <U> Vector<U> zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.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 IndexedSeq<T>
zipWithIndex
in interface Seq<T>
zipWithIndex
in interface Traversable<T>
U
- The type of the mapped elements.mapper
- a mapper.that
iterable.public boolean equals(java.lang.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 java.lang.String stringPrefix()
Value
stringPrefix
in interface Value<T>
public java.lang.String toString()
Value
See Object.toString().
public boolean isMemoized()
Copyright © 2017. All Rights Reserved.