Interface IndexedSeq<T>

  • Type Parameters:
    T - component type
    All Superinterfaces:
    Foldable<T>, java.util.function.Function<java.lang.Integer,​T>, Function1<java.lang.Integer,​T>, Iterable<T>, java.lang.Iterable<T>, PartialFunction<java.lang.Integer,​T>, Seq<T>, java.io.Serializable, Traversable<T>, Value<T>
    All Known Implementing Classes:
    Array, CharSeq, Vector

    public interface IndexedSeq<T>
    extends Seq<T>
    Interface for immutable, indexed sequences.

    Efficient random access is characteristic for indexed sequences.

    • Method Detail

      • narrow

        static <T> IndexedSeq<T> narrow​(IndexedSeq<? extends T> indexedSeq)
        Narrows a widened IndexedSeq<? extends T> to IndexedSeq<T> by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.
        Type Parameters:
        T - Component type of the IndexedSeq.
        Parameters:
        indexedSeq - An IndexedSeq.
        Returns:
        the given indexedSeq instance as narrowed type IndexedSeq<T>.
      • append

        IndexedSeq<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

        IndexedSeq<T> appendAll​(java.lang.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
        IndexedSeq<T> asJava​(java.util.function.Consumer<? super java.util.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
        IndexedSeq<T> asJavaMutable​(java.util.function.Consumer<? super java.util.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<java.lang.Integer,​T> asPartialFunction()
                                                                      throws java.lang.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:
        java.lang.IndexOutOfBoundsException - if this is empty, index < 0 or index >= length()
      • collect

        <R> IndexedSeq<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

        IndexedSeq<? extends IndexedSeq<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

        IndexedSeq<? extends IndexedSeq<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 IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<T> distinctBy​(java.util.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> IndexedSeq<T> distinctBy​(java.util.function.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

        IndexedSeq<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

        IndexedSeq<T> dropUntil​(java.util.function.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

        IndexedSeq<T> dropWhile​(java.util.function.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

        IndexedSeq<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

        IndexedSeq<T> dropRightUntil​(java.util.function.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

        IndexedSeq<T> dropRightWhile​(java.util.function.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.
      • endsWith

        default boolean endsWith​(Seq<? extends T> that)
        Description copied from interface: Seq
        Tests whether this sequence ends with the given sequence.

        Note: If the both the receiver object this and the argument that are infinite sequences this method may not terminate.

        Specified by:
        endsWith in interface Seq<T>
        Parameters:
        that - the sequence to test
        Returns:
        true if this sequence has that as a suffix, false otherwise.
      • filter

        IndexedSeq<T> filter​(java.util.function.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
      • filterNot

        IndexedSeq<T> filterNot​(java.util.function.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:
        filterNot in interface Seq<T>
        Specified by:
        filterNot in interface Traversable<T>
        Parameters:
        predicate - A predicate
        Returns:
        a new traversable
      • reject

        @Deprecated
        IndexedSeq<T> reject​(java.util.function.Predicate<? super T> predicate)
        Deprecated.
        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> IndexedSeq<U> flatMap​(java.util.function.Function<? super T,​? extends java.lang.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 IndexedSeq<T>> groupBy​(java.util.function.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)
      • indexWhere

        default int indexWhere​(java.util.function.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.
      • grouped

        Iterator<? extends IndexedSeq<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​(java.lang.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.
      • insert

        IndexedSeq<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

        IndexedSeq<T> insertAll​(int index,
                                java.lang.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

        IndexedSeq<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​(java.lang.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<java.lang.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​(java.lang.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​(java.util.function.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> IndexedSeq<U> map​(java.util.function.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

        IndexedSeq<T> orElse​(java.lang.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

        IndexedSeq<T> orElse​(java.util.function.Supplier<? extends java.lang.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

        IndexedSeq<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

        IndexedSeq<T> patch​(int from,
                            java.lang.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 IndexedSeq<T>,​? extends IndexedSeq<T>> partition​(java.util.function.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

        IndexedSeq<T> peek​(java.util.function.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

        IndexedSeq<? extends IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<T> prependAll​(java.lang.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

        IndexedSeq<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

        IndexedSeq<T> removeFirst​(java.util.function.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

        IndexedSeq<T> removeLast​(java.util.function.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

        IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<T> removeAll​(java.lang.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
        IndexedSeq<T> removeAll​(java.util.function.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

        IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<T> retainAll​(java.lang.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

        IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<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.
      • scan

        IndexedSeq<T> scan​(T zero,
                           java.util.function.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> IndexedSeq<U> scanLeft​(U zero,
                                   java.util.function.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> IndexedSeq<U> scanRight​(U zero,
                                    java.util.function.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​(java.util.function.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.
      • shuffle

        IndexedSeq<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.
      • shuffle

        IndexedSeq<T> shuffle​(java.util.Random random)
        Description copied from interface: Seq
        Randomize the order of the elements in the current sequence using the given source of randomness.
        Specified by:
        shuffle in interface Seq<T>
        Parameters:
        random - A random number generator
        Returns:
        a sequence with the same elements as the current sequence in a random order.
      • slice

        IndexedSeq<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 IndexedSeq<T>> slideBy​(java.util.function.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 IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<T> sorted​(java.util.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 java.lang.Comparable<? super U>> IndexedSeq<T> sortBy​(java.util.function.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> IndexedSeq<T> sortBy​(java.util.Comparator<? super U> comparator,
                                 java.util.function.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 IndexedSeq<T>,​? extends IndexedSeq<T>> span​(java.util.function.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.
      • startsWith

        default boolean startsWith​(java.lang.Iterable<? extends T> that,
                                   int offset)
        Description copied from interface: Seq
        Tests whether this list contains the given sequence at a given index.

        Note: If the both the receiver object this and the argument that are infinite sequences this method may not terminate.

        Specified by:
        startsWith in interface Seq<T>
        Parameters:
        that - the sequence to test
        offset - the index where the sequence is searched.
        Returns:
        true if that is empty or that is prefix of this collection starting from the given offset, false otherwise.
      • subSequence

        IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<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 IndexedSeq<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

        IndexedSeq<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

        IndexedSeq<T> takeUntil​(java.util.function.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

        IndexedSeq<T> takeWhile​(java.util.function.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

        IndexedSeq<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

        IndexedSeq<T> takeRightUntil​(java.util.function.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

        IndexedSeq<T> takeRightWhile​(java.util.function.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 IndexedSeq<T1>,​? extends IndexedSeq<T2>> unzip​(java.util.function.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
      • unzip3

        <T1,​T2,​T3> Tuple3<? extends IndexedSeq<T1>,​? extends IndexedSeq<T2>,​? extends IndexedSeq<T3>> unzip3​(java.util.function.Function<? super T,​Tuple3<? extends T1,​? extends T2,​? extends T3>> unzipper)
        Description copied from interface: Traversable
        Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.
        Specified by:
        unzip3 in interface Seq<T>
        Specified by:
        unzip3 in interface Traversable<T>
        Type Parameters:
        T1 - 1st element type of a triplet returned by unzipper
        T2 - 2nd element type of a triplet returned by unzipper
        T3 - 3rd element type of a triplet returned by unzipper
        Parameters:
        unzipper - a function which converts elements of this to pairs
        Returns:
        A triplet of set containing elements split by unzipper
      • update

        IndexedSeq<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

        IndexedSeq<T> update​(int index,
                             java.util.function.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> IndexedSeq<Tuple2<T,​U>> zip​(java.lang.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> IndexedSeq<R> zipWith​(java.lang.Iterable<? extends U> that,
                                          java.util.function.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> IndexedSeq<Tuple2<T,​U>> zipAll​(java.lang.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

        IndexedSeq<Tuple2<T,​java.lang.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> IndexedSeq<U> zipWithIndex​(java.util.function.BiFunction<? super T,​? super java.lang.Integer,​? extends U> 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:
        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 mapped elements of this traversable and that iterable.
      • search

        default int search​(T element)
        Searches this sequence for a specific element using a binary 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:
        java.lang.ClassCastException - if T cannot be cast to Comparable<? super T>
      • search

        default int search​(T element,
                           java.util.Comparator<? super T> comparator)
        Searches this sequence for a specific element using a binary 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.