Package io.vavr.collection

Interface LinearSeq<T>

Type Parameters:

T - component type

All Superinterfaces:

Foldable<T>, Function<Integer,T>, Function1<Integer,T>, Iterable<T>, PartialFunction<Integer,T>, Seq<T>, Serializable, Traversable<T>, Value<T>

All Known Subinterfaces:

List<T>, Stream<T>

All Known Implementing Classes:

List.Cons, List.Nil, Queue, Stream.Cons, Stream.Empty

public interface LinearSeq<T>
extends Seq<T>

Interface for immutable, linear sequences.

Efficient head(), tail(), and isEmpty() methods are characteristic for linear sequences.

Author:

Daniel Dietrich

Field Summary

Fields

Modifier and Type	Field	Description
static final long	serialVersionUID

Method Summary

Modifier and Type	Method	Description
LinearSeq<T>	append(T element)	Appends an element to this.
LinearSeq<T>	appendAll(Iterable<? extends T> elements)	Appends all given elements to this.
LinearSeq<T>	asJava(Consumer<? super List<T>> action)	Creates an immutable List view on top of this Seq that is passed to the given action.
LinearSeq<T>	asJavaMutable(Consumer<? super List<T>> action)	Creates a mutable List view on top of this Seq that is passed to the given action.
default PartialFunction<Integer,T>	asPartialFunction()	Turns this Seq into a PartialFunction which is defined at a specific index, if this Seq contains at least index + 1 elements.
<R> LinearSeq<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.
LinearSeq<? extends LinearSeq<T>>	combinations()	Returns the union of all combinations from k = 0 to length().
LinearSeq<? extends LinearSeq<T>>	combinations(int k)	Returns the k-combination of this traversable, i.e. all subset of this of k distinct elements.
Iterator<? extends LinearSeq<T>>	crossProduct(int power)	Calculates the n-ary cartesian power (or cross product or simply product) of this.
LinearSeq<T>	distinct()	Returns a new version of this which contains no duplicates.
LinearSeq<T>	distinctBy(Comparator<? super T> comparator)	Returns a new version of this which contains no duplicates.
<U> LinearSeq<T>	distinctBy(Function<? super T,? extends U> keyExtractor)	Returns a new version of this which contains no duplicates.
LinearSeq<T>	drop(int n)	Drops the first n elements of this or all elements, if this length < n.
LinearSeq<T>	dropRight(int n)	Drops the last n elements of this or all elements, if this length < n.
LinearSeq<T>	dropRightUntil(Predicate<? super T> predicate)	Drops elements until the predicate holds for the current element, starting from the end.
LinearSeq<T>	dropRightWhile(Predicate<? super T> predicate)	Drops elements while the predicate holds for the current element, starting from the end.
LinearSeq<T>	dropUntil(Predicate<? super T> predicate)	Drops elements until the predicate holds for the current element.
LinearSeq<T>	dropWhile(Predicate<? super T> predicate)	Drops elements while the predicate holds for the current element.
LinearSeq<T>	filter(Predicate<? super T> predicate)	Returns a new traversable consisting of all elements which satisfy the given predicate.
<U> LinearSeq<U>	flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)	FlatMaps this Traversable.
<C> Map<C,? extends LinearSeq<T>>	groupBy(Function<? super T,? extends C> classifier)	Groups this elements by classifying the elements.
Iterator<? extends LinearSeq<T>>	grouped(int size)	Groups this Traversable into fixed size blocks.
default int	indexOfSlice(Iterable<? extends T> that, int from)	Finds first index after or at a start index where this sequence contains a given sequence as a slice.
default int	indexWhere(Predicate<? super T> predicate, int from)	Finds index of the first element satisfying some predicate after or at some start index.
LinearSeq<T>	init()	Dual of Traversable.tail(), returning all elements except the last.
Option<? extends LinearSeq<T>>	initOption()	Dual of Traversable.tailOption(), returning all elements except the last as Option.
LinearSeq<T>	insert(int index, T element)	Inserts the given element at the specified index.
LinearSeq<T>	insertAll(int index, Iterable<? extends T> elements)	Inserts the given elements at the specified index.
LinearSeq<T>	intersperse(T element)	Inserts an element between all elements of this Traversable.
default boolean	isDefinedAt(Integer index)	Deprecated.
default int	lastIndexOfSlice(Iterable<? extends T> that, int end)	Finds last index before or at a given end index where this sequence contains a given sequence as a slice.
default int	lastIndexWhere(Predicate<? super T> predicate, int end)	Finds index of last element satisfying some predicate before or at given end index.
<U> LinearSeq<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> LinearSeq<T>	narrow(LinearSeq<? extends T> linearSeq)	Narrows a widened LinearSeq<? extends T> to LinearSeq<T> by performing a type-safe cast.
LinearSeq<T>	orElse(Iterable<? extends T> other)	Returns this Traversable if it is nonempty, otherwise return the alternative.
LinearSeq<T>	orElse(Supplier<? extends Iterable<? extends T>> supplier)	Returns this Traversable if it is nonempty, otherwise return the result of evaluating supplier.
LinearSeq<T>	padTo(int length, T element)	A copy of this sequence with an element appended until a given target length is reached.
Tuple2<? extends LinearSeq<T>,? extends LinearSeq<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.
LinearSeq<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.
LinearSeq<T>	peek(Consumer<? super T> action)	Performs the given action on the first element if this is an eager implementation.
LinearSeq<? extends LinearSeq<T>>	permutations()	Computes all unique permutations.
LinearSeq<T>	prepend(T element)	Prepends an element to this.
LinearSeq<T>	prependAll(Iterable<? extends T> elements)	Prepends all given elements to this.
LinearSeq<T>	reject(Predicate<? super T> predicate)	Returns a new traversable consisting of all elements which do not satisfy the given predicate.
LinearSeq<T>	remove(T element)	Removes the first occurrence of the given element.
LinearSeq<T>	removeAll(Iterable<? extends T> elements)	Removes all occurrences of the given elements.
LinearSeq<T>	removeAll(Predicate<? super T> predicate)	Deprecated.
LinearSeq<T>	removeAll(T element)	Removes all occurrences of the given element.
LinearSeq<T>	removeAt(int index)	Removes the element at the specified position in this sequence.
LinearSeq<T>	removeFirst(Predicate<T> predicate)	Removes the first occurrence that satisfy predicate
LinearSeq<T>	removeLast(Predicate<T> predicate)	Removes the last occurrence that satisfy predicate
LinearSeq<T>	replace(T currentElement, T newElement)	Replaces the first occurrence (if exists) of the given currentElement with newElement.
LinearSeq<T>	replaceAll(T currentElement, T newElement)	Replaces all occurrences of the given currentElement with newElement.
LinearSeq<T>	retainAll(Iterable<? extends T> elements)	Keeps all occurrences of the given elements from this.
LinearSeq<T>	reverse()	Reverses the order of elements.
default Iterator<T>	reverseIterator()	An iterator yielding elements in reversed order.
LinearSeq<T>	rotateLeft(int n)	Circular rotates the elements by the specified distance to the left direction.
LinearSeq<T>	rotateRight(int n)	Circular rotates the elements by the specified distance to the right direction.
LinearSeq<T>	scan(T zero, BiFunction<? super T,? super T,? extends T> operation)	Computes a prefix scan of the elements of the collection.
<U> LinearSeq<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> LinearSeq<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.
default int	search(T element)	Searches this sequence for a specific element using a linear search.
default int	search(T element, Comparator<? super T> comparator)	Searches this sequence for a specific element using a linear search.
default int	segmentLength(Predicate<? super T> predicate, int from)	Computes length of longest segment whose elements all satisfy some predicate.
LinearSeq<T>	shuffle()	Randomize the order of the elements in the current sequence.
LinearSeq<T>	slice(int beginIndex, int endIndex)	Returns a Seq that is a slice of this.
Iterator<? extends LinearSeq<T>>	slideBy(Function<? super T,?> classifier)	Slides a non-overlapping window of a variable size over this Traversable.
Iterator<? extends LinearSeq<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<? extends LinearSeq<T>>	sliding(int size, int step)	Slides a window of a specific size and step size over this Traversable.
<U> LinearSeq<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>> LinearSeq<T>	sortBy(Function<? super T,? extends U> mapper)	Sorts this elements by comparing the elements in a different domain, using the given mapper.
LinearSeq<T>	sorted()	Sorts this elements according to their natural order.
LinearSeq<T>	sorted(Comparator<? super T> comparator)	Sorts this elements according to the provided Comparator.
Tuple2<? extends LinearSeq<T>,? extends LinearSeq<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.
LinearSeq<T>	subSequence(int beginIndex)	Returns a Seq that is a subsequence of this.
LinearSeq<T>	subSequence(int beginIndex, int endIndex)	Returns a Seq that is a subsequence of this.
LinearSeq<T>	tail()	Drops the first element of a non-empty Traversable.
Option<? extends LinearSeq<T>>	tailOption()	Drops the first element of a non-empty Traversable and returns an Option.
LinearSeq<T>	take(int n)	Takes the first n elements of this or all elements, if this length < n.
LinearSeq<T>	takeRight(int n)	Takes the last n elements of this or all elements, if this length < n.
LinearSeq<T>	takeRightUntil(Predicate<? super T> predicate)	Takes elements until the predicate holds for the current element, starting from the end.
LinearSeq<T>	takeRightWhile(Predicate<? super T> predicate)	Takes elements while the predicate holds for the current element, starting from the end.
LinearSeq<T>	takeUntil(Predicate<? super T> predicate)	Takes elements until the predicate holds for the current element.
LinearSeq<T>	takeWhile(Predicate<? super T> predicate)	Takes elements while the predicate holds for the current element.
<T1, T2> Tuple2<? extends LinearSeq<T1>,? extends LinearSeq<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.
LinearSeq<T>	update(int index, Function<? super T,? extends T> updater)	Updates the given element at the specified index using the specified function.
LinearSeq<T>	update(int index, T element)	Updates the given element at the specified index.
<U> LinearSeq<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> LinearSeq<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> LinearSeq<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.
LinearSeq<Tuple2<T,Integer>>	zipWithIndex()	Zips this traversable with its indices.
<U> LinearSeq<U>	zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)	Zips this traversable with its indices by applying mapper provided.

Methods inherited from interface io.vavr.collection.Foldable

fold, reduce, reduceOption

Methods inherited from interface io.vavr.Function1

andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupled

Methods inherited from interface io.vavr.collection.Seq

apply, asJava, asJavaMutable, containsSlice, crossProduct, crossProduct, endsWith, foldRight, get, indexOf, indexOf, indexOfOption, indexOfOption, indexOfSlice, indexOfSliceOption, indexOfSliceOption, indexWhere, indexWhereOption, indexWhereOption, isSequential, iterator, lastIndexOf, lastIndexOf, lastIndexOfOption, lastIndexOfOption, lastIndexOfSlice, lastIndexOfSliceOption, lastIndexOfSliceOption, lastIndexWhere, lastIndexWhereOption, lastIndexWhereOption, leftPadTo, lift, prefixLength, splitAt, splitAt, splitAtInclusive, startsWith, startsWith, unzip3, withDefault, withDefaultValue

Methods inherited from interface io.vavr.collection.Traversable

arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, hasDefiniteSize, hashCode, head, headOption, isDistinct, isEmpty, isOrdered, isSingleValued, isTraversableAgain, iterator, last, lastOption, length, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum

Methods inherited from interface io.vavr.Value

collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, isAsync, isLazy, out, out, stderr, stdout, stringPrefix, 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

Field Details

serialVersionUID

static final long serialVersionUID

See Also:

• Constant Field Values

Method Details

narrow

static <T> LinearSeq<T> narrow(LinearSeq<? extends T> linearSeq)

Narrows a widened LinearSeq<? extends T> to LinearSeq<T> by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.

Type Parameters:

T - Component type of the LinearSeq.

Parameters:

linearSeq - A LinearSeq.

Returns:

the given linearSeq instance as narrowed type LinearSeq<T>.

append

LinearSeq<T> append(T element)

Description copied from interface: Seq

Appends an element to this.

Specified by:

append in interface Seq<T>

Parameters:

element - An element

Returns:

A new Seq containing the given element appended to this elements

appendAll

LinearSeq<T> appendAll(Iterable<? extends T> elements)

Description copied from interface: Seq

Appends all given elements to this.

Specified by:

appendAll in interface Seq<T>

Parameters:

elements - An Iterable of elements

Returns:

A new Seq containing the given elements appended to this elements

asJava

@GwtIncompatible
LinearSeq<T> asJava(Consumer<? super List<T>> action)

Description copied from interface: Seq

Creates an immutable List view on top of this Seq that is passed to the given action.

Specified by:

asJava in interface Seq<T>

Parameters:

action - A side-effecting unit of work that operates on an immutable java.util.List view.

Returns:

this instance

See Also:

• Seq.asJava()

asJavaMutable

@GwtIncompatible
LinearSeq<T> asJavaMutable(Consumer<? super List<T>> action)

Description copied from interface: Seq

Creates a mutable List view on top of this Seq that is passed to the given action.

Specified by:

asJavaMutable in interface Seq<T>

Parameters:

action - A side-effecting unit of work that operates on a mutable java.util.List view.

Returns:

this instance, if only read operations are performed on the java.util.List view or a new instance of this type, if write operations are performed on the java.util.List view.

See Also:

• Seq.asJavaMutable()

asPartialFunction

default PartialFunction<Integer,T> asPartialFunction()
                                              throws IndexOutOfBoundsException

Description copied from interface: Seq

Turns this Seq into a PartialFunction which is defined at a specific index, if this Seq contains at least index + 1 elements. When applied to a defined index, the partial function will return the value of this Seq at the specified index.

Specified by:

asPartialFunction in interface Seq<T>

Returns:

a new PartialFunction

Throws:

IndexOutOfBoundsException - if this is empty, index < 0 or index >= length()

collect

<R> LinearSeq<R> collect(PartialFunction<? super T,? extends R> partialFunction)

Description copied from interface: Traversable

Collects all elements that are in the domain of the given 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).

Specified by:

collect in interface Seq<T>

Specified by:

collect in interface Traversable<T>

Type Parameters:

R - The new element type

Parameters:

partialFunction - A function that is not necessarily defined of all elements of this traversable.

Returns:

A new Traversable instance containing elements of type R

combinations

LinearSeq<? extends LinearSeq<T>> combinations()

Description copied from interface: Seq

Returns the union of all combinations from k = 0 to length().

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
 ]
 
 

Specified by:

combinations in interface Seq<T>

Returns:

the combinations of this

combinations

LinearSeq<? extends LinearSeq<T>> combinations(int k)

Description copied from interface: Seq

Returns the k-combination of this traversable, i.e. all subset of this of k distinct elements.

Specified by:

combinations in interface Seq<T>

Parameters:

k - Size of subsets

Returns:

the k-combination of this elements

See Also:

• Combination

crossProduct

Iterator<? extends LinearSeq<T>> crossProduct(int power)

Description copied from interface: Seq

Calculates the n-ary cartesian power (or cross product or simply product) of this.

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);
 
 

Specified by:

crossProduct in interface Seq<T>

Parameters:

power - the number of cartesian multiplications

Returns:

A new Iterator representing the n-ary cartesian power of this

distinct

LinearSeq<T> distinct()

Description copied from interface: Traversable

Returns a new version of this which contains no duplicates. Elements are compared using equals.

Specified by:

distinct in interface Seq<T>

Specified by:

distinct in interface Traversable<T>

Returns:

a new Traversable containing this elements without duplicates

distinctBy

LinearSeq<T> distinctBy(Comparator<? super T> comparator)

Description copied from interface: Traversable

Returns a new version of this which contains no duplicates. Elements are compared using the given comparator.

Specified by:

distinctBy in interface Seq<T>

Specified by:

distinctBy in interface Traversable<T>

Parameters:

comparator - A comparator

Returns:

a new Traversable containing this elements without duplicates

distinctBy

<U> LinearSeq<T> distinctBy(Function<? super T,? extends U> keyExtractor)

Description copied from interface: Traversable

Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared using equals.

The elements of the result are determined in the order of their occurrence - first match wins.

Specified by:

distinctBy in interface Seq<T>

Specified by:

distinctBy in interface Traversable<T>

Type Parameters:

U - key type

Parameters:

keyExtractor - A key extractor

Returns:

a new Traversable containing this elements without duplicates

drop

LinearSeq<T> drop(int n)

Description copied from interface: Traversable

Drops the first n elements of this or all elements, if this length < n.

Specified by:

drop in interface Seq<T>

Specified by:

drop in interface Traversable<T>

Parameters:

n - The number of elements to drop.

Returns:

a new instance consisting of all elements of this except the first n ones, or else the empty instance, if this has less than n elements.

dropUntil

LinearSeq<T> dropUntil(Predicate<? super T> predicate)

Description copied from interface: Traversable

Drops elements until the predicate holds for the current element.

Specified by:

dropUntil in interface Seq<T>

Specified by:

dropUntil in interface Traversable<T>

Parameters:

predicate - A condition tested subsequently for this elements.

Returns:

a new instance consisting of all elements starting from the first one which does satisfy the given predicate.

dropWhile

LinearSeq<T> dropWhile(Predicate<? super T> predicate)

Description copied from interface: Traversable

Drops elements while the predicate holds for the current element.

Note: This is essentially the same as dropUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

Specified by:

dropWhile in interface Seq<T>

Specified by:

dropWhile in interface Traversable<T>

Parameters:

predicate - A condition tested subsequently for this elements.

Returns:

a new instance consisting of all elements starting from the first one which does not satisfy the given predicate.

dropRight

LinearSeq<T> dropRight(int n)

Description copied from interface: Traversable

Drops the last n elements of this or all elements, if this length < n.

Specified by:

dropRight in interface Seq<T>

Specified by:

dropRight in interface Traversable<T>

Parameters:

n - The number of elements to drop.

Returns:

a new instance consisting of all elements of this except the last n ones, or else the empty instance, if this has less than n elements.

dropRightUntil

LinearSeq<T> dropRightUntil(Predicate<? super T> predicate)

Description copied from interface: Seq

Drops elements until the predicate holds for the current element, starting from the end.

Specified by:

dropRightUntil in interface Seq<T>

Parameters:

predicate - A condition tested subsequently for this elements, starting from the end.

Returns:

a new instance consisting of all elements until and including the last one which does satisfy the given predicate.

dropRightWhile

LinearSeq<T> dropRightWhile(Predicate<? super T> predicate)

Description copied from interface: Seq

Drops elements while the predicate holds for the current element, starting from the end.

Note: This is essentially the same as dropRightUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

Specified by:

dropRightWhile in interface Seq<T>

Parameters:

predicate - A condition tested subsequently for this elements, starting from the end.

Returns:

a new instance consisting of all elements until and including the last one which does not satisfy the given predicate.

filter

LinearSeq<T> filter(Predicate<? super T> predicate)

Description copied from interface: Traversable

Returns a new traversable consisting of all elements which satisfy the given predicate.

Specified by:

filter in interface Seq<T>

Specified by:

filter in interface Traversable<T>

Parameters:

predicate - A predicate

Returns:

a new traversable

reject

LinearSeq<T> reject(Predicate<? super T> predicate)

Description copied from interface: Traversable

Returns a new traversable consisting of all elements which do not satisfy the given predicate.

The default implementation is equivalent to

filter(predicate.negate()

Specified by:

reject in interface Seq<T>

Specified by:

reject in interface Traversable<T>

Parameters:

predicate - A predicate

Returns:

a new traversable

flatMap

<U> LinearSeq<U> flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)

Description copied from interface: Traversable

FlatMaps this Traversable.

Specified by:

flatMap in interface Seq<T>

Specified by:

flatMap in interface Traversable<T>

Type Parameters:

U - The resulting component type.

Parameters:

mapper - A mapper

Returns:

A new Traversable instance.

groupBy

<C> Map<C,? extends LinearSeq<T>> groupBy(Function<? super T,? extends C> classifier)

Description copied from interface: Traversable

Groups this elements by classifying the elements.

Specified by:

groupBy in interface Seq<T>

Specified by:

groupBy in interface Traversable<T>

Type Parameters:

C - classified class type

Parameters:

classifier - A function which classifies elements into classes

Returns:

A Map containing the grouped elements

See Also:

• Traversable.arrangeBy(Function)

grouped

Iterator<? extends LinearSeq<T>> grouped(int size)

Description copied from interface: Traversable

Groups this Traversable into fixed size blocks.

Let length be the length of this Iterable. Then grouped is defined as follows:

• If this.isEmpty(), the resulting Iterator is empty.
• If 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.
• If size > length, the resulting Iterator will contain one block of size length.

Examples:

 
 [].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).

Specified by:

grouped in interface Seq<T>

Specified by:

grouped in interface Traversable<T>

Parameters:

size - a positive block size

Returns:

A new Iterator of grouped blocks of the given size

indexOfSlice

default int indexOfSlice(Iterable<? extends T> that,
 int from)

Description copied from interface: Seq

Finds first index after or at a start index where this sequence contains a given sequence as a slice. Note: may not terminate for infinite sequences.

Specified by:

indexOfSlice in interface Seq<T>

Parameters:

that - the sequence to test

from - the start index

Returns:

the first index >= from such that the elements of this sequence starting at this index match the elements of sequence that, or -1 of no such slice exists.

indexWhere

default int indexWhere(Predicate<? super T> predicate,
 int from)

Description copied from interface: Seq

Finds index of the first element satisfying some predicate after or at some start index.

Specified by:

indexWhere in interface Seq<T>

Parameters:

predicate - the predicate used to test elements.

from - the start index

Returns:

the index >= from of the first element of this Seq that satisfies the given predicate, or -1, if none exists.

init

LinearSeq<T> init()

Description copied from interface: Traversable

Dual of Traversable.tail(), returning all elements except the last.

Specified by:

init in interface Seq<T>

Specified by:

init in interface Traversable<T>

Returns:

a new instance containing all elements except the last.

initOption

Option<? extends LinearSeq<T>> initOption()

Description copied from interface: Traversable

Dual of Traversable.tailOption(), returning all elements except the last as Option.

Specified by:

initOption in interface Seq<T>

Specified by:

initOption in interface Traversable<T>

Returns:

Some(traversable) or None if this is empty.

insert

LinearSeq<T> insert(int index,
 T element)

Description copied from interface: Seq

Inserts the given element at the specified index.

Specified by:

insert in interface Seq<T>

Parameters:

index - an index

element - an element

Returns:

a new Seq, where the given element is inserted into this at the given index

insertAll

LinearSeq<T> insertAll(int index,
 Iterable<? extends T> elements)

Description copied from interface: Seq

Inserts the given elements at the specified index.

Specified by:

insertAll in interface Seq<T>

Parameters:

index - an index

elements - An Iterable of elements

Returns:

a new Seq, where the given elements are inserted into this at the given index

intersperse

LinearSeq<T> intersperse(T element)

Description copied from interface: Seq

Inserts an element between all elements of this Traversable.

Specified by:

intersperse in interface Seq<T>

Parameters:

element - An element.

Returns:

an interspersed version of this

isDefinedAt

@Deprecated
default boolean isDefinedAt(Integer index)

Deprecated.

Description copied from interface: PartialFunction

Tests if a value is contained in the function's domain.

Specified by:

isDefinedAt in interface PartialFunction<Integer,T>

Parameters:

index - a potential function argument

Returns:

true, if the given value is contained in the function's domain, false otherwise

lastIndexOfSlice

default int lastIndexOfSlice(Iterable<? extends T> that,
 int end)

Description copied from interface: Seq

Finds last index before or at a given end index where this sequence contains a given sequence as a slice.

Specified by:

lastIndexOfSlice in interface Seq<T>

Parameters:

that - the sequence to test

end - the end index

Returns:

the last index <= end such that the elements of this sequence starting at this index match the elements of sequence that, or -1 of no such slice exists.

lastIndexWhere

default int lastIndexWhere(Predicate<? super T> predicate,
 int end)

Description copied from interface: Seq

Finds index of last element satisfying some predicate before or at given end index.

Specified by:

lastIndexWhere in interface Seq<T>

Parameters:

predicate - the predicate used to test elements.

end - the maximum index of the search

Returns:

the index <= end of the last element of this Seq that satisfies the given predicate, or -1, if none exists.

map

<U> LinearSeq<U> map(Function<? super T,? extends U> mapper)

Description copied from interface: Traversable

Maps the elements of this Traversable to elements of a new type preserving their order, if any.

Specified by:

map in interface Seq<T>

Specified by:

map in interface Traversable<T>

Specified by:

map in interface Value<T>

Type Parameters:

U - Component type of the target Traversable

Parameters:

mapper - A mapper.

Returns:

a mapped Traversable

orElse

LinearSeq<T> orElse(Iterable<? extends T> other)

Description copied from interface: Traversable

Returns this Traversable if it is nonempty, otherwise return the alternative.

Specified by:

orElse in interface Seq<T>

Specified by:

orElse in interface Traversable<T>

Parameters:

other - An alternative Traversable

Returns:

this Traversable if it is nonempty, otherwise return the alternative.

orElse

LinearSeq<T> orElse(Supplier<? extends Iterable<? extends T>> supplier)

Description copied from interface: Traversable

Returns this Traversable if it is nonempty, otherwise return the result of evaluating supplier.

Specified by:

orElse in interface Seq<T>

Specified by:

orElse in interface Traversable<T>

Parameters:

supplier - An alternative Traversable supplier

Returns:

this Traversable if it is nonempty, otherwise return the result of evaluating supplier.

padTo

LinearSeq<T> padTo(int length,
 T element)

Description copied from interface: Seq

A copy of this sequence with an element appended until a given target length is reached.

Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.

Specified by:

padTo in interface Seq<T>

Parameters:

length - the target length

element - the padding element

Returns:

a new sequence consisting of all elements of this sequence followed by the minimal number of occurrences of element so that the resulting sequence has a length of at least length.

patch

LinearSeq<T> patch(int from,
 Iterable<? extends T> that,
 int replaced)

Description copied from interface: Seq

Produces a new list where a slice of elements in this list is replaced by another sequence.

Specified by:

patch in interface Seq<T>

Parameters:

from - the index of the first replaced element

that - sequence for replacement

replaced - the number of elements to drop in the original list

Returns:

a new sequence.

partition

Tuple2<? extends LinearSeq<T>,? extends LinearSeq<T>> partition(Predicate<? super T> predicate)

Description copied from interface: Traversable

Creates a partition of this Traversable by splitting this elements in two in distinct traversables according to a predicate.

Specified by:

partition in interface Seq<T>

Specified by:

partition in interface Traversable<T>

Parameters:

predicate - A predicate which classifies an element if it is in the first or the second traversable.

Returns:

A disjoint union of two traversables. The first 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.

peek

LinearSeq<T> peek(Consumer<? super T> action)

Description copied from interface: Value

Performs the given 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.

Specified by:

peek in interface Seq<T>

Specified by:

peek in interface Traversable<T>

Specified by:

peek in interface Value<T>

Parameters:

action - The action that will be performed on the element(s).

Returns:

this instance

permutations

LinearSeq<? extends LinearSeq<T>> permutations()

Description copied from interface: Seq

Computes all unique permutations.

Example:

 
 [].permutations() = []

 [1,2,3].permutations() = [
   [1,2,3],
   [1,3,2],
   [2,1,3],
   [2,3,1],
   [3,1,2],
   [3,2,1]
 ]
 
 

Specified by:

permutations in interface Seq<T>

Returns:

this unique permutations

prepend

LinearSeq<T> prepend(T element)

Description copied from interface: Seq

Prepends an element to this.

Specified by:

prepend in interface Seq<T>

Parameters:

element - An element

Returns:

A new Seq containing the given element prepended to this elements

prependAll

LinearSeq<T> prependAll(Iterable<? extends T> elements)

Description copied from interface: Seq

Prepends all given elements to this.

Specified by:

prependAll in interface Seq<T>

Parameters:

elements - An Iterable of elements

Returns:

A new Seq containing the given elements prepended to this elements

remove

LinearSeq<T> remove(T element)

Description copied from interface: Seq

Removes the first occurrence of the given element.

Specified by:

remove in interface Seq<T>

Parameters:

element - An element to be removed from this Seq.

Returns:

a Seq containing all elements of this without the first occurrence of the given element.

removeFirst

LinearSeq<T> removeFirst(Predicate<T> predicate)

Description copied from interface: Seq

Removes the first occurrence that satisfy predicate

Specified by:

removeFirst in interface Seq<T>

Parameters:

predicate - an predicate

Returns:

a new Seq

removeLast

LinearSeq<T> removeLast(Predicate<T> predicate)

Description copied from interface: Seq

Removes the last occurrence that satisfy predicate

Specified by:

removeLast in interface Seq<T>

Parameters:

predicate - an predicate

Returns:

a new Seq

removeAt

LinearSeq<T> removeAt(int index)

Description copied from interface: Seq

Removes the element at the specified position in this sequence. Shifts any subsequent elements to the left (subtracts one from their indices).

Specified by:

removeAt in interface Seq<T>

Parameters:

index - position of element to remove

Returns:

a sequence containing all elements of this without the element at the specified position.

removeAll

LinearSeq<T> removeAll(T element)

Description copied from interface: Seq

Removes all occurrences of the given element.

Specified by:

removeAll in interface Seq<T>

Parameters:

element - An element to be removed from this Seq.

Returns:

a Seq containing all elements of this but not the given element.

removeAll

LinearSeq<T> removeAll(Iterable<? extends T> elements)

Description copied from interface: Seq

Removes all occurrences of the given elements.

Specified by:

removeAll in interface Seq<T>

Parameters:

elements - Elements to be removed from this Seq.

Returns:

a Seq containing all elements of this but none of the given elements.

removeAll

@Deprecated
LinearSeq<T> removeAll(Predicate<? super T> predicate)

Deprecated.

Description copied from interface: Seq

Returns a new Seq consisting of all elements which do not satisfy the given predicate.

Specified by:

removeAll in interface Seq<T>

Parameters:

predicate - the predicate used to test elements

Returns:

a new Seq

replace

LinearSeq<T> replace(T currentElement,
 T newElement)

Description copied from interface: Traversable

Replaces the first occurrence (if exists) of the given currentElement with newElement.

Specified by:

replace in interface Seq<T>

Specified by:

replace in interface Traversable<T>

Parameters:

currentElement - An element to be substituted.

newElement - A replacement for currentElement.

Returns:

a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newElement.

replaceAll

LinearSeq<T> replaceAll(T currentElement,
 T newElement)

Description copied from interface: Traversable

Replaces all occurrences of the given currentElement with newElement.

Specified by:

replaceAll in interface Seq<T>

Specified by:

replaceAll in interface Traversable<T>

Parameters:

currentElement - An element to be substituted.

newElement - A replacement for currentElement.

Returns:

a Traversable containing all elements of this where all occurrences of currentElement are replaced with newElement.

retainAll

LinearSeq<T> retainAll(Iterable<? extends T> elements)

Description copied from interface: Traversable

Keeps all occurrences of the given elements from this.

Specified by:

retainAll in interface Seq<T>

Specified by:

retainAll in interface Traversable<T>

Parameters:

elements - Elements to be kept.

Returns:

a Traversable containing all occurrences of the given elements.

reverse

LinearSeq<T> reverse()

Description copied from interface: Seq

Reverses the order of elements.

Specified by:

reverse in interface Seq<T>

Returns:

the reversed elements.

reverseIterator

default Iterator<T> reverseIterator()

Description copied from interface: Seq

An iterator yielding elements in reversed order.

Note: xs.reverseIterator() is the same as xs.reverse().iterator() but might be more efficient.

Specified by:

reverseIterator in interface Seq<T>

Returns:

an iterator yielding the elements of this Seq in reversed order

rotateLeft

LinearSeq<T> rotateLeft(int n)

Description copied from interface: Seq

Circular rotates the elements by the specified distance to the left direction.

 // = List(3, 4, 5, 1, 2)
 List.of(1, 2, 3, 4, 5).rotateLeft(2);
 

Specified by:

rotateLeft in interface Seq<T>

Parameters:

n - distance of left rotation

Returns:

the rotated elements.

rotateRight

LinearSeq<T> rotateRight(int n)

Description copied from interface: Seq

Circular rotates the elements by the specified distance to the right direction.

 // = List(4, 5, 1, 2, 3)
 List.of(1, 2, 3, 4, 5).rotateRight(2);
 

Specified by:

rotateRight in interface Seq<T>

Parameters:

n - distance of right rotation

Returns:

the rotated elements.

shuffle

LinearSeq<T> shuffle()

Description copied from interface: Seq

Randomize the order of the elements in the current sequence.

Specified by:

shuffle in interface Seq<T>

Returns:

a sequence with the same elements as the current sequence in a random order.

scan

LinearSeq<T> scan(T zero,
 BiFunction<? super T,? super T,? extends T> operation)

Description copied from interface: Traversable

Computes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.

Specified by:

scan in interface Seq<T>

Specified by:

scan in interface Traversable<T>

Parameters:

zero - neutral element for the operator op

operation - the associative operator for the scan

Returns:

a new traversable collection containing the prefix scan of the elements in this traversable collection

scanLeft

<U> LinearSeq<U> scanLeft(U zero,
 BiFunction<? super U,? super T,? extends U> operation)

Description copied from interface: Traversable

Produces a collection containing cumulative results of applying the operator going left to right. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.

Specified by:

scanLeft in interface Seq<T>

Specified by:

scanLeft in interface Traversable<T>

Type Parameters:

U - the type of the elements in the resulting collection

Parameters:

zero - the initial value

operation - the binary operator applied to the intermediate result and the element

Returns:

collection with intermediate results

scanRight

<U> LinearSeq<U> scanRight(U zero,
 BiFunction<? super T,? super U,? extends U> operation)

Description copied from interface: Traversable

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.

Specified by:

scanRight in interface Seq<T>

Specified by:

scanRight in interface Traversable<T>

Type Parameters:

U - the type of the elements in the resulting collection

Parameters:

zero - the initial value

operation - the binary operator applied to the intermediate result and the element

Returns:

collection with intermediate results

segmentLength

default int segmentLength(Predicate<? super T> predicate,
 int from)

Description copied from interface: Seq

Computes length of longest segment whose elements all satisfy some predicate.

Note: may not terminate for infinite sequences.

Specified by:

segmentLength in interface Seq<T>

Parameters:

predicate - the predicate used to test elements.

from - the index where the search starts.

Returns:

the length of the longest segment of this sequence starting from index from such that every element of the segment satisfies the predicate p.

slice

LinearSeq<T> slice(int beginIndex,
 int endIndex)

Description copied from interface: Seq

Returns a Seq that is a slice of this. The slice begins with the element at the specified 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.

Specified by:

slice in interface Seq<T>

Parameters:

beginIndex - the beginning index, inclusive

endIndex - the end index, exclusive

Returns:

the specified slice

slideBy

Iterator<? extends LinearSeq<T>> slideBy(Function<? super T,?> classifier)

Description copied from interface: Traversable

Slides a non-overlapping window of a variable size over this 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]]
 

Specified by:

slideBy in interface Seq<T>

Specified by:

slideBy in interface Traversable<T>

Parameters:

classifier - A function which classifies elements into classes

Returns:

A new Iterator of windows of the grouped elements

sliding

Iterator<? extends LinearSeq<T>> sliding(int size)

Description copied from interface: Traversable

Slides a window of a specific size and step size 1 over this Traversable by calling Traversable.sliding(int, int).

Specified by:

sliding in interface Seq<T>

Specified by:

sliding in interface Traversable<T>

Parameters:

size - a positive window size

Returns:

a new Iterator of windows of a specific size using step size 1

sliding

Iterator<? extends LinearSeq<T>> sliding(int size,
 int step)

Description copied from interface: Traversable

Slides a window of a specific 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]]
 
 

Specified by:

sliding in interface Seq<T>

Specified by:

sliding in interface Traversable<T>

Parameters:

size - a positive window size

step - a positive step size

Returns:

a new Iterator of windows of a specific size using a specific step size

sorted

LinearSeq<T> sorted()

Description copied from interface: Seq

Sorts this elements according to their natural order. If this elements are not Comparable, a java.lang.ClassCastException may be thrown.

Specified by:

sorted in interface Seq<T>

Returns:

A sorted version of this

sorted

LinearSeq<T> sorted(Comparator<? super T> comparator)

Description copied from interface: Seq

Sorts this elements according to the provided Comparator. If this elements are not Comparable, a java.lang.ClassCastException may be thrown.

Specified by:

sorted in interface Seq<T>

Parameters:

comparator - A comparator

Returns:

a sorted version of this

sortBy

<U extends Comparable<? super U>> LinearSeq<T> sortBy(Function<? super T,? extends U> mapper)

Description copied from interface: Seq

Sorts this elements by comparing the elements in a different domain, using the given mapper.

Specified by:

sortBy in interface Seq<T>

Type Parameters:

U - The domain where elements are compared

Parameters:

mapper - A mapper

Returns:

a sorted version of this

sortBy

<U> LinearSeq<T> sortBy(Comparator<? super U> comparator,
 Function<? super T,? extends U> mapper)

Description copied from interface: Seq

Sorts this elements by comparing the elements in a different domain, using the given mapper.

Specified by:

sortBy in interface Seq<T>

Type Parameters:

U - The domain where elements are compared

Parameters:

comparator - A comparator

mapper - A mapper

Returns:

a sorted version of this

span

Tuple2<? extends LinearSeq<T>,? extends LinearSeq<T>> span(Predicate<? super T> predicate)

Description copied from interface: Traversable

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.

Specified by:

span in interface Seq<T>

Specified by:

span in interface Traversable<T>

Parameters:

predicate - A predicate.

Returns:

a Tuple containing the longest prefix of elements that satisfy p and the remainder.

subSequence

LinearSeq<T> subSequence(int beginIndex)

Description copied from interface: Seq

Returns a Seq that is a subsequence of this. The subsequence begins with the element at the specified 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.

Specified by:

subSequence in interface Seq<T>

Parameters:

beginIndex - the beginning index, inclusive

Returns:

the specified subsequence

subSequence

LinearSeq<T> subSequence(int beginIndex,
 int endIndex)

Description copied from interface: Seq

Returns a Seq that is a subsequence of this. The subsequence begins with the element at the specified 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.

Specified by:

subSequence in interface Seq<T>

Parameters:

beginIndex - the beginning index, inclusive

endIndex - the end index, exclusive

Returns:

the specified subsequence

tail

LinearSeq<T> tail()

Description copied from interface: Traversable

Drops the first element of a non-empty Traversable.

Specified by:

tail in interface Seq<T>

Specified by:

tail in interface Traversable<T>

Returns:

A new instance of Traversable containing all elements except the first.

tailOption

Option<? extends LinearSeq<T>> tailOption()

Description copied from interface: Traversable

Drops the first element of a non-empty Traversable and returns an Option.

Specified by:

tailOption in interface Seq<T>

Specified by:

tailOption in interface Traversable<T>

Returns:

Some(traversable) or None if this is empty.

take

LinearSeq<T> take(int n)

Description copied from interface: Traversable

Takes the first n elements of this or all elements, if this length < n.

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.

Specified by:

take in interface Seq<T>

Specified by:

take in interface Traversable<T>

Parameters:

n - The number of elements to take.

Returns:

A new instance consisting of the first n elements of this or all elements, if this has less than n elements.

takeUntil

LinearSeq<T> takeUntil(Predicate<? super T> predicate)

Description copied from interface: Traversable

Takes elements until the predicate holds for the current element.

Note: This is essentially the same as takeWhile(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

Specified by:

takeUntil in interface Seq<T>

Specified by:

takeUntil in interface Traversable<T>

Parameters:

predicate - A condition tested subsequently for this elements.

Returns:

a new instance consisting of all elements before the first one which does satisfy the given predicate.

takeWhile

LinearSeq<T> takeWhile(Predicate<? super T> predicate)

Description copied from interface: Traversable

Takes elements while the predicate holds for the current element.

Specified by:

takeWhile in interface Seq<T>

Specified by:

takeWhile in interface Traversable<T>

Parameters:

predicate - A condition tested subsequently for the contained elements.

Returns:

a new instance consisting of all elements before the first one which does not satisfy the given predicate.

takeRight

LinearSeq<T> takeRight(int n)

Description copied from interface: Traversable

Takes the last n elements of this or all elements, if this length < n.

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.

Specified by:

takeRight in interface Seq<T>

Specified by:

takeRight in interface Traversable<T>

Parameters:

n - The number of elements to take.

Returns:

A new instance consisting of the last n elements of this or all elements, if this has less than n elements.

takeRightUntil

LinearSeq<T> takeRightUntil(Predicate<? super T> predicate)

Description copied from interface: Seq

Takes elements until the predicate holds for the current element, starting from the end.

Specified by:

takeRightUntil in interface Seq<T>

Parameters:

predicate - A condition tested subsequently for this elements, starting from the end.

Returns:

a new instance consisting of all elements after the last one which does satisfy the given predicate.

takeRightWhile

LinearSeq<T> takeRightWhile(Predicate<? super T> predicate)

Description copied from interface: Seq

Takes elements while the predicate holds for the current element, starting from the end.

Note: This is essentially the same as takeRightUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.

Specified by:

takeRightWhile in interface Seq<T>

Parameters:

predicate - A condition tested subsequently for this elements, starting from the end.

Returns:

a new instance consisting of all elements after the last one which does not satisfy the given predicate.

unzip

<T1,
T2>
Tuple2<? extends LinearSeq<T1>,? extends LinearSeq<T2>> unzip(Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)

Description copied from interface: Traversable

Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.

Specified by:

unzip in interface Seq<T>

Specified by:

unzip in interface Traversable<T>

Type Parameters:

T1 - 1st element type of a pair returned by unzipper

T2 - 2nd element type of a pair returned by unzipper

Parameters:

unzipper - a function which converts elements of this to pairs

Returns:

A pair of set containing elements split by unzipper

update

LinearSeq<T> update(int index,
 T element)

Description copied from interface: Seq

Updates the given element at the specified index.

Specified by:

update in interface Seq<T>

Parameters:

index - an index

element - an element

Returns:

a new Seq consisting of all previous elements, with a single one (at the given index), changed to the new value.

update

LinearSeq<T> update(int index,
 Function<? super T,? extends T> updater)

Description copied from interface: Seq

Updates the given element at the specified index using the specified function.

Specified by:

update in interface Seq<T>

Parameters:

index - an index

updater - a function transforming the previous value

Returns:

a new Seq consisting of all previous elements, with a single one (at the given index), changed to the new value.

zip

<U> LinearSeq<Tuple2<T,U>> zip(Iterable<? extends U> that)

Description copied from interface: Traversable

Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs. If one of the two iterables is longer than the other, its remaining elements are ignored.

The length of the returned traversable is the minimum of the lengths of this traversable and that iterable.

Specified by:

zip in interface Seq<T>

Specified by:

zip in interface Traversable<T>

Type Parameters:

U - The type of the second half of the returned pairs.

Parameters:

that - The Iterable providing the second half of each result pair.

Returns:

a new traversable containing pairs consisting of corresponding elements of this traversable and that iterable.

zipWith

<U,
R> LinearSeq<R> zipWith(Iterable<? extends U> that,
 BiFunction<? super T,? super U,? extends R> mapper)

Description copied from interface: Traversable

Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.

The length of the returned traversable is the minimum of the lengths of this traversable and that iterable.

Specified by:

zipWith in interface Seq<T>

Specified by:

zipWith in interface Traversable<T>

Type Parameters:

U - The type of the second parameter of the mapper.

R - The type of the mapped elements.

Parameters:

that - The Iterable providing the second parameter of the mapper.

mapper - a mapper.

Returns:

a new traversable containing mapped elements of this traversable and that iterable.

zipAll

<U> LinearSeq<Tuple2<T,U>> zipAll(Iterable<? extends U> that,
 T thisElem,
 U thatElem)

Description copied from interface: Traversable

Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

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.

Specified by:

zipAll in interface Seq<T>

Specified by:

zipAll in interface Traversable<T>

Type Parameters:

U - The type of the second half of the returned pairs.

Parameters:

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.

Returns:

A new traversable containing pairs consisting of corresponding elements of this traversable and that.

zipWithIndex

LinearSeq<Tuple2<T,Integer>> zipWithIndex()

Description copied from interface: Traversable

Zips this traversable with its indices.

Specified by:

zipWithIndex in interface Seq<T>

Specified by:

zipWithIndex in interface Traversable<T>

Returns:

A new traversable containing all elements of this traversable paired with their index, starting with 0.

zipWithIndex

<U> LinearSeq<U> zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)

Description copied from interface: Traversable

Zips this traversable with its indices by applying mapper provided.

Specified by:

zipWithIndex in interface Seq<T>

Specified by:

zipWithIndex in interface Traversable<T>

Type Parameters:

U - The type of the mapped elements.

Parameters:

mapper - a mapper.

Returns:

a new traversable containing elements of this traversable, zipped with indices, and mapped with mapper provided.

search

default int search(T element)

Searches this sequence for a specific element using a linear search. The sequence must already be sorted into ascending natural order. If it is not sorted, the results are undefined.

Specified by:

search in interface Seq<T>

Parameters:

element - the element to find

Returns:

the index of the search element, if it is contained in the sequence; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the element would be inserted into the sequence. Note that this guarantees that the return value will be >= 0 if and only if the element is found.

Throws:

ClassCastException - if T cannot be cast to Comparable<? super T>

search

default int search(T element,
 Comparator<? super T> comparator)

Searches this sequence for a specific element using a linear search. The sequence must already be sorted into ascending order according to the specified comparator. If it is not sorted, the results are undefined.

Specified by:

search in interface Seq<T>

Parameters:

element - the element to find

comparator - the comparator by which this sequence is ordered

Returns:

the index of the search element, if it is contained in the sequence; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the element would be inserted into the sequence. Note that this guarantees that the return value will be >= 0 if and only if the element is found.