Queue

scala.collection.immutable.Queue
See theQueue companion object

Queue objects implement data structures that allow to insert and retrieve elements in a first-in-first-out (FIFO) manner.

Queue is implemented as a pair of Lists, one containing the in elements and the other the out elements. Elements are added to the in list and removed from the out list. When the out list runs dry, the queue is pivoted by replacing the out list by in.reverse, and in by Nil.

Adding items to the queue always has cost O(1). Removing items has cost O(1), except in the case where a pivot is required, in which case, a cost of O(n) is incurred, where n is the number of elements in the queue. When this happens, n remove operations with O(1) cost are guaranteed. Removing an item is on average O(1).

Attributes

See also

"Scala's Collection Library overview" section on Immutable Queues for more information.

Companion
object
Source
Queue.scala
Graph
Supertypes
trait Serializable
trait LinearSeq[A]
trait LinearSeqOps[A, Queue, Queue[A]]
trait LinearSeq[A]
trait LinearSeqOps[A, Queue, Queue[A]]
class AbstractSeq[A]
trait Seq[A]
trait SeqOps[A, Queue, Queue[A]]
trait Iterable[A]
class AbstractSeq[A]
trait Seq[A]
trait Pure
trait Equals
trait SeqOps[A, Queue, Queue[A]]
trait PartialFunction[Int, A]
trait Int -> A
class AbstractIterable[A]
trait Iterable[A]
trait IterableOps[A, Queue, Queue[A]]
trait IterableOnceOps[A, Queue, Queue[A]]
trait IterableOnce[A]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def appended[B >: A](elem: B): Queue[B]

A copy of this immutable queue with an element appended.

A copy of this immutable queue with an element appended.

Example:

  val a = List(1)
  val b = a :+ 2
  // a is still List(1), b is List(1, 2)

@tparam B the element type of the returned immutable queue. @param elem the appended element @return a new immutable queue consisting of all elements of this immutable queue followed by elem.

Attributes

Definition Classes
Source
Queue.scala
override def appendedAll[B >: A](that: IterableOnce[B]^): Queue[B]

Returns a new immutable queue containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable queue is the most specific superclass encompassing the element types of the two operands.

Returns a new immutable queue containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable queue is the most specific superclass encompassing the element types of the two operands.

Type parameters

B

the element type of the returned collection.

Value parameters

suffix

the iterable to append.

Attributes

Returns

a new collection of type CC[B] which contains all elements of this immutable queue followed by all elements of suffix.

Definition Classes
Source
Queue.scala
override def apply(n: Int): A

Returns the n-th element of this queue. The first element is at position 0.

Returns the n-th element of this queue. The first element is at position 0.

Value parameters

n

index of the element to return

Attributes

Returns

the element at position n in this queue.

Throws
NoSuchElementException

if the queue is too short.

Definition Classes
Source
Queue.scala
def dequeue: (A, Queue[A])

Returns a tuple with the first element in the queue, and a new queue with this element removed.

Returns a tuple with the first element in the queue, and a new queue with this element removed.

Attributes

Returns

the first element of the queue.

Throws
NoSuchElementException

if the queue is empty

Source
Queue.scala
def dequeueOption: Option[(A, Queue[A])]

Optionally retrieves the first element and a queue of the remaining elements.

Optionally retrieves the first element and a queue of the remaining elements.

Attributes

Returns

A tuple of the first element of the queue, and a new queue with this element removed. If the queue is empty, None is returned.

Source
Queue.scala
def enqueue[B >: A](elem: B): Queue[B]

Creates a new queue with element added at the end of the old queue.

Creates a new queue with element added at the end of the old queue.

Type parameters

B

the element type of the returned queue, a supertype of A

Value parameters

elem

the element to insert

Attributes

Returns

a new queue with elem appended at the end

Source
Queue.scala
def enqueueAll[B >: A](iter: Iterable[B]^): Queue[B]

Creates a new queue with all elements provided by an Iterable object added at the end of the old queue.

Creates a new queue with all elements provided by an Iterable object added at the end of the old queue.

The elements are appended in the order they are given out by the iterator.

Type parameters

B

the element type of the returned queue, a supertype of A

Value parameters

iter

an iterable object

Attributes

Returns

a new queue with all elements of iter appended at the end

Source
Queue.scala
override def exists(p: A => Boolean): Boolean

Tests whether a predicate holds for at least one element of this immutable queue.

Tests whether a predicate holds for at least one element of this immutable queue.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

true if the given predicate p is satisfied by at least one element of this immutable queue, otherwise false

Definition Classes
Source
Queue.scala
override def forall(p: A => Boolean): Boolean

Tests whether a predicate holds for all elements of this immutable queue.

Tests whether a predicate holds for all elements of this immutable queue.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

true if this immutable queue is empty or the given predicate p holds for all elements of this immutable queue, otherwise false.

Definition Classes
Source
Queue.scala
def front: A

Returns the first element in the queue, or throws an error if there is no element contained in the queue.

Returns the first element in the queue, or throws an error if there is no element contained in the queue.

Attributes

Returns

the first element.

Throws
NoSuchElementException

if the queue is empty

Source
Queue.scala
override def head: A

Selects the first element of this immutable queue.

Selects the first element of this immutable queue.

Note: Must be overridden in subclasses. The default implementation is inherited from IterableOps.

Attributes

Definition Classes
Source
Queue.scala
override def isEmpty: Boolean

Checks if the queue is empty.

Checks if the queue is empty.

Attributes

Returns

true, iff there is no element in the queue.

Definition Classes
Source
Queue.scala

The companion object of this immutable queue, providing various factory methods.

The companion object of this immutable queue, providing various factory methods.

Attributes

Returns

the companion factory object for this collection type

Note

When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).

Definition Classes
Source
Queue.scala
override def iterator: Iterator[A]

Returns the elements in the list as an iterator

Returns the elements in the list as an iterator

Attributes

Definition Classes
Source
Queue.scala
override def last: A

Selects the last element.

Selects the last element.

Attributes

Returns

The last element of this immutable queue.

Throws
NoSuchElementException

If the immutable queue is empty.

Definition Classes
Source
Queue.scala
override def length: Int

Returns the length of the queue.

Returns the length of the queue.

Attributes

Definition Classes
Source
Queue.scala
override def prepended[B >: A](elem: B): Queue[B]

A copy of the immutable queue with an element prepended.

A copy of the immutable queue with an element prepended.

Also, the original immutable queue is not modified, so you will want to capture the result.

Example:

    val x = List(1)
    val y = 2 +: x
    // x is still List(1), y is List(2, 1)

Type parameters

B

the element type of the returned immutable queue.

Value parameters

elem

the prepended element

Attributes

Returns

a new immutable queue consisting of elem followed by all elements of this immutable queue.

Definition Classes
Source
Queue.scala
override def tail: Queue[A]

The rest of the collection without its first element.

The rest of the collection without its first element.

Note: Must be overridden in subclasses. The default implementation is inherited from IterableOps.

Attributes

Definition Classes
Source
Queue.scala
override def toString(): String

Returns a string representation of this queue.

Returns a string representation of this queue.

Attributes

Definition Classes
Source
Queue.scala

Deprecated methods

final def enqueue[B >: A](iter: Iterable[B]^): Queue[B]

Creates a new queue with all elements provided by an Iterable object added at the end of the old queue.

Creates a new queue with all elements provided by an Iterable object added at the end of the old queue.

The elements are appended in the order they are given out by the iterator.

Value parameters

iter

an iterable object

Attributes

Deprecated
[Since version 2.13.0] Use `enqueueAll` instead of `enqueue` to enqueue a collection of elements
Source
Queue.scala

Inherited methods

final def ++[B >: A](suffix: IterableOnce[B]^): Queue[B]

Alias for concat.

Alias for concat.

Type parameters

B

the element type of the returned collection

Value parameters

suffix

the iterable to append to this immutable queue

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
override def ++:[B >: A](prefix: IterableOnce[B]^): Queue[B]

Alias for prependedAll.

Alias for prependedAll.

Attributes

Definition Classes
Inherited from:
SeqOps
Source
Seq.scala
final def +:[B >: A](elem: B): Queue[B]

Alias for prepended.

Alias for prepended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Attributes

Returns

a new immutable queue consisting of elem followed by all elements of this immutable queue

Inherited from:
SeqOps
Source
Seq.scala
final def :+[B >: A](elem: B): Queue[B]

Alias for appended.

Alias for appended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Attributes

Inherited from:
SeqOps
Source
Seq.scala
def :++[B >: A](suffix: IterableOnce[B]^): Queue[B]

Alias for appendedAll.

Alias for appendedAll.

Attributes

Inherited from:
SeqOps
Source
Seq.scala
final def addString(b: StringBuilder): b.type

Appends all elements of this immutable queue to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this immutable queue without any separator string.

Appends all elements of this immutable queue to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this immutable queue without any separator string.

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    val h = a.addString(b) // 1234

Value parameters

b

the string builder to which elements are appended.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def addString(b: StringBuilder, sep: String): b.type

Appends all elements of this immutable queue to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this immutable queue, separated by the string sep.

Appends all elements of this immutable queue to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this immutable queue, separated by the string sep.

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    a.addString(b, ", ") // 1, 2, 3, 4

Value parameters

b

the string builder to which elements are appended.

sep

the separator string.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def addString(b: StringBuilder, start: String, sep: String, end: String): b.type

Appends all elements of this immutable queue to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this immutable queue are separated by the string sep.

Appends all elements of this immutable queue to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this immutable queue are separated by the string sep.

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    a.addString(b , "List(" , ", " , ")") // List(1, 2, 3, 4)

Value parameters

b

the string builder to which elements are appended.

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def andThen[C](k: PartialFunction[A, C]^): PartialFunction[Int, C]^{k}

Composes this partial function with another partial function that gets applied to results of this partial function.

Composes this partial function with another partial function that gets applied to results of this partial function.

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters

C

the result type of the transformation function.

Value parameters

k

the transformation function

Attributes

Returns

a partial function with the domain of this partial function narrowed by other partial function, which maps arguments x to k(this(x)).

Inherited from:
PartialFunction
Source
PartialFunction.scala
override def andThen[C](k: A => C): PartialFunction[Int, C]^{k}

Composes this partial function with a transformation function that gets applied to results of this partial function.

Composes this partial function with a transformation function that gets applied to results of this partial function.

If the runtime type of the function is a PartialFunction then the other andThen method is used (note its cautions).

Type parameters

C

the result type of the transformation function.

Value parameters

k

the transformation function

Attributes

Returns

a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments x to k(this(x)).

Definition Classes
Inherited from:
PartialFunction
Source
PartialFunction.scala
def applyOrElse[A1 <: Int, B1 >: A](x: A1, default: A1 => B1): B1

Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.

Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.

Note that expression pf.applyOrElse(x, default) is equivalent to

if(pf isDefinedAt x) pf(x) else default(x)

except that applyOrElse method can be implemented more efficiently. For all partial function literals the compiler generates an applyOrElse implementation which avoids double evaluation of pattern matchers and guards. This makes applyOrElse the basis for the efficient implementation for many operations and scenarios, such as:

  • combining partial functions into orElse/andThen chains does not lead to excessive apply/isDefinedAt evaluation
  • lift and unlift do not evaluate source functions twice on each invocation
  • runWith allows efficient imperative-style combining of partial functions with conditionally applied actions

For non-literal partial function classes with nontrivial isDefinedAt method it is recommended to override applyOrElse with custom implementation that avoids double isDefinedAt evaluation. This may result in better performance and more predictable behavior w.r.t. side effects.

Type parameters

A1

the argument type of the fallback function (a subtype of A)

B1

the result type of the fallback function (a supertype of B)

Value parameters

default

the fallback function

x

the function argument

Attributes

Returns

the result of this function or fallback function application.

Inherited from:
PartialFunction
Source
PartialFunction.scala
def canEqual(that: Any): Boolean

Checks whether this instance can possibly equal that.

Checks whether this instance can possibly equal that.

A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

Value parameters

that

the value being probed for possible equality

Attributes

Returns

true if this instance can possibly equal that, otherwise false

Inherited from:
Seq
Source
Seq.scala
override def collect[B](pf: PartialFunction[A, B]^): Queue[B]

Builds a new immutable queue by applying a partial function to all elements of this immutable queue on which the function is defined.

Builds a new immutable queue by applying a partial function to all elements of this immutable queue on which the function is defined.

Type parameters

B

the element type of the returned immutable queue.

Value parameters

pf

the partial function which filters and maps the immutable queue.

Attributes

Returns

a new immutable queue resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def collectFirst[B](pf: PartialFunction[A, B]^): Option[B]

Finds the first element of the immutable queue for which the given partial function is defined, and applies the partial function to it.

Finds the first element of the immutable queue for which the given partial function is defined, and applies the partial function to it.

Type parameters

B

the result type of the partial function

Value parameters

pf

the partial function

Attributes

Returns

an option value containing pf applied to the first value for which it is defined, or None if none exists.

Example

Seq("a", 1, 5L).collectFirst { case x: Int => x*10 } = Some(10)

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Iterates over combinations of elements.

Iterates over combinations of elements.

A combination of length n is a sequence of n elements selected in order of their first index in this sequence.

For example, "xyx" has two combinations of length 2. The x is selected first: "xx", "xy". The sequence "yx" is not returned as a combination because it is subsumed by "xy".

If there is more than one way to generate the same combination, only one will be returned.

For example, the result "xy" arbitrarily selected one of the x elements.

As a further illustration, "xyxx" has three different ways to generate "xy" because there are three elements x to choose from. Moreover, there are three unordered pairs "xx" but only one is returned.

It is not specified which of these equal combinations is returned. It is an implementation detail that should not be relied on. For example, the combination "xx" does not necessarily contain the first x in this sequence. This behavior is observable if the elements compare equal but are not identical.

As a consequence, "xyx".combinations(3).next() is "xxy": the combination does not reflect the order of the original sequence, but the order in which elements were selected, by "first index"; the order of each x element is also arbitrary.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Value parameters

n

the number of elements in each combination

Attributes

Returns

An Iterator which traverses the n-element combinations of this immutable queue.

Example
  Seq('a', 'b', 'b', 'b', 'c').combinations(2).foreach(println)
  // List(a, b)
  // List(a, c)
  // List(b, b)
  // List(b, c)
  Seq('b', 'a', 'b').combinations(2).foreach(println)
  // List(b, b)
  // List(b, a)
Inherited from:
SeqOps
Source
Seq.scala
def compose[R](k: PartialFunction[R, Int]^): PartialFunction[R, A]^{k}

Composes another partial function k with this partial function so that this partial function gets applied to results of k.

Composes another partial function k with this partial function so that this partial function gets applied to results of k.

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters

R

the parameter type of the transformation function.

Value parameters

k

the transformation function

Attributes

Returns

a partial function with the domain of other partial function narrowed by this partial function, which maps arguments x to this(k(x)).

Inherited from:
PartialFunction
Source
PartialFunction.scala
def compose[A](g: A -> Int): A -> A

Composes two instances of Function1 in a new Function1, with this function applied last.

Composes two instances of Function1 in a new Function1, with this function applied last.

Type parameters

A

the type to which function g can be applied

Value parameters

g

a function A => T1

Attributes

Returns

a new function f such that f(x) == apply(g(x))

Inherited from:
Function1
Source
Function1.scala
override def concat[B >: A](suffix: IterableOnce[B]^): Queue[B]

Returns a new immutable queue containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable queue is the most specific superclass encompassing the element types of the two operands.

Returns a new immutable queue containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable queue is the most specific superclass encompassing the element types of the two operands.

Type parameters

B

the element type of the returned collection.

Value parameters

suffix

the iterable to append.

Attributes

Returns

a new immutable queue which contains all elements of this immutable queue followed by all elements of suffix.

Definition Classes
Inherited from:
SeqOps
Source
Seq.scala
override def contains[A1 >: A](elem: A1): Boolean

Tests whether this immutable queue contains a given value as an element.

Tests whether this immutable queue contains a given value as an element.

Type parameters

A1

the type of the element to test (a supertype of A)

Value parameters

elem

the element to test.

Attributes

Returns

true if this immutable queue has an element that is equal (as determined by ==) to elem, false otherwise.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
def containsSlice[B >: A](that: Seq[B]): Boolean

Tests whether this immutable queue contains a given sequence as a slice.

Tests whether this immutable queue contains a given sequence as a slice.

Type parameters

B

the element type used for comparison (a supertype of A)

Value parameters

that

the sequence to test

Attributes

Returns

true if this immutable queue contains a slice with the same elements as that, otherwise false.

Inherited from:
SeqOps
Source
Seq.scala
def copyToArray[B >: A](dest: Array[B], start: Int, n: Int): Int

Copies elements to an array and returns the number of elements written.

Copies elements to an array and returns the number of elements written.

Fills the given array dest starting at index start with at most n elements of this immutable queue.

Copying will stop once either all the elements of this immutable queue have been copied, or the end of the array is reached, or n elements have been copied.

If start is less than zero, it is taken as zero.

Type parameters

B

the type of the elements of the array.

Value parameters

dest

the array to fill.

n

the maximal number of elements to copy.

start

the starting index of xs.

Attributes

Returns

the number of elements written to the array

Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def copyToArray[B >: A](dest: Array[B], start: Int): Int

Copies elements to an array, returning the number of elements written.

Copies elements to an array, returning the number of elements written.

Fills the given array dest starting at index start with values of this immutable queue.

Copying will stop once either all the elements of this immutable queue have been copied, or the end of the array is reached.

Type parameters

B

the type of the elements of the array.

Value parameters

dest

the array to fill.

start

the starting index of xs.

Attributes

Returns

the number of elements written to the array

Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def copyToArray[B >: A](dest: Array[B]): Int

Copies elements to an array, returning the number of elements written.

Copies elements to an array, returning the number of elements written.

Fills the given array dest starting at index start with values of this immutable queue.

Copying will stop once either all the elements of this immutable queue have been copied, or the end of the array is reached.

Type parameters

B

the type of the elements of the array.

Value parameters

dest

the array to fill.

Attributes

Returns

the number of elements written to the array

Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def corresponds[B](that: IterableOnce[B]^)(p: (A, B) => Boolean): Boolean

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Type parameters

B

the type of the elements of that

Value parameters

p

the test predicate, which relates elements from both collections

that

the other collection

Attributes

Returns

true if both collections have the same length and p(x, y) is true for all corresponding elements x of this iterator and y of that, otherwise false

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def corresponds[B](that: Seq[B])(p: (A, B) => Boolean): Boolean

Tests whether every element of this immutable queue relates to the corresponding element of another sequence by satisfying a test predicate.

Tests whether every element of this immutable queue relates to the corresponding element of another sequence by satisfying a test predicate.

Type parameters

B

the type of the elements of that

Value parameters

p

the test predicate, which relates elements from both sequences

that

the other sequence

Attributes

Returns

true if both sequences have the same length and p(x, y) is true for all corresponding elements x of this immutable queue and y of that, otherwise false.

Inherited from:
SeqOps
Source
Seq.scala
def count(p: A => Boolean): Int

Counts the number of elements in the immutable queue which satisfy a predicate.

Counts the number of elements in the immutable queue which satisfy a predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the number of elements satisfying the predicate p.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def diff[B >: A](that: Seq[B]): Queue[A]

Computes the multiset difference between this immutable queue and another sequence.

Computes the multiset difference between this immutable queue and another sequence.

Type parameters

B

the element type used for comparison (a supertype of A)

Value parameters

that

the sequence of elements to remove

Attributes

Returns

a new immutable queue which contains all elements of this immutable queue except some of the occurrences of elements that also appear in that. If an element value x appears n times in that, then the first n occurrences of x will not form part of the result, but any following occurrences will.

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala
def distinct: Queue[A]

Selects all the elements of this immutable queue ignoring the duplicates.

Selects all the elements of this immutable queue ignoring the duplicates.

Attributes

Returns

a new immutable queue consisting of all the elements of this immutable queue without duplicates.

Inherited from:
SeqOps
Source
Seq.scala
override def distinctBy[B](f: A -> B): Queue[A]

Selects all the elements of this immutable queue ignoring the duplicates as determined by == after applying the transforming function f.

Selects all the elements of this immutable queue ignoring the duplicates as determined by == after applying the transforming function f.

Type parameters

B

the type of the elements after being transformed by f

Value parameters

f

The transforming function whose result is used to determine the uniqueness of each element

Attributes

Returns

a new immutable queue consisting of all the elements of this immutable queue without duplicates.

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala
override def drop(n: Int): Queue[A]

Selects all elements except the first n ones.

Selects all elements except the first n ones.

Value parameters

n

the number of elements to drop from this immutable queue.

Attributes

Returns

a immutable queue consisting of all elements of this immutable queue except the first n ones, or else the empty immutable queue, if this immutable queue has less than n elements. If n is negative, don't drop any elements.

Definition Classes
Inherited from:
StrictOptimizedLinearSeqOps
Source
LinearSeq.scala
override def dropRight(n: Int): Queue[A]

The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.

The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Value parameters

n

the number of elements to drop from the end of this collection

Attributes

Returns

a new collection containing all elements of this collection except the last n, or an empty collection if n is greater than or equal to the size, or all elements if n is non-positive

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def dropWhile(p: A => Boolean): Queue[A]

Selects all elements except the longest prefix that satisfies a predicate.

Selects all elements except the longest prefix that satisfies a predicate.

The matching prefix starts with the first element of this immutable queue, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire immutable queue.

Example:

    List(1, 2, 3, 100, 4).dropWhile(n => n < 10) // List(100, 4)
    List(1, 2, 3, 100, 4).dropWhile(n => n == 0) // List(1, 2, 3, 100, 4)

Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the predicate.

Value parameters

p

The predicate used to test elements.

Attributes

Returns

the longest suffix of this immutable queue whose first element does not satisfy the predicate p.

Definition Classes
Inherited from:
StrictOptimizedLinearSeqOps
Source
LinearSeq.scala

Returns an extractor object with a unapplySeq method, which extracts each element of a sequence data.

Returns an extractor object with a unapplySeq method, which extracts each element of a sequence data.

Attributes

Returns

an extractor object that uses unapplySeq to extract each element of a sequence matching this partial function

Example
         val firstChar: String => Option[Char] = _.headOption
         Seq("foo", "bar", "baz") match {
           case firstChar.unlift.elementWise(c0, c1, c2) =>
             println(s"$c0, $c1, $c2") // Output: f, b, b
         }
Inherited from:
PartialFunction
Source
PartialFunction.scala
override def empty: Queue[A]

The empty immutable queue.

The empty immutable queue.

Attributes

Returns

an empty iterable of type immutable.Queue.

Definition Classes
Inherited from:
IterableFactoryDefaults
Source
Iterable.scala
def endsWith[B >: A](that: Iterable[B]^): Boolean

Tests whether this immutable queue ends with the given sequence.

Tests whether this immutable queue ends with the given sequence.

Type parameters

B

the element type used for comparison (a supertype of A)

Value parameters

that

the sequence to test

Attributes

Returns

true if this immutable queue has that as a suffix, false otherwise.

Inherited from:
SeqOps
Source
Seq.scala
override def equals(o: Any): Boolean

Checks whether this instance is equal to that. This universal equality method is defined in AnyRef.

Checks whether this instance is equal to that. This universal equality method is defined in AnyRef.

Value parameters

that

the object to compare for equality with this instance

Attributes

Definition Classes
Seq -> Equals -> Object -> Any
Inherited from:
Seq
Source
Seq.scala
override def filter(pred: A => Boolean): Queue[A]

Selects all elements of this immutable queue which satisfy a predicate.

Selects all elements of this immutable queue which satisfy a predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

a new immutable queue consisting of all elements of this immutable queue that satisfy the given predicate p. The order of the elements is preserved.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def filterNot(pred: A => Boolean): Queue[A]

Selects all elements of this immutable queue which do not satisfy a predicate.

Selects all elements of this immutable queue which do not satisfy a predicate.

Value parameters

pred

the predicate used to test elements.

Attributes

Returns

a new immutable queue consisting of all elements of this immutable queue that do not satisfy the given predicate pred. Their order may not be preserved.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def find(p: A => Boolean): Option[A]

Finds the first element of the immutable queue satisfying a predicate, if any.

Finds the first element of the immutable queue satisfying a predicate, if any.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

an option value containing the first element in the immutable queue that satisfies p, or None if none exists.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
override def findLast(p: A => Boolean): Option[A]

Finds the last element of the immutable queue satisfying a predicate, if any.

Finds the last element of the immutable queue satisfying a predicate, if any.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

an option value containing the last element in the immutable queue that satisfies p, or None if none exists.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
override def flatMap[B](f: A => IterableOnce[B]^): Queue[B]

Builds a new immutable queue by applying a function to all elements of this immutable queue and using the elements of the resulting collections.

Builds a new immutable queue by applying a function to all elements of this immutable queue and using the elements of the resulting collections.

For example:

    def getWords(lines: Seq[String]): Seq[String] = lines.flatMap(line => line.split("\\W+"))

The type of the resulting collection is guided by the static type of this immutable queue. This might cause unexpected results sometimes. For example:

    // lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
    def lettersOf(words: Seq[String]) = words.flatMap(word => word.toSet)

    // lettersOf2 will return a Set[Char], not a Seq
    def lettersOf2(words: Seq[String]) = words.toSet.flatMap(word => word.toSeq)

    // xs will be an Iterable[Int]
    val xs = Map("a" -> List(11, 111), "b" -> List(22, 222)).flatMap(_._2)

    // ys will be a Map[Int, Int]
    val ys = Map("a" -> List(1 -> 11, 1 -> 111), "b" -> List(2 -> 22, 2 -> 222)).flatMap(_._2)

Type parameters

B

the element type of the returned collection.

Value parameters

f

the function to apply to each element.

Attributes

Returns

a new immutable queue resulting from applying the given collection-valued function f to each element of this immutable queue and concatenating the results.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def flatten[B](implicit toIterableOnce: A -> IterableOnce[B]): Queue[B]

Given that the elements of this collection are themselves iterable collections, converts this immutable queue into a immutable queue comprising the elements of these iterable collections.

Given that the elements of this collection are themselves iterable collections, converts this immutable queue into a immutable queue comprising the elements of these iterable collections.

The resulting collection's type will be guided by the type of immutable queue. For example:

  val xs = List(
             Set(1, 2, 3),
             Set(1, 2, 3)
           ).flatten
  // xs == List(1, 2, 3, 1, 2, 3)

  val ys = Set(
             List(1, 2, 3),
             List(3, 2, 1)
           ).flatten
  // ys == Set(1, 2, 3)

Type parameters

B

the type of the elements of each iterable collection.

Value parameters

asIterable

an implicit conversion which asserts that the element type of this immutable queue is an Iterable.

Attributes

Returns

a new immutable queue resulting from concatenating all element collections.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

Applies the given binary operator op to the given initial value z and all elements of this immutable queue.

Applies the given binary operator op to the given initial value z and all elements of this immutable queue.

For each application of the operator, each operand is either an element of this immutable queue, the initial value, or another such application of the operator.

        The order of applications of the operator is unspecified and may be nondeterministic.
        Each element appears exactly once in the computation.

The initial value may be used an arbitrary number of times, but at least once.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative. In either case, it is also necessary that the initial value

be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.

The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

Type parameters

A1

The type parameter for the binary operator, a supertype of A.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

z

An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for op for the result to always be the same across runs.

Attributes

Returns

The result of applying op between all the elements and z, or z if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def foldLeft[B](z: B)(op: (B, A) => B): B

Applies the given binary operator op to the given initial value z and all elements of this immutable queue, going left to right. Returns the initial value if this immutable queue is empty.

Applies the given binary operator op to the given initial value z and all elements of this immutable queue, going left to right. Returns the initial value if this immutable queue is empty.

"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable queue, the result is op( op( ... op( op(z, x,,1,,), x,,2,,) ... ), x,,n,,).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this immutable queue and the initial value all appear exactly once in the computation.

Type parameters

B

The result type of the binary operator.

Value parameters

op

A binary operator.

z

An initial value.

Attributes

Returns

The result of applying op to z and all elements of this immutable queue, going left to right. Returns z if this immutable queue is empty.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
def foldRight[B](z: B)(op: (A, B) => B): B

Applies the given binary operator op to all elements of this immutable queue and the given initial value z, going right to left. Returns the initial value if this immutable queue is empty.

Applies the given binary operator op to all elements of this immutable queue and the given initial value z, going right to left. Returns the initial value if this immutable queue is empty.

"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable queue, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n,,, z) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this immutable queue and the initial value all appear exactly once in the computation.

Type parameters

B

The result type of the binary operator.

Value parameters

op

A binary operator.

z

An initial value.

Attributes

Returns

The result of applying op to all elements of this immutable queue and z, going right to left. Returns z if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def foreach[U](f: A => U): Unit

Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

Type parameters

U

the return type of f; the value is discarded, but the type parameter aids type inference

Value parameters

f

the function to apply to each element for its side effects

Attributes

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
protected def fromSpecific(coll: IterableOnce[A]^): Queue[A]

Defines how to turn a given Iterable[A] into a collection of type C.

Defines how to turn a given Iterable[A] into a collection of type C.

This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.

Value parameters

coll

the source collection to convert

Attributes

Returns

a new collection of type C containing the elements of coll

Note

When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.

As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as it is called with an Iterable[A] obtained from this collection (as it is the case in the implementations of operations where we use a View[A]), it is safe.

Inherited from:
IterableFactoryDefaults
Source
Iterable.scala
def groupBy[K](f: A => K): Map[K, Queue[A]]

Partitions this immutable queue into a map of immutable queues according to some discriminator function.

Partitions this immutable queue into a map of immutable queues according to some discriminator function.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

K

the type of keys returned by the discriminator function.

Value parameters

f

the discriminator function.

Attributes

Returns

A map from keys to immutable queues such that the following invariant holds:

               (xs groupBy f)(k) = xs filter (x => f(x) == k)
         That is, every key `k` is bound to a immutable queue of those elements `x`
         for which `f(x)` equals `k`.
Inherited from:
IterableOps
Source
Iterable.scala
def groupMap[K, B](key: A => K)(f: A => B): Map[K, Queue[B]]

Partitions this immutable queue into a map of immutable queues according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

Partitions this immutable queue into a map of immutable queues according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

It is equivalent to groupBy(key).mapValues(_.map(f)), but more efficient.

 case class User(name: String, age: Int)

 def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
   users.groupMap(_.age)(_.name)
        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function

Value parameters

f

the element transformation function

key

the discriminator function

Attributes

Returns

a map associating each key k produced by key with a immutable queue of values produced by applying f to elements that map to k

Inherited from:
IterableOps
Source
Iterable.scala
def groupMapReduce[K, B](key: A => K)(f: A => B)(reduce: (B, B) => B): Map[K, B]

Partitions this immutable queue into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.

Partitions this immutable queue into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.

It is equivalent to groupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.

 def occurrences[A](as: Seq[A]): Map[A, Int] =
   as.groupMapReduce(identity)(_ => 1)(_ + _)
        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function

Value parameters

f

the element transformation function

key

the discriminator function

reduce

the reduction function used to combine values mapped to the same key

Attributes

Returns

a map associating each key k produced by key with the reduction of all values produced by applying f to elements that map to k

Inherited from:
IterableOps
Source
Iterable.scala
def grouped(size: Int): Iterator[Queue[A]]

Partitions elements in fixed size immutable queues.

Partitions elements in fixed size immutable queues.

Value parameters

size

the number of elements per group

Attributes

Returns

An iterator producing immutable queues of size size, except the last will be less than size size if the elements don't divide evenly.

See also

scala.collection.Iterator, method grouped

Inherited from:
IterableOps
Source
Iterable.scala
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Seq -> Object -> Any
Inherited from:
Seq
Source
Seq.scala
override def headOption: Option[A]

Optionally selects the first element.

Optionally selects the first element.

Attributes

Returns

the first element of this immutable queue if it is nonempty, None if it is empty.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
def indexOf[B >: A](elem: B): Int

Finds index of first occurrence of some value in this immutable queue.

Finds index of first occurrence of some value in this immutable queue.

Type parameters

B

the type of the element elem.

Value parameters

elem

the element value to search for.

Attributes

Returns

the index >= 0 of the first element of this immutable queue that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:
SeqOps
Source
Seq.scala
def indexOf[B >: A](elem: B, from: Int): Int

Finds index of first occurrence of some value in this immutable queue after or at some start index.

Finds index of first occurrence of some value in this immutable queue after or at some start index.

Type parameters

B

the type of the element elem.

Value parameters

elem

the element value to search for.

from

the start index

Attributes

Returns

the index >= from of the first element of this immutable queue that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:
SeqOps
Source
Seq.scala
def indexOfSlice[B >: A](that: Seq[B]): Int

Finds first index where this immutable queue contains a given sequence as a slice.

Finds first index where this immutable queue contains a given sequence as a slice.

Value parameters

that

the sequence to test

Attributes

Returns

the first index >= 0 such that the elements of this immutable queue starting at this index match the elements of sequence that, or -1 if no such subsequence exists.

Inherited from:
SeqOps
Source
Seq.scala
def indexOfSlice[B >: A](that: Seq[B], from: Int): Int

Finds first index after or at a start index where this immutable queue contains a given sequence as a slice.

Finds first index after or at a start index where this immutable queue contains a given sequence as a slice.

Type parameters

B

the element type used for comparison (a supertype of A)

Value parameters

from

the start index

that

the sequence to test

Attributes

Returns

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

Inherited from:
SeqOps
Source
Seq.scala
def indexWhere(p: A => Boolean): Int

Finds index of the first element satisfying some predicate.

Finds index of the first element satisfying some predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the index >= 0 of the first element of this immutable queue that satisfies the predicate p, or -1, if none exists.

Inherited from:
SeqOps
Source
Seq.scala
override def indexWhere(p: A => Boolean, from: Int): Int

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

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

Value parameters

from

the start index

p

the predicate used to test elements.

Attributes

Returns

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

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
def indices: Range

Produces the range of all indices of this sequence.

Produces the range of all indices of this sequence.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns

a Range value from 0 to one less than the length of this immutable queue.

Inherited from:
SeqOps
Source
Seq.scala
def init: Queue[A]

The initial part of the collection without its last element.

The initial part of the collection without its last element.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
def inits: Iterator[Queue[A]]

Iterates over the inits of this immutable queue. The first value will be this immutable queue and the final one will be an empty immutable queue, with the intervening values the results of successive applications of init.

Iterates over the inits of this immutable queue. The first value will be this immutable queue and the final one will be an empty immutable queue, with the intervening values the results of successive applications of init.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns

an iterator over all the inits of this immutable queue

Example

List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

Inherited from:
IterableOps
Source
Iterable.scala
override def intersect[B >: A](that: Seq[B]): Queue[A]

Computes the multiset intersection between this immutable queue and another sequence.

Computes the multiset intersection between this immutable queue and another sequence.

Type parameters

B

the element type used for comparison (a supertype of A)

Value parameters

that

the sequence of elements to intersect with.

Attributes

Returns

a new immutable queue which contains all elements of this immutable queue which also appear in that. If an element value x appears n times in that, then the first n occurrences of x will be retained in the result, but any following occurrences will be omitted.

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala
override def isDefinedAt(x: Int): Boolean

Tests whether this immutable queue contains given index.

Tests whether this immutable queue contains given index.

The implementations of methods apply and isDefinedAt turn a Seq[A] into a PartialFunction[Int, A].

Value parameters

idx

the index to test

Attributes

Returns

true if this immutable queue contains an element at position idx, false otherwise.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
override def isTraversableAgain: Boolean

Tests whether this immutable queue can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Tests whether this immutable queue can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Attributes

Returns

true if it is repeatedly traversable, false otherwise.

Definition Classes
Inherited from:
IterableOps
Source
Iterable.scala
def knownSize: Int

The number of elements in this immutable queue, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

The number of elements in this immutable queue, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

Attributes

Inherited from:
IterableOnce
Source
IterableOnce.scala
def lastIndexOf[B >: A](elem: B, end: Int = ...): Int

Finds index of last occurrence of some value in this immutable queue before or at a given end index.

Finds index of last occurrence of some value in this immutable queue before or at a given end index.

Type parameters

B

the type of the element elem.

Value parameters

elem

the element value to search for.

end

the end index.

Attributes

Returns

the index &lt;= end of the last element of this immutable queue that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:
SeqOps
Source
Seq.scala
def lastIndexOfSlice[B >: A](that: Seq[B]): Int

Finds last index where this immutable queue contains a given sequence as a slice.

Finds last index where this immutable queue contains a given sequence as a slice.

Value parameters

that

the sequence to test

Attributes

Returns

the last index such that the elements of this immutable queue starting at this index match the elements of sequence that, or -1 if no such subsequence exists.

Inherited from:
SeqOps
Source
Seq.scala
def lastIndexOfSlice[B >: A](that: Seq[B], end: Int): Int

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

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

Type parameters

B

the element type used for comparison (a supertype of A)

Value parameters

end

the end index

that

the sequence to test

Attributes

Returns

the last index &lt;= end such that the elements of this immutable queue starting at this index match the elements of sequence that, or -1 if no such subsequence exists.

Inherited from:
SeqOps
Source
Seq.scala
def lastIndexWhere(p: A => Boolean): Int

Finds index of last element satisfying some predicate.

Finds index of last element satisfying some predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the index of the last element of this immutable queue that satisfies the predicate p, or -1, if none exists.

Inherited from:
SeqOps
Source
Seq.scala
override def lastIndexWhere(p: A => Boolean, end: Int): Int

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

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

Value parameters

end

the maximum index to consider (inclusive)

p

the predicate used to test elements.

Attributes

Returns

the index &lt;= end of the last element of this immutable queue that satisfies the predicate p, or -1, if none exists.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
def lastOption: Option[A]

Optionally selects the last element.

Optionally selects the last element.

Attributes

Returns

the last element of this immutable queue if it is nonempty, None if it is empty.

Inherited from:
IterableOps
Source
Iterable.scala
def lazyZip[B](that: Iterable[B]^): LazyZip2[A, B, this.type]^{that}

Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.

  val xs = List(1, 2, 3)
  val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
  // res == List(4, 8, 12)

Type parameters

B

the type of the second element in each eventual pair

Value parameters

that

the iterable providing the second element of each eventual pair

Attributes

Returns

a decorator LazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip. Implicit conversion to Iterable[(A, B)] is also supported.

Inherited from:
Iterable
Source
Iterable.scala
override def lengthCompare(that: Iterable[_]^): Int

Compares the length of this immutable queue to the size of another Iterable.

Compares the length of this immutable queue to the size of another Iterable.

Value parameters

that

the Iterable whose size is compared with this immutable queue's length.

Attributes

Returns

A value x where

      x <  0       if this.length <  that.size
      x == 0       if this.length == that.size
      x >  0       if this.length >  that.size

The method as implemented here does not call length or size directly; its running time is O(this.length min that.size) instead of O(this.length + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
override def lengthCompare(len: Int): Int

Compares the length of this immutable queue to a test value.

Compares the length of this immutable queue to a test value.

Value parameters

len

the test value that gets compared with the length.

Attributes

Returns

A value x where

      x <  0       if this.length <  len
      x == 0       if this.length == len
      x >  0       if this.length >  len

The method as implemented here does not call length directly; its running time is O(length min len) instead of O(length). The method should be overridden if computing length is cheap and knownSize returns -1.

See also
Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala

Returns a value class containing operations for comparing the length of this immutable queue to a test value.

Returns a value class containing operations for comparing the length of this immutable queue to a test value.

These operations are implemented in terms of `lengthCompare(Int)`, and allow the following more readable usages:

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0

Attributes

Returns

an object providing =, and > operations for comparing the length

Inherited from:
SeqOps
Source
Seq.scala
def lift: Int ->{this} Option[A]

Turns this partial function into a plain function returning an Option result.

Turns this partial function into a plain function returning an Option result.

Attributes

Returns

a function that takes an argument x to Some(this(x)) if this is defined for x, and to None otherwise.

See also

Function.unlift

Inherited from:
PartialFunction
Source
PartialFunction.scala
override def map[B](f: A => B): Queue[B]

Builds a new immutable queue by applying a function to all elements of this immutable queue.

Builds a new immutable queue by applying a function to all elements of this immutable queue.

Type parameters

B

the element type of the returned immutable queue .

Value parameters

f

the function to apply to each element.

Attributes

Returns

a new immutable queue resulting from applying the given function f to each element of this immutable queue and collecting the results.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def max[B >: A](implicit ord: Ordering[B]): A

Finds the largest element.

Finds the largest element.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

the largest element of this immutable queue with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxBy[B](f: A -> B)(implicit ord: Ordering[B]): A

Finds the first element which yields the largest value measured by function f.

Finds the first element which yields the largest value measured by function f.

Type parameters

B

The result type of the function f.

Value parameters

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

the first element of this immutable queue with the largest value measured by function f with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxByOption[B](f: A -> B)(implicit ord: Ordering[B]): Option[A]

Finds the first element which yields the largest value measured by function f.

Finds the first element which yields the largest value measured by function f.

Type parameters

B

The result type of the function f.

Value parameters

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the first element of this immutable queue with the largest value measured by function f with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxOption[B >: A](implicit ord: Ordering[B]): Option[A]

Finds the largest element.

Finds the largest element.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the largest element of this immutable queue with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def min[B >: A](implicit ord: Ordering[B]): A

Finds the smallest element.

Finds the smallest element.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

the smallest element of this immutable queue with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minBy[B](f: A -> B)(implicit ord: Ordering[B]): A

Finds the first element which yields the smallest value measured by function f.

Finds the first element which yields the smallest value measured by function f.

Type parameters

B

The result type of the function f.

Value parameters

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

the first element of this immutable queue with the smallest value measured by function f with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minByOption[B](f: A -> B)(implicit ord: Ordering[B]): Option[A]

Finds the first element which yields the smallest value measured by function f.

Finds the first element which yields the smallest value measured by function f.

Type parameters

B

The result type of the function f.

Value parameters

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the first element of this immutable queue with the smallest value measured by function f with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minOption[B >: A](implicit ord: Ordering[B]): Option[A]

Finds the smallest element.

Finds the smallest element.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the smallest element of this immutable queue with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString: String

Displays all elements of this immutable queue in a string.

Displays all elements of this immutable queue in a string.

Delegates to addString, which can be overridden.

Attributes

Returns

a string representation of this immutable queue. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable queue follow each other without any separator string.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString(sep: String): String

Displays all elements of this immutable queue in a string using a separator string.

Displays all elements of this immutable queue in a string using a separator string.

Delegates to addString, which can be overridden.

Value parameters

sep

the separator string.

Attributes

Returns

a string representation of this immutable queue. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable queue are separated by the string sep.

Example

List(1, 2, 3).mkString("|") = "1|2|3"

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString(start: String, sep: String, end: String): String

Displays all elements of this immutable queue in a string using start, end, and separator strings.

Displays all elements of this immutable queue in a string using start, end, and separator strings.

Delegates to addString, which can be overridden.

Value parameters

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

Returns

a string representation of this immutable queue. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this immutable queue are separated by the string sep.

Example

List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
protected def newSpecificBuilder: Builder[A, Queue[A]]

Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList),

Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList),

Attributes

Returns

a strict builder for the same collection type. it is possible to implement this method but the resulting Builder will break laziness. As a consequence, operations should preferably be implemented with fromSpecific instead of this method.

Note

When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.

As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as the returned builder is only fed with A values taken from this instance, it is safe.

Inherited from:
IterableFactoryDefaults
Source
Iterable.scala

Tests whether the immutable queue is not empty.

Tests whether the immutable queue is not empty.

Attributes

Returns

true if the immutable queue contains at least one element, false otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def orElse[A1 <: Int, B1 >: A](that: PartialFunction[A1, B1]^): PartialFunction[A1, B1]^{that}

Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

Type parameters

A1

the argument type of the fallback function

B1

the result type of the fallback function

Value parameters

that

the fallback function

Attributes

Returns

a partial function which has as domain the union of the domains of this partial function and that. The resulting partial function takes x to this(x) where this is defined, and to that(x) where it is not.

Inherited from:
PartialFunction
Source
PartialFunction.scala
override def padTo[B >: A](len: Int, elem: B): Queue[B]

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

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

Type parameters

B

the element type of the returned immutable queue.

Value parameters

elem

the padding value

len

the target length

Attributes

Returns

a new immutable queue consisting of all elements of this immutable queue followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala
override def partition(p: A => Boolean): (Queue[A], Queue[A])

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

The two immutable queue correspond to the result of filter and filterNot, respectively.

The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.

Value parameters

p

the predicate used to test elements

Attributes

Returns

a pair of immutable queues: the first containing all elements that satisfy p, the second containing those that do not

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def partitionMap[A1, A2](f: A => Either[A1, A2]): (Queue[A1], Queue[A2])

Applies a function f to each element of the immutable queue and returns a pair of immutable queues: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Applies a function f to each element of the immutable queue and returns a pair of immutable queues: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Example:

  val xs = $Coll(1, "one", 2, "two", 3, "three") partitionMap {
   case i: Int => Left(i)
   case s: String => Right(s)
  }
  // xs == ($Coll(1, 2, 3),
  //        $Coll(one, two, three))

Type parameters

A1

the element type of the first resulting collection

A2

the element type of the second resulting collection

Value parameters

f

the 'split function' mapping the elements of this immutable queue to an scala.util.Either

Attributes

Returns

a pair of immutable queues: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def patch[B >: A](from: Int, other: IterableOnce[B]^, replaced: Int): Queue[B]

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

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

Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original immutable queue appends the patch to the end. If the replaced count would exceed the available elements, the difference in excess is ignored.

Type parameters

B

the element type of the returned immutable queue.

Value parameters

from

the index of the first replaced element

other

the replacement sequence

replaced

the number of elements to drop in the original immutable queue

Attributes

Returns

a new immutable queue consisting of all elements of this immutable queue except that replaced elements starting from from are replaced by all the elements of other.

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala

Iterates over distinct permutations of elements.

Iterates over distinct permutations of elements.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns

An Iterator which traverses the distinct permutations of this immutable queue.

Example
  Seq('a', 'b', 'b').permutations.foreach(println)
  // List(a, b, b)
  // List(b, a, b)
  // List(b, b, a)
Inherited from:
SeqOps
Source
Seq.scala
override def prependedAll[B >: A](prefix: IterableOnce[B]^): Queue[B]

As with :++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

As with :++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from :++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Type parameters

B

the element type of the returned collection.

Value parameters

prefix

the iterable to prepend.

Attributes

Returns

a new immutable queue which contains all elements of prefix followed by all the elements of this immutable queue.

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala
def product[B >: A](implicit num: Numeric[B]): B

Multiplies together the elements of this collection.

Multiplies together the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Type parameters

B

the result type of the * operator.

Value parameters

num

an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

Attributes

Returns

the product of all elements of this immutable queue with respect to the * operator in num.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduce[B >: A](op: (B, B) => B): B

Applies the given binary operator op to all elements of this immutable queue.

Applies the given binary operator op to all elements of this immutable queue.

For each application of the operator, each operand is either an element of this immutable queue or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative.

Type parameters

B

The type parameter for the binary operator, a supertype of A.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

The result of applying op between all the elements if the immutable queue is nonempty.

Throws
UnsupportedOperationException

if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceLeft[B >: A](op: (B, A) => B): B

Applies the given binary operator op to all elements of this immutable queue, going left to right.

Applies the given binary operator op to all elements of this immutable queue, going left to right.

"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable queue, the result is op( op( op( ... op(x,,1,,, x,,2,,) ... ), x,,n-1,,), x,,n,,).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this immutable queue and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of applying op to all elements of this immutable queue, going left to right.

Throws
UnsupportedOperationException

if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

If this immutable queue is nonempty, reduces it with the given binary operator op, going left to right.

If this immutable queue is nonempty, reduces it with the given binary operator op, going left to right.

The behavior is the same as reduceLeft except that the value is None if the immutable queue is empty. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of reducing this immutable queue with op going left to right if the immutable queue is nonempty, inside a Some, and None otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceOption[B >: A](op: (B, B) => B): Option[B]

If this immutable queue is nonempty, reduces it with the given binary operator op.

If this immutable queue is nonempty, reduces it with the given binary operator op.

The behavior is the same as reduce except that the value is None if the immutable queue is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative.

Type parameters

B

A type parameter for the binary operator, a supertype of A.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

The result of reducing this immutable queue with op if the immutable queue is nonempty, inside a Some, and None otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceRight[B >: A](op: (A, B) => B): B

Applies the given binary operator op to all elements of this immutable queue, going right to left.

Applies the given binary operator op to all elements of this immutable queue, going right to left.

"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable queue, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n-1,,, x,,n,,) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this immutable queue and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of applying op to all elements of this immutable queue, going right to left.

Throws
UnsupportedOperationException

if this immutable queue is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceRightOption[B >: A](op: (A, B) => B): Option[B]

If this immutable queue is nonempty, reduces it with the given binary operator op, going right to left.

If this immutable queue is nonempty, reduces it with the given binary operator op, going right to left.

The behavior is the same as reduceRight except that the value is None if the immutable queue is empty. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of reducing this immutable queue with op going right to left if the immutable queue is nonempty, inside a Some, and None otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reverse: Queue[A]

Returns a new immutable queue with the elements of this immutable queue in reverse order.

Returns a new immutable queue with the elements of this immutable queue in reverse order.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Attributes

Returns

a new immutable queue with all elements of this immutable queue in reverse order.

Inherited from:
SeqOps
Source
Seq.scala

An iterator yielding the elements of this immutable queue in reverse order.

An iterator yielding the elements of this immutable queue in reverse order.

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

Attributes

Returns

an iterator yielding the elements of this immutable queue in reverse order.

Inherited from:
SeqOps
Source
Seq.scala
protected def reversed: Iterable[A]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def runWith[U](action: A => U): Int ->{this, action} Boolean

Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.

Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.

Note that expression pf.runWith(action)(x) is equivalent to

if(pf isDefinedAt x) { action(pf(x)); true } else false

except that runWith is implemented via applyOrElse and thus potentially more efficient. Using runWith avoids double evaluation of pattern matchers and guards for partial function literals.

Type parameters

U

the result type of the action function (ignored, since the action is executed for its side effects only)

Value parameters

action

the action function

Attributes

Returns

a function which maps arguments x to isDefinedAt(x). The resulting function runs action(this(x)) where this is defined.

See also

applyOrElse.

Inherited from:
PartialFunction
Source
PartialFunction.scala
override def sameElements[B >: A](that: IterableOnce[B]^): Boolean

Checks whether corresponding elements of the given iterable collection compare equal (with respect to ==) to elements of this immutable queue.

Checks whether corresponding elements of the given iterable collection compare equal (with respect to ==) to elements of this immutable queue.

Type parameters

B

the type of the elements of collection that.

Value parameters

that

the collection to compare

Attributes

Returns

true if both collections contain equal elements in the same order, false otherwise.

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
def scan[B >: A](z: B)(op: (B, B) => B): Queue[B]

Computes a prefix scan of the elements of the collection.

Computes a prefix scan of the elements of the collection.

Note: The neutral element z may be applied more than once.

Type parameters

B

element type of the resulting collection

Value parameters

op

the associative operator for the scan

z

neutral element for the operator op

Attributes

Returns

a new immutable queue containing the prefix scan of the elements in this immutable queue

Inherited from:
IterableOps
Source
Iterable.scala
override def scanLeft[B](z: B)(op: (B, A) => B): Queue[B]

Produces a immutable queue containing cumulative results of applying the operator going left to right, including the initial value.

Produces a immutable queue containing cumulative results of applying the operator going left to right, including the initial value.

Type parameters

B

the type of the elements in the resulting collection

Value parameters

op

the binary operator applied to the intermediate result and the element

z

the initial value

Attributes

Returns

collection with intermediate results

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def scanRight[B](z: B)(op: (A, B) => B): Queue[B]

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

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: Even when applied to a view or a lazy collection it will always force the elements.

Example:

  List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)

Type parameters

B

the type of the elements in the resulting collection

Value parameters

op

the binary operator applied to the intermediate result and the element

z

the initial value

Attributes

Returns

collection with intermediate results

Inherited from:
IterableOps
Source
Iterable.scala
def search[B >: A](elem: B, from: Int, to: Int)(implicit ord: Ordering[B]): SearchResult

Searches within an interval in this sorted sequence for a specific element. If this sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

Searches within an interval in this sorted sequence for a specific element. If this sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.

Type parameters

B

the element type used for searching and ordering (a supertype of A)

Value parameters

elem

the element to find.

from

the index where the search starts.

ord

the ordering to be used to compare elements.

to

the index following where the search ends.

Attributes

Returns

a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.

See also
Note

if to &lt;= from, the search space is empty, and an InsertionPoint at from is returned

Inherited from:
SeqOps
Source
Seq.scala
def search[B >: A](elem: B)(implicit ord: Ordering[B]): SearchResult

Searches this sorted sequence for a specific element. If the sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

Searches this sorted sequence for a specific element. If the sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.

Type parameters

B

the element type used for searching and ordering (a supertype of A)

Value parameters

elem

the element to find.

ord

the ordering to be used to compare elements.

Attributes

Returns

a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.

See also
Inherited from:
SeqOps
Source
Seq.scala
override def segmentLength(p: A => Boolean, from: Int): Int

Computes the length of the longest segment that starts from some index and whose elements all satisfy some predicate.

Computes the length of the longest segment that starts from some index and whose elements all satisfy some predicate.

Value parameters

from

the index where the search starts.

p

the predicate used to test elements.

Attributes

Returns

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

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
final def segmentLength(p: A => Boolean): Int

Computes the length of the longest segment that starts from the first element and whose elements all satisfy some predicate.

Computes the length of the longest segment that starts from the first element and whose elements all satisfy some predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the length of the longest segment of this immutable queue that starts from the first element such that every element of the segment satisfies the predicate p.

Inherited from:
SeqOps
Source
Seq.scala
final override def size: Int

The size of this immutable queue.

The size of this immutable queue.

Attributes

Returns

the number of elements in this immutable queue.

Definition Classes
Inherited from:
SeqOps
Source
Seq.scala
final override def sizeCompare(that: Iterable[_]^): Int

Compares the size of this immutable queue to the size of another Iterable.

Compares the size of this immutable queue to the size of another Iterable.

Value parameters

that

the Iterable whose size is compared with this immutable queue's size.

Attributes

Returns

A value x where

     x <  0       if this.size <  that.size
     x == 0       if this.size == that.size
     x >  0       if this.size >  that.size

The method as implemented here does not call size directly; its running time is O(this.size min that.size) instead of O(this.size + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.

Definition Classes
Inherited from:
SeqOps
Source
Seq.scala
final override def sizeCompare(otherSize: Int): Int

Compares the size of this immutable queue to a test value.

Compares the size of this immutable queue to a test value.

Value parameters

otherSize

the test value that gets compared with the size.

Attributes

Returns

A value x where

     x <  0       if this.size <  otherSize
     x == 0       if this.size == otherSize
     x >  0       if this.size >  otherSize

The default implementation does not call size, which may be arbitrarily expensive. It will use knownSize if nonnegative. Otherwise, it will iterate to compute an element count, with complexity O(size min otherSize). This method should be overridden if computing size is cheap and knownSize returns -1. In that case, the custom implementation should just compare size and otherSize directly.

See also
Definition Classes
Inherited from:
SeqOps
Source
Seq.scala
final def sizeIs: SizeCompareOps

Returns a value class containing operations for comparing the size of this immutable queue to a test value.

Returns a value class containing operations for comparing the size of this immutable queue to a test value.

These operations are implemented in terms of `sizeCompare(Int)`, and allow the following more readable usages:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0

Attributes

Returns

a wrapper that allows size comparisons using operators such as =, and >

Inherited from:
IterableOps
Source
Iterable.scala
def slice(from: Int, until: Int): Queue[A]

Selects an interval of elements. The returned immutable queue is made up of all elements x which satisfy the invariant:

Selects an interval of elements. The returned immutable queue is made up of all elements x which satisfy the invariant:

  from <= indexOf(x) < until

Value parameters

from

the lowest index to include from this immutable queue.

until

the lowest index to EXCLUDE from this immutable queue.

Attributes

Returns

a immutable queue containing the elements greater than or equal to index from extending up to (but not including) index until of this immutable queue.

Example

List('a', 'b', 'c', 'd', 'e').slice(1, 3) == List('b', 'c')

Inherited from:
IterableOps
Source
Iterable.scala
def sliding(size: Int, step: Int): Iterator[Queue[A]]

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped).

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped).

The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

Value parameters

size

the number of elements per group

step

the distance between the first elements of successive groups

Attributes

Returns

An iterator producing immutable queues of size size, except the last element (which may be the only element) will be smaller if there are fewer than size elements remaining to be grouped.

See also

scala.collection.Iterator, method sliding

Example

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

Inherited from:
IterableOps
Source
Iterable.scala
def sliding(size: Int): Iterator[Queue[A]]

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped).

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped).

An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

Value parameters

size

the number of elements per group

Attributes

Returns

An iterator producing immutable queues of size size, except for a non-empty collection with less than size elements, which returns an iterator that produces the source collection itself as its only element.

See also

scala.collection.Iterator, method sliding

Example

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

Inherited from:
IterableOps
Source
Iterable.scala
def sortBy[B](f: A => B)(implicit ord: Ordering[B]): Queue[A]

Sorts this immutable queue according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

Sorts this immutable queue according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

The sort is stable. That is, elements that are equal (as determined by ord.compare) appear in the same order in the sorted sequence as in the original.

Type parameters

B

the target type of the transformation f, and the type where the ordering ord is defined.

Value parameters

f

the transformation function mapping elements to some other domain B.

ord

the ordering assumed on domain B.

Attributes

Returns

a immutable queue consisting of the elements of this immutable queue sorted according to the ordering where x &lt; y if ord.lt(f(x), f(y)).

See also
Example
  val words = "The quick brown fox jumped over the lazy dog".split(' ')
  // this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
  val sorted = words.sortBy(x => (x.length, x.head))
  // sorted: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)
Inherited from:
SeqOps
Source
Seq.scala
def sortWith(lt: (A, A) => Boolean): Queue[A]

Sorts this immutable queue according to a comparison function.

Sorts this immutable queue according to a comparison function.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

The sort is stable. That is, elements that are equal (lt returns false for both directions of comparison) appear in the same order in the sorted sequence as in the original.

Value parameters

lt

a predicate that is true if its first argument strictly precedes its second argument in the desired ordering.

Attributes

Returns

a immutable queue consisting of the elements of this immutable queue sorted according to the comparison function lt.

Example
  List("Steve", "Bobby", "Tom", "John", "Bob").sortWith((x, y) => x.take(3).compareTo(y.take(3)) < 0)
  // List("Bobby", "Bob", "John", "Steve", "Tom")
Inherited from:
SeqOps
Source
Seq.scala
override def sorted[B >: A](implicit ord: Ordering[B]): Queue[A]

Sorts this immutable queue according to an Ordering.

Sorts this immutable queue according to an Ordering.

The sort is stable. That is, elements that are equal (as determined by ord.compare) appear in the same order in the sorted sequence as in the original.

Type parameters

B

the element type used for ordering (a supertype of A)

Value parameters

ord

the ordering to be used to compare elements.

Attributes

Returns

a immutable queue consisting of the elements of this immutable queue sorted according to the ordering ord.

See also

scala.math.Ordering Note: Even when applied to a view or a lazy collection it will always force the elements.

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala
override def span(p: A => Boolean): (Queue[A], Queue[A])

Splits this immutable queue into a prefix/suffix pair according to a predicate.

Splits this immutable queue into a prefix/suffix pair according to a predicate.

Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side effects.

Value parameters

p

the test predicate

Attributes

Returns

a pair consisting of the longest prefix of this immutable queue whose elements all satisfy p, and the rest of this immutable queue.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def splitAt(n: Int): (Queue[A], Queue[A])

Splits this immutable queue into a prefix/suffix pair at a given position.

Splits this immutable queue into a prefix/suffix pair at a given position.

Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

Value parameters

n

the position at which to split.

Attributes

Returns

a pair of immutable queues consisting of the first n elements of this immutable queue, and the other elements.

Definition Classes
Inherited from:
IterableOps
Source
Iterable.scala
def startsWith[B >: A](that: IterableOnce[B]^, offset: Int = ...): Boolean

Tests whether this immutable queue contains the given sequence at a given index.

Tests whether this immutable queue 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.

Type parameters

B

the element type used for comparison (a supertype of A)

Value parameters

offset

the index where the sequence is searched.

that

the sequence to test

Attributes

Returns

true if the sequence that is contained in this immutable queue at index offset, otherwise false.

Inherited from:
SeqOps
Source
Seq.scala
def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Returns a scala.collection.Stepper for the elements of this collection.

Returns a scala.collection.Stepper for the elements of this collection.

The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.

The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.

Type parameters

S

the type of the returned Stepper, determined by the implicit StepperShape

Value parameters

shape

the StepperShape that determines the concrete Stepper subtype to return

Attributes

Returns

a Stepper over the elements of this immutable queue, using a primitive-typed Stepper subclass for Int/Long/Double (and related) element types

Inherited from:
IterableOnce
Source
IterableOnce.scala
final protected def strictOptimizedCollect[B, C2](b: Builder[B, C2]^, pf: PartialFunction[A, B]^): C2

Type parameters

B

Type of elements of the resulting collection (e.g. String)

C2

Type of the resulting collection (e.g. List[String])

Value parameters

b

Builder to use to build the resulting collection

pf

Element transformation partial function

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedConcat[B >: A, C2](that: IterableOnce[B]^, b: Builder[B, C2]^): C2

Type parameters

B

Type of elements of the resulting collections (e.g. Int)

C2

Type of the resulting collection (e.g. List[Int])

Value parameters

b

Builder to use to build the resulting collection

that

Elements to concatenate to this collection

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedFlatMap[B, C2](b: Builder[B, C2]^, f: A => IterableOnce[B]^): C2

Type parameters

B

Type of elements of the resulting collection (e.g. String)

C2

Type of the resulting collection (e.g. List[String])

Value parameters

b

Builder to use to build the resulting collection

f

Element transformation function

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedFlatten[B, C2](b: Builder[B, C2])(implicit toIterableOnce: A => IterableOnce[B]): C2

Type parameters

B

Type of elements of the resulting collection (e.g. Int)

C2

Type of the resulting collection (e.g. List[Int])

Value parameters

b

Builder to use to build the resulting collection

toIterableOnce

Evidence that A can be seen as an IterableOnce[B]

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedMap[B, C2](b: Builder[B, C2], f: A => B): C2

Type parameters

B

Type of elements of the resulting collection (e.g. String)

C2

Type of the resulting collection (e.g. List[String])

Value parameters

b

Builder to use to build the resulting collection

f

Element transformation function

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedZip[B, C2](that: IterableOnce[B]^, b: Builder[(A, B), C2]^): C2

Type parameters

B

Type of elements of the second collection (e.g. String)

C2

Type of the resulting collection (e.g. List[(Int, String)])

Value parameters

b

Builder to use to build the resulting collection

that

Collection to zip with this collection

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def sum[B >: A](implicit num: Numeric[B]): B

Sums the elements of this collection.

Sums the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Type parameters

B

the result type of the + operator.

Value parameters

num

an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

Attributes

Returns

the sum of all elements of this immutable queue with respect to the + operator in num.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def tails: Iterator[Queue[A]]

Iterates over the tails of this immutable queue. The first value will be this immutable queue and the final one will be an empty immutable queue, with the intervening values the results of successive applications of tail.

Iterates over the tails of this immutable queue. The first value will be this immutable queue and the final one will be an empty immutable queue, with the intervening values the results of successive applications of tail.

Attributes

Returns

an iterator over all the tails of this immutable queue

Example

List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

Definition Classes
Inherited from:
LinearSeqOps
Source
LinearSeq.scala
def take(n: Int): Queue[A]

Selects the first n elements.

Selects the first n elements.

Value parameters

n

the number of elements to take from this immutable queue.

Attributes

Returns

a immutable queue consisting only of the first n elements of this immutable queue, or else the whole immutable queue, if it has less than n elements. If n is negative, returns an empty immutable queue.

Inherited from:
IterableOps
Source
Iterable.scala
override def takeRight(n: Int): Queue[A]

A collection containing the last n elements of this collection.

A collection containing the last n elements of this collection.

        Note: Even when applied to a view or a lazy collection it will always force the elements.

Value parameters

n

the number of elements to take from the end of this collection

Attributes

Returns

a new collection containing the last n elements of this collection, or all elements if n is greater than the size, or an empty collection if n is non-positive

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def takeWhile(p: A => Boolean): Queue[A]

Takes longest prefix of elements that satisfy a predicate.

Takes longest prefix of elements that satisfy a predicate.

Value parameters

p

The predicate used to test elements.

Attributes

Returns

the longest prefix of this immutable queue whose elements all satisfy the predicate p.

Inherited from:
IterableOps
Source
Iterable.scala
override def tapEach[U](f: A => U): Queue[A]

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Type parameters

U

the return type of f

Value parameters

f

a function to apply to each element in this immutable queue

Attributes

Returns

The same logical collection as this

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def to[C1](factory: Factory[A, C1]): C1

Given a collection factory factory, converts this immutable queue to the appropriate representation for the current element type A. Example uses:

Given a collection factory factory, converts this immutable queue to the appropriate representation for the current element type A. Example uses:

import scala.collection.mutable.ArrayBuffer
import scala.collection.immutable.BitSet
val xs: Iterable[Int] = Seq(1, 2, 3, 4, 5)
    xs.to(List)
    xs.to(ArrayBuffer)
    xs.to(BitSet) // for xs: Iterable[Int]

Type parameters

C1

the target collection type

Value parameters

factory

the factory for the target collection type

Attributes

Returns

a new collection of type C1 containing all elements of this immutable queue

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toArray[B >: A : ClassTag]: Array[B]

Converts this immutable queue to an Array.

Converts this immutable queue to an Array.

Implementation note: DO NOT call Array.from from this method.

Type parameters

B

The type of elements of the result, a supertype of A.

Attributes

Returns

This immutable queue as an Array[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toBuffer[B >: A]: Buffer[B]

Converts this immutable queue to a Buffer.

Converts this immutable queue to a Buffer.

Type parameters

B

The type of elements of the result, a supertype of A.

Attributes

Returns

This immutable queue as a Buffer[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Converts this immutable queue to an IndexedSeq.

Converts this immutable queue to an IndexedSeq.

Attributes

Returns

This immutable queue as an IndexedSeq[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toList: List[A]

Converts this immutable queue to a List.

Converts this immutable queue to a List.

Attributes

Returns

This immutable queue as a List[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toMap[K, V](implicit ev: A <:< (K, V)): Map[K, V]

Converts this immutable queue to a Map, given an implicit coercion from the immutable queue's type to a key-value tuple.

Converts this immutable queue to a Map, given an implicit coercion from the immutable queue's type to a key-value tuple.

Type parameters

K

The key type for the resulting map.

V

The value type for the resulting map.

Value parameters

ev

an implicit evidence that A is a subtype of (K, V)

Attributes

Returns

This immutable queue as a Map[K, V].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final override def toSeq: this.type

Attributes

Returns

This immutable queue as a Seq[A]. This is equivalent to to(Seq) but might be faster.

Definition Classes
Inherited from:
Seq
Source
Seq.scala
def toSet[B >: A]: Set[B]

Converts this immutable queue to a Set.

Converts this immutable queue to a Set.

Type parameters

B

The type of elements of the result, a supertype of A.

Attributes

Returns

This immutable queue as a Set[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toVector: Vector[A]

Converts this immutable queue to a Vector.

Converts this immutable queue to a Vector.

Attributes

Returns

This immutable queue as a Vector[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def transpose[B](implicit asIterable: A -> Iterable[B]): Queue[Queue[B]]

Transposes this immutable queue of iterable collections into a immutable queue of immutable queues.

Transposes this immutable queue of iterable collections into a immutable queue of immutable queues.

The resulting collection's type will be guided by the static type of immutable queue. For example:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))
        Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters

B

the type of the elements of each iterable collection.

Value parameters

asIterable

an implicit conversion which asserts that the element type of this immutable queue is an Iterable.

Attributes

Returns

a two-dimensional immutable queue of immutable queues which has as nth row the nth column of this immutable queue.

Throws
IllegalArgumentException

if all collections in this immutable queue are not of the same size.

Inherited from:
IterableOps
Source
Iterable.scala
def unapply(a: Int): Option[A]

Tries to extract a B from an A in a pattern matching expression.

Tries to extract a B from an A in a pattern matching expression.

Value parameters

a

the value to match against this partial function

Attributes

Inherited from:
PartialFunction
Source
PartialFunction.scala
override def unzip[A1, A2](implicit asPair: A -> (A1, A2)): (Queue[A1], Queue[A2])

Converts this immutable queue of pairs into two collections of the first and second half of each pair.

Converts this immutable queue of pairs into two collections of the first and second half of each pair.

  val xs = $Coll(
             (1, "one"),
             (2, "two"),
             (3, "three")).unzip
  // xs == ($Coll(1, 2, 3),
  //        $Coll(one, two, three))

Type parameters

A1

the type of the first half of the element pairs

A2

the type of the second half of the element pairs

Value parameters

asPair

an implicit conversion which asserts that the element type of this immutable queue is a pair.

Attributes

Returns

a pair of immutable queues, containing the first, respectively second half of each element pair of this immutable queue.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def unzip3[A1, A2, A3](implicit asTriple: A -> (A1, A2, A3)): (Queue[A1], Queue[A2], Queue[A3])

Converts this immutable queue of triples into three collections of the first, second, and third element of each triple.

Converts this immutable queue of triples into three collections of the first, second, and third element of each triple.

  val xs = $Coll(
             (1, "one", '1'),
             (2, "two", '2'),
             (3, "three", '3')).unzip3
  // xs == ($Coll(1, 2, 3),
  //        $Coll(one, two, three),
  //        $Coll(1, 2, 3))

Type parameters

A1

the type of the first member of the element triples

A2

the type of the second member of the element triples

A3

the type of the third member of the element triples

Value parameters

asTriple

an implicit conversion which asserts that the element type of this immutable queue is a triple.

Attributes

Returns

a triple of immutable queues, containing the first, second, respectively third member of each element triple of this immutable queue.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def updated[B >: A](index: Int, elem: B): Queue[B]

A copy of this immutable queue with one single replaced element.

A copy of this immutable queue with one single replaced element.

Type parameters

B

the element type of the returned immutable queue.

Value parameters

elem

the replacing element

index

the position of the replacement

Attributes

Returns

a new immutable queue which is a copy of this immutable queue with the element at position index replaced by elem.

Throws
IndexOutOfBoundsException

if index does not satisfy 0 &lt;= index &lt; length. In case of a lazy collection this exception may be thrown at a later time or not at all (if the end of the collection is never evaluated).

Definition Classes
Inherited from:
StrictOptimizedSeqOps
Source
StrictOptimizedSeqOps.scala
override def view: SeqView[A]

A view over the elements of this collection.

A view over the elements of this collection.

Attributes

Definition Classes
Inherited from:
SeqOps
Source
Seq.scala
def withFilter(p: A => Boolean): WithFilter[A, Queue]^{p}

Creates a non-strict filter of this immutable queue.

Creates a non-strict filter of this immutable queue.

Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this immutable queue which satisfy the predicate p.

Inherited from:
IterableOps
Source
Iterable.scala
protected def writeReplace(): AnyRef

Attributes

Inherited from:
DefaultSerializable
Source
DefaultSerializationProxy.scala
override def zip[B](that: IterableOnce[B]^): Queue[(A, B)]

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

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

Type parameters

B

the type of the second half of the returned pairs

Value parameters

that

The iterable providing the second half of each result pair

Attributes

Returns

a new immutable queue containing pairs consisting of corresponding elements of this immutable queue and that. The length of the returned collection is the minimum of the lengths of this immutable queue and that.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def zipAll[A1 >: A, B](that: Iterable[B]^, thisElem: A1, thatElem: B): Queue[(A1, B)]

Returns a immutable queue formed from this immutable queue and another iterable collection 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.

Returns a immutable queue formed from this immutable queue and another iterable collection 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.

Type parameters

A1

the type of the first element in each result pair (supertype of A)

B

the type of the second element in each result pair

Value parameters

that

the iterable providing the second half of each result pair

thatElem

the element to be used to fill up the result if that is shorter than this immutable queue.

thisElem

the element to be used to fill up the result if this immutable queue is shorter than that.

Attributes

Returns

a new immutable queue containing pairs consisting of corresponding elements of this immutable queue and that. The length of the returned collection is the maximum of the lengths of this immutable queue and that. If this immutable queue is shorter than that, thisElem values are used to pad the result. If that is shorter than this immutable queue, thatElem values are used to pad the result.

Inherited from:
IterableOps
Source
Iterable.scala
override def zipWithIndex: Queue[(A, Int)]

Zips this immutable queue with its indices.

Zips this immutable queue with its indices.

Attributes

Returns

A new immutable queue containing pairs consisting of all elements of this immutable queue paired with their index. Indices start at 0.

Example

List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala

Deprecated and Inherited methods

final def /:[B](z: B)(op: (B, A) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldLeft instead of /:
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def :\[B](z: B)(op: (A, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldRight instead of :\\
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def aggregate[B](z: => B)(seqop: (B, A) => B, combop: (B, B) => B): B

Aggregates the results of applying an operator to subsequent elements.

Aggregates the results of applying an operator to subsequent elements.

Since this method degenerates to foldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to prefer foldLeft for that case.

For parallel collections, use the aggregate method specified by scala.collection.parallel.ParIterableLike.

Type parameters

B

the result type, produced by seqop, combop, and by this function as a final result.

Value parameters

combop

an associative operator for combining sequential results, unused for sequential collections.

seqop

the binary operator used to accumulate the result.

z

the start value, a neutral element for seqop.

Attributes

Deprecated
[Since version 2.13.0] For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`.
Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Attributes

Deprecated
[Since version 2.13.0] Use iterableFactory instead
Inherited from:
IterableOps
Source
Iterable.scala
final def copyToBuffer[B >: A](dest: Buffer[B]): Unit

Attributes

Deprecated
[Since version 2.13.0] Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Tests whether this immutable queue is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns **true** if all elements have been computed. It returns **false** if the stream is not yet evaluated to the end. Non-empty Iterators usually return **false** even if they were created from a collection with a known finite size.

Tests whether this immutable queue is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns **true** if all elements have been computed. It returns **false** if the stream is not yet evaluated to the end. Non-empty Iterators usually return **false** even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns **true**. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

Attributes

Returns

**true** if this collection is known to have finite size, **false** otherwise.

See also

method knownSize for a more useful alternative

Deprecated
[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)

This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though hasDefiniteSize returns false.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def prefixLength(p: A => Boolean): Int

Returns the length of the longest prefix whose elements all satisfy some predicate.

Returns the length of the longest prefix whose elements all satisfy some predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the length of the longest prefix of this immutable queue such that every element of the segment satisfies the predicate p.

Deprecated
[Since version 2.13.0] Use segmentLength instead of prefixLength
Inherited from:
SeqOps
Source
Seq.scala
final def repr: Queue[A]

Attributes

Deprecated
[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
Source
Iterable.scala
def reverseMap[B](f: A => B): Queue[B]

Attributes

Deprecated
[Since version 2.13.0] Use .reverseIterator.map(f).to(...) instead of .reverseMap(f)
Inherited from:
SeqOps
Source
Seq.scala
def seq: this.type

Attributes

Deprecated
[Since version 2.13.0] Iterable.seq always returns the iterable itself
Inherited from:
Iterable
Source
Iterable.scala
final def toIterable: this.type

Attributes

Returns

This collection as an Iterable[A]. No new collection will be built if this is already an Iterable[A].

Deprecated
[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
Iterable
Source
Iterable.scala
final def toIterator: Iterator[A]

Attributes

Deprecated
[Since version 2.13.0] Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toStream: Stream[A]

Attributes

Deprecated
[Since version 2.13.0] Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toTraversable: Iterable[A]

Converts this immutable queue to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

Converts this immutable queue to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

Attributes

Returns

An Iterable containing all elements of this immutable queue.

Deprecated
[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
Source
Iterable.scala
final def union[B >: A](that: Seq[B]): Queue[B]

Produces a new sequence which contains all elements of this immutable queue and also all elements of a given sequence. xs union ys is equivalent to xs ++ ys.

Produces a new sequence which contains all elements of this immutable queue and also all elements of a given sequence. xs union ys is equivalent to xs ++ ys.

Type parameters

B

the element type of the returned immutable queue.

Value parameters

that

the sequence to add.

Attributes

Returns

a new collection which contains all elements of this immutable queue followed by all elements of that.

Deprecated
[Since version 2.13.0] Use `concat` instead
Inherited from:
SeqOps
Source
Seq.scala
def view(from: Int, until: Int): View[A]

A view over a slice of the elements of this collection.

A view over a slice of the elements of this collection.

Attributes

Deprecated
[Since version 2.13.0] Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps
Source
Iterable.scala