Class PriorityQueue<T>

    • Method Detail

      • collect

        public <R> PriorityQueue<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 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
      • enqueue

        public PriorityQueue<T> enqueue​(T element)
        Enqueues a new element.
        Parameters:
        element - The new element
        Returns:
        a new PriorityQueue instance, containing the new element
      • enqueueAll

        public PriorityQueue<T> enqueueAll​(java.lang.Iterable<? extends T> elements)
        Enqueues the given elements. A queue has FIFO order, i.e. the first of the given elements is the first which will be retrieved.
        Parameters:
        elements - An PriorityQueue of elements, may be empty
        Returns:
        a new PriorityQueue instance, containing the new elements
        Throws:
        java.lang.NullPointerException - if elements is null
      • head

        public T head()
        Returns the first element of a non-empty PriorityQueue.
        Specified by:
        head in interface Traversable<T>
        Returns:
        The first element of this PriorityQueue.
        Throws:
        java.util.NoSuchElementException - if this is empty
      • tail

        public PriorityQueue<T> tail()
        Drops the first element of a non-empty PriorityQueue.
        Specified by:
        tail in interface Traversable<T>
        Returns:
        A new instance of PriorityQueue containing all elements except the first.
        Throws:
        java.lang.UnsupportedOperationException - if this is empty
      • dequeue

        public Tuple2<T,​PriorityQueue<T>> dequeue()
        Removes an element from this Queue.
        Returns:
        a tuple containing the first element and the remaining elements of this Queue
      • isAsync

        public boolean isAsync()
        A PriorityQueue is computed synchronously.
        Specified by:
        isAsync in interface Value<T>
        Returns:
        false
      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Traversable
        Checks if this Traversable is empty.
        Specified by:
        isEmpty in interface Traversable<T>
        Specified by:
        isEmpty in interface Value<T>
        Returns:
        true, if this Traversable contains no elements, false otherwise.
      • isLazy

        public boolean isLazy()
        A PriorityQueue is computed eagerly.
        Specified by:
        isLazy in interface Value<T>
        Returns:
        false
      • isOrdered

        public boolean isOrdered()
        Description copied from interface: Traversable
        Checks if this Traversable is ordered
        Specified by:
        isOrdered in interface Traversable<T>
        Returns:
        true, if this Traversable is ordered, false otherwise.
      • empty

        public static <T extends java.lang.Comparable<? super T>> PriorityQueue<T> empty()
        Returns the empty PriorityQueue.
        Type Parameters:
        T - Component type
        Returns:
        The empty PriorityQueue.
      • empty

        public static <T> PriorityQueue<T> empty​(java.util.Comparator<? super T> comparator)
      • collector

        public static <T> java.util.stream.Collector<T,​java.util.ArrayList<T>,​PriorityQueue<T>> collector()
        Returns a Collector which may be used in conjunction with Stream.collect(Collector) to obtain a PriorityQueue<T>.
        Type Parameters:
        T - Component type of the PriorityQueue.
        Returns:
        A PriorityQueue<T> Collector.
      • narrow

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

        public static <T extends java.lang.Comparable<? super T>> PriorityQueue<T> of​(T element)
      • of

        public static <T extends java.lang.Comparable<? super T>> PriorityQueue<T> of​(T... elements)
      • of

        public static <T> PriorityQueue<T> of​(java.util.Comparator<? super T> comparator,
                                              T element)
      • of

        public static <T> PriorityQueue<T> of​(java.util.Comparator<? super T> comparator,
                                              T... elements)
      • ofAll

        public static <T extends java.lang.Comparable<? super T>> PriorityQueue<T> ofAll​(java.lang.Iterable<? extends T> elements)
      • ofAll

        public static <T> PriorityQueue<T> ofAll​(java.util.Comparator<? super T> comparator,
                                                 java.lang.Iterable<? extends T> elements)
      • ofAll

        public static <T extends java.lang.Comparable<? super T>> PriorityQueue<T> ofAll​(java.util.stream.Stream<? extends T> javaStream)
      • ofAll

        public static <T> PriorityQueue<T> ofAll​(java.util.Comparator<? super T> comparator,
                                                 java.util.stream.Stream<? extends T> javaStream)
      • tabulate

        @GwtIncompatible
        public static <T> PriorityQueue<T> tabulate​(int size,
                                                    java.util.function.Function<? super java.lang.Integer,​? extends T> function)
        Returns a PriorityQueue containing size values of a given Function function over a range of integer values from 0 to size - 1.
        Type Parameters:
        T - Component type of the PriorityQueue
        Parameters:
        size - The number of elements in the PriorityQueue
        function - The Function computing element values
        Returns:
        A PriorityQueue consisting of elements function(0),function(1), ..., function(size - 1)
        Throws:
        java.lang.NullPointerException - if function is null
      • fill

        @GwtIncompatible
        public static <T> PriorityQueue<T> fill​(int size,
                                                java.util.function.Supplier<? extends T> supplier)
        Returns a PriorityQueue containing size values supplied by a given Supplier supplier.
        Type Parameters:
        T - Component type of the PriorityQueue
        Parameters:
        size - The number of elements in the PriorityQueue
        supplier - The Supplier computing element values
        Returns:
        A PriorityQueue of size size, where each element contains the result supplied by supplier.
        Throws:
        java.lang.NullPointerException - if supplier is null
      • fill

        @GwtIncompatible
        public static <T> PriorityQueue<T> fill​(int size,
                                                T element)
        Returns a PriorityQueue containing n times the given element
        Type Parameters:
        T - Component type of the PriorityQueue
        Parameters:
        size - The number of elements in the PriorityQueue
        element - The element
        Returns:
        A PriorityQueue of size size, where each element is the given element.
      • toList

        public List<T> toList()
        Description copied from interface: Value
        Converts this to a List.
        Specified by:
        toList in interface Value<T>
        Returns:
        A new List.
      • distinct

        public PriorityQueue<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 Traversable<T>
        Returns:
        a new Traversable containing this elements without duplicates
      • distinctBy

        public PriorityQueue<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 Traversable<T>
        Parameters:
        comparator - A comparator
        Returns:
        a new Traversable containing this elements without duplicates
      • distinctBy

        public <U> PriorityQueue<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 Traversable<T>
        Type Parameters:
        U - key type
        Parameters:
        keyExtractor - A key extractor
        Returns:
        a new Traversable containing this elements without duplicates
      • drop

        public PriorityQueue<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 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.
      • dropRight

        public PriorityQueue<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 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.
      • dropWhile

        public PriorityQueue<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 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.
      • filter

        public PriorityQueue<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 Traversable<T>
        Parameters:
        predicate - A predicate
        Returns:
        a new traversable
      • flatMap

        public <U> PriorityQueue<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 Traversable<T>
        Type Parameters:
        U - The resulting component type.
        Parameters:
        mapper - A mapper
        Returns:
        A new Traversable instance.
      • flatMap

        public <U> PriorityQueue<U> flatMap​(java.util.Comparator<U> comparator,
                                            java.util.function.Function<? super T,​? extends java.lang.Iterable<? extends U>> mapper)
      • foldRight

        public <U> U foldRight​(U zero,
                               java.util.function.BiFunction<? super T,​? super U,​? extends U> accumulator)
        Accumulates the elements of this PriorityQueue by successively calling the given function f from the right, starting with a value zero of type B.

        Example: PriorityQueue.of("a", "b", "c").foldRight("", (x, xs) -> x + xs) = "abc"

        Specified by:
        foldRight in interface Foldable<T>
        Specified by:
        foldRight in interface Traversable<T>
        Type Parameters:
        U - the type of the folded value
        Parameters:
        zero - Value to start the accumulation with.
        accumulator - The accumulator function.
        Returns:
        an accumulated version of this.
        Throws:
        java.lang.NullPointerException - if f is null
      • groupBy

        public <C> Map<C,​? extends PriorityQueue<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 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

        public Iterator<? extends PriorityQueue<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 Traversable<T>
        Parameters:
        size - a positive block size
        Returns:
        A new Iterator of grouped blocks of the given size
      • hasDefiniteSize

        public boolean hasDefiniteSize()
        Checks if this PriorityQueue is known to have a finite size.

        This method should be implemented by classes only, i.e. not by interfaces.

        Specified by:
        hasDefiniteSize in interface Traversable<T>
        Returns:
        true, if this PriorityQueue is known to have a finite size, false otherwise.
      • init

        public PriorityQueue<T> init()
        Dual of tail(), returning all elements except the last.
        Specified by:
        init in interface Traversable<T>
        Returns:
        a new instance containing all elements except the last.
        Throws:
        java.lang.UnsupportedOperationException - if this is empty
      • isTraversableAgain

        public boolean isTraversableAgain()
        Checks if this PriorityQueue can be repeatedly traversed.

        This method should be implemented by classes only, i.e. not by interfaces.

        Specified by:
        isTraversableAgain in interface Traversable<T>
        Returns:
        true, if this PriorityQueue is known to be traversable repeatedly, false otherwise.
      • map

        public <U> PriorityQueue<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 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
      • map

        public <U> PriorityQueue<U> map​(java.util.Comparator<U> comparator,
                                        java.util.function.Function<? super T,​? extends U> mapper)
      • orElse

        public PriorityQueue<T> orElse​(java.lang.Iterable<? extends T> other)
        Returns this PriorityQueue if it is nonempty, otherwise PriorityQueue created from iterable, using existing comparator.
        Specified by:
        orElse in interface Traversable<T>
        Parameters:
        other - An alternative Traversable
        Returns:
        this PriorityQueue if it is nonempty, otherwise PriorityQueue created from iterable, using existing comparator.
      • orElse

        public PriorityQueue<T> orElse​(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
        Returns this PriorityQueue if it is nonempty, otherwise PriorityQueue created from result of evaluating supplier, using existing comparator.
        Specified by:
        orElse in interface Traversable<T>
        Parameters:
        supplier - An alternative Traversable
        Returns:
        this PriorityQueue if it is nonempty, otherwise PriorityQueue created from result of evaluating supplier, using existing comparator.
      • partition

        public Tuple2<? extends PriorityQueue<T>,​? extends PriorityQueue<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 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.
      • replace

        public PriorityQueue<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 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

        public PriorityQueue<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 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.
      • scan

        public PriorityQueue<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 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

        public <U> PriorityQueue<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 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

        public <U> PriorityQueue<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 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
      • slideBy

        public Iterator<? extends PriorityQueue<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 Traversable<T>
        Parameters:
        classifier - A function which classifies elements into classes
        Returns:
        A new Iterator of windows of the grouped elements
      • sliding

        public Iterator<? extends PriorityQueue<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 Traversable<T>
        Parameters:
        size - a positive window size
        Returns:
        a new Iterator of windows of a specific size using step size 1
      • sliding

        public Iterator<? extends PriorityQueue<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 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
      • span

        public Tuple2<? extends PriorityQueue<T>,​? extends PriorityQueue<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 Traversable<T>
        Parameters:
        predicate - A predicate.
        Returns:
        a Tuple containing the longest prefix of elements that satisfy p and the remainder.
      • take

        public PriorityQueue<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 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.
      • takeRight

        public PriorityQueue<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 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.
      • takeUntil

        public PriorityQueue<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 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.
      • unzip

        public <T1,​T2> Tuple2<? extends PriorityQueue<T1>,​? extends PriorityQueue<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 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

        public <T1,​T2,​T3> Tuple3<? extends PriorityQueue<T1>,​? extends PriorityQueue<T2>,​? extends PriorityQueue<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 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
      • zip

        public <U> PriorityQueue<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 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

        public <U,​R> PriorityQueue<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 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

        public <U> PriorityQueue<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 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

        public PriorityQueue<Tuple2<T,​java.lang.Integer>> zipWithIndex()
        Description copied from interface: Traversable
        Zips this traversable with its indices.
        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

        public <U> PriorityQueue<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 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.
      • stringPrefix

        public java.lang.String stringPrefix()
        Description copied from interface: Value
        Returns the name of this Value type, which is used by toString().
        Specified by:
        stringPrefix in interface Value<T>
        Returns:
        This type name.
      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from interface: Traversable
        In Vavr there are four basic classes of collections:
        • Seq (sequential elements)
        • Set (distinct elements)
        • Map (indexed elements)
        • Multimap (indexed collections)
        Two collection instances of these classes are equal if and only if both collections
        • belong to the same basic collection class (Seq, Set, Map or Multimap)
        • contain the same elements
        • have the same element order, if the collections are of type Seq
        Two Map/Multimap elements, resp. entries, (key1, value1) and (key2, value2) are equal, if the keys are equal and the values are equal.

        Notes:

        • No collection instance equals null, e.g. Queue(1) not equals null.
        • Nulls are allowed and handled as expected, e.g. List(null, 1) equals Stream(null, 1) and HashMap((null, 1)) equals LinkedHashMap((null, 1)).
        • The element order is taken into account for Seq only. E.g. List(null, 1) not equals Stream(1, null) and HashMap((null, 1), ("a", null)) equals LinkedHashMap(("a", null), (null, 1)). The reason is, that we do not know which implementations we compare when having two instances of type Map, Multimap or Set (see Liskov Substitution Principle).
        • Other collection classes are equal if their types are equal and their elements are equal (in iteration order).
        • Iterator equality is defined to be object reference equality.
        Specified by:
        equals in interface Traversable<T>
        Specified by:
        equals in interface Value<T>
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - an object, may be null
        Returns:
        true, if this collection equals the given object according to the rules described above, false otherwise.
      • hashCode

        public int hashCode()
        Description copied from interface: Traversable
        Returns the hash code of this collection.
        We distinguish between two types of hashes, those for collections with predictable iteration order (like Seq) and those with arbitrary iteration order (like Set, Map and Multimap).
        In all cases the hash of an empty collection is defined to be 1.
        Collections with predictable iteration order are hashed as follows:
        
         int hash = 1;
         for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }
         
        Collections with arbitrary iteration order are hashed in a way such that the hash of a fixed number of elements is independent of their iteration order.
        
         int hash = 1;
         for (T t : this) { hash += Objects.hashCode(t); }
         
        Please note that the particular hashing algorithms may change in a future version of Vavr.
        Generally, hash codes of collections aren't cached in Vavr (opposed to the size/length). Storing hash codes in order to reduce the time complexity would increase the memory footprint. Persistent collections are built upon tree structures, it allows us to implement efficient memory sharing. A drawback of tree structures is that they make it necessary to store collection attributes at each tree node (read: element).
        The computation of the hash code is linear in time, i.e. O(n). If the hash code of a collection is re-calculated often, e.g. when using a List as HashMap key, we might want to cache the hash code. This can be achieved by simply using a wrapper class, which is not included in Vavr but could be implemented like this:
        public final class Hashed<K> {
        
             private final K key;
             private final Lazy<Integer> hashCode;
        
             public Hashed(K key) {
                 this.key = key;
                 this.hashCode = Lazy.of(() -> Objects.hashCode(key));
             }
        
             public K key() {
                 return key;
             }
        
             &#64;Override
             public boolean equals(Object o) {
                 if (o == key) {
                     return true;
                 } else if (key != null && o instanceof Hashed) {
                     final Hashed that = (Hashed) o;
                     return key.equals(that.key);
                 } else {
                     return false;
                 }
             }
        
             &#64;Override
             public int hashCode() {
                 return hashCode.get();
             }
        
             &#64;Override
             public String toString() {
                 return "Hashed(" + (key == null ? "null" : key.toString()) + ")";
             }
         }
        Specified by:
        hashCode in interface Traversable<T>
        Specified by:
        hashCode in interface Value<T>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code of this collection
      • comparator

        public java.util.Comparator<T> comparator()
        Description copied from interface: Ordered
        Returns the comparator which defines the order of the elements contained in this collection.
        Specified by:
        comparator in interface Ordered<T>
        Returns:
        The comparator that defines the order of this collection's elements.
      • dequeueOption

        public Option<Tuple2<T,​Q>> dequeueOption()
        Removes an element from this Queue.
        Returns:
        None if this Queue is empty, otherwise Some Tuple containing the first element and the remaining elements of this Queue
      • enqueue

        public Q enqueue​(T... elements)
        Enqueues the given elements. A queue has FIFO order, i.e. the first of the given elements is the first which will be retrieved.
        Parameters:
        elements - Elements, may be empty
        Returns:
        a new Queue instance, containing the new elements
        Throws:
        java.lang.NullPointerException - if elements is null
      • peek

        public T peek()
        Returns the first element without modifying it.
        Returns:
        the first element
        Throws:
        java.util.NoSuchElementException - if this Queue is empty
      • peekOption

        public Option<T> peekOption()
        Returns the first element without modifying the Queue.
        Returns:
        None if this Queue is empty, otherwise a Some containing the first element
      • dropUntil

        public Q 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 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.
      • filterNot

        public Q 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 Traversable<T>
        Parameters:
        predicate - A predicate
        Returns:
        a new traversable
      • tailOption

        public Option<Q> tailOption()
        Description copied from interface: Traversable
        Drops the first element of a non-empty Traversable and returns an Option.
        Specified by:
        tailOption in interface Traversable<T>
        Returns:
        Some(traversable) or None if this is empty.
      • retainAll

        public Q 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 Traversable<T>
        Parameters:
        elements - Elements to be kept.
        Returns:
        a Traversable containing all occurrences of the given elements.
      • removeAll

        public Q removeAll​(java.lang.Iterable<? extends T> elements)
      • removeAll

        @Deprecated
        public Q removeAll​(java.util.function.Predicate<? super T> predicate)
        Deprecated.
      • reject

        @Deprecated
        public Q 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 Traversable<T>
        Parameters:
        predicate - A predicate
        Returns:
        a new traversable
      • takeWhile

        public Q 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 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.
      • peek

        public Q 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 Traversable<T>
        Specified by:
        peek in interface Value<T>
        Parameters:
        action - The action that will be performed on the element(s).
        Returns:
        this instance
      • toString

        public java.lang.String toString()
        Description copied from interface: Value
        Clarifies that values have a proper toString() method implemented.

        See Object.toString().

        Specified by:
        toString in interface Value<T>
        Overrides:
        toString in class java.lang.Object
        Returns:
        A String representation of this object