sealed class PriorityQueue[A] extends AbstractIterable[A] with Iterable[A] with IterableOps[A, Iterable, PriorityQueue[A]] with StrictOptimizedIterableOps[A, Iterable, PriorityQueue[A]] with Builder[A, PriorityQueue[A]] with Cloneable[PriorityQueue[A]] with Growable[A] with Serializable
A heap-based priority queue.
To prioritize elements of type A
there must be an implicit
Ordering[A]
available at creation. Elements are retrieved
in priority order by using dequeue or dequeueAll.
If multiple elements have the same priority as determined by the ordering for this
PriorityQueue
, no guarantees are made regarding the order in which those elements
are returned by dequeue
or dequeueAll
. In particular, that means this
class does not guarantee first-in-first-out behavior, as may be
incorrectly inferred from the fact that this data structure is
called a "queue".
Only the dequeue
and dequeueAll
methods will return elements in priority
order (while removing elements from the heap). Standard collection methods
such as drop
, iterator
, toList
and toString
use an arbitrary
iteration order: they will traverse the heap or remove elements
in whichever order seems most convenient.
Therefore, printing a PriorityQueue
will not show elements in priority order,
though the highest-priority element will be printed first.
To print the elements in order, it's necessary to dequeue
them.
To do this non-destructively, duplicate the PriorityQueue
first;
the clone
method is a suitable way to obtain a disposable copy.
Client keys are assumed to be immutable. Mutating keys may violate the invariant of the underlying heap-ordered tree. Note that clone does not rebuild the underlying tree.
scala> val pq = collection.mutable.PriorityQueue(1, 2, 5, 3, 7) val pq: scala.collection.mutable.PriorityQueue[Int] = PriorityQueue(7, 3, 5, 1, 2) scala> pq.toList // also not in order val res0: List[Int] = List(7, 3, 5, 1, 2) scala> pq.clone.dequeueAll val res1: Seq[Int] = ArraySeq(7, 5, 3, 2, 1)
- A
type of the elements in this priority queue.
- Source
- PriorityQueue.scala
- Alphabetic
- By Inheritance
- PriorityQueue
- Serializable
- Cloneable
- Cloneable
- Builder
- Growable
- Clearable
- StrictOptimizedIterableOps
- AbstractIterable
- Iterable
- AbstractIterable
- Iterable
- IterableFactoryDefaults
- IterableOps
- IterableOnceOps
- IterableOnce
- AnyRef
- Any
- by iterableOnceExtensionMethods
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PriorityQueue()(implicit ord: math.Ordering[A])
- ord
implicit ordering used to compare the elements of type
A
.
Value Members
- final def !=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
- final def ##: Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toany2stringadd[PriorityQueue[A]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ++(xs: IterableOnce[A]): PriorityQueue[A]
Adds all elements provided by a
IterableOnce
object into the priority queue.Adds all elements provided by a
IterableOnce
object into the priority queue.- xs
a iterable object.
- returns
a new priority queue containing elements of both
xs
andthis
.
- final def ++[B >: A](suffix: IterableOnce[B]): Iterable[B]
Alias for
concat
Alias for
concat
- Definition Classes
- IterableOps
- Annotations
- @inline()
- final def ++=(elems: IterableOnce[A]): PriorityQueue.this.type
Alias for
addAll
- final def +=(elem: A): PriorityQueue.this.type
Alias for
addOne
- def ->[B](y: B): (PriorityQueue[A], B)
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toArrowAssoc[PriorityQueue[A]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
- def addAll(xs: IterableOnce[A]): PriorityQueue.this.type
Adds all elements produced by an IterableOnce to this priority queue.
Adds all elements produced by an IterableOnce to this priority queue.
- returns
the priority queue itself.
- Definition Classes
- PriorityQueue → Growable
- def addOne(elem: A): PriorityQueue.this.type
Inserts a single element into the priority queue.
Inserts a single element into the priority queue.
- elem
the element to insert.
- returns
this priority queue.
- Definition Classes
- PriorityQueue → Growable
- final def addString(b: StringBuilder): b.type
Appends all elements of this priority queue to a string builder.
Appends all elements of this priority queue to a string builder. The written text consists of the string representations (w.r.t. the method
toString
) of all elements of this priority queue without any separator string.Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> val h = a.addString(b) h: StringBuilder = 1234
- b
the string builder to which elements are appended.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def addString(b: StringBuilder, sep: String): b.type
Appends all elements of this priority queue to a string builder using a separator string.
Appends all elements of this priority 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 priority queue, separated by the stringsep
.Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b, ", ") res0: StringBuilder = 1, 2, 3, 4
- b
the string builder to which elements are appended.
- sep
the separator string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- def addString(b: StringBuilder, start: String, sep: String, end: String): b.type
Appends all elements of this priority queue to a string builder using start, end, and separator strings.
Appends all elements of this priority queue to a string builder using start, end, and separator strings. The written text begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this priority queue are separated by the stringsep
.Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b , "List(" , ", " , ")") res5: StringBuilder = List(1, 2, 3, 4)
- b
the string builder to which elements are appended.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- IterableOnceOps
- final def asInstanceOf[T0]: T0
Forces the compiler to treat the receiver object as having type
T0
, even though doing so may violate type safety.Forces the compiler to treat the receiver object as having type
T0
, even though doing so may violate type safety.This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.
It is platform dependent whether
asInstanceOf
has any effect at runtime. It might do a runtime type test on the erasure ofT0
, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.In particular,
asInstanceOf
is not a type test. It does **not** mean:this match { case x: T0 => x case _ => throw ClassCastException("...")
Use pattern matching or isInstanceOf for type testing instead.
Situations where
asInstanceOf
is useful:- when flow analysis fails to deduce
T0
automatically - when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.
Be careful of using
asInstanceOf
whenT0
is a primitive type. WhenT0
is primitive,asInstanceOf
may insert a conversion instead of a type test. If your intent is to convert, use atoT
method (x.toChar
,x.toByte
, etc.).- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver is not an instance of the erasure ofT0
, if that can be checked on this platform
- when flow analysis fails to deduce
- def className: String
Defines the prefix of this object's
toString
representation.Defines the prefix of this object's
toString
representation.It is recommended to return the name of the concrete collection type, but not implementation subclasses. For example, for
ListMap
this method should return"ListMap"
, not"Map"
(the supertype) or"Node"
(an implementation subclass).The default implementation returns "Iterable". It is overridden for the basic collection kinds "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" and "View".
- returns
a string representation which starts the result of
toString
applied to this priority queue. By default the string prefix is the simple name of the collection class priority queue.
- Attributes
- protected[this]
- Definition Classes
- PriorityQueue → Iterable
- def clear(): Unit
Removes all elements from the queue.
Removes all elements from the queue. After this operation is completed, the queue will be empty.
- Definition Classes
- PriorityQueue → Builder → Clearable
- def clone(): PriorityQueue[A]
This method clones the priority queue.
This method clones the priority queue.
- returns
a priority queue with the same elements.
- Definition Classes
- PriorityQueue → Cloneable → AnyRef
- final def coll: PriorityQueue.this.type
- returns
This collection as a
C
.
- Attributes
- protected
- Definition Classes
- Iterable → IterableOps
- def collect[B](pf: PartialFunction[A, B]): Iterable[B]
Builds a new priority queue by applying a partial function to all elements of this priority queue on which the function is defined.
Builds a new priority queue by applying a partial function to all elements of this priority queue on which the function is defined.
- B
the element type of the returned priority queue.
- pf
the partial function which filters and maps the priority queue.
- returns
a new priority 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
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def collectFirst[B](pf: PartialFunction[A, B]): Option[B]
Finds the first element of the priority queue for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the priority queue for which the given partial function is defined, and applies the partial function to it.
- pf
the partial function
- returns
an option value containing pf applied to the first value for which it is defined, or
None
if none exists.
- Definition Classes
- IterableOnceOps
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Example: - def concat[B >: A](suffix: IterableOnce[B]): Iterable[B]
Returns a new priority queue containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new priority queue containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the priority queue is the most specific superclass encompassing the element types of the two operands.
- B
the element type of the returned collection.
- suffix
the iterable to append.
- returns
a new priority queue which contains all elements of this priority queue followed by all elements of
suffix
.
- Definition Classes
- IterableOps
- def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int
Copy elements to an array, returning the number of elements written.
Copy elements to an array, returning the number of elements written.
Fills the given array
xs
starting at indexstart
with at mostlen
elements of this priority queue.Copying will stop once either all the elements of this priority queue have been copied, or the end of the array is reached, or
len
elements have been copied.- B
the type of the elements of the array.
- xs
the array to fill.
- start
the starting index of xs.
- len
the maximal number of elements to copy.
- returns
the number of elements written to the array
- Definition Classes
- PriorityQueue → IterableOnceOps
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- def copyToArray[B >: A](xs: 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
xs
starting at indexstart
with values of this priority queue.Copying will stop once either all the elements of this priority queue have been copied, or the end of the array is reached.
- B
the type of the elements of the array.
- xs
the array to fill.
- start
the starting index of xs.
- returns
the number of elements written to the array
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- def copyToArray[B >: A](xs: 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
xs
starting at indexstart
with values of this priority queue.Copying will stop once either all the elements of this priority queue have been copied, or the end of the array is reached.
- B
the type of the elements of the array.
- xs
the array to fill.
- returns
the number of elements written to the array
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- 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.
- B
the type of the elements of
that
- that
the other collection
- p
the test predicate, which relates elements from both collections
- returns
true
if both collections have the same length andp(x, y)
istrue
for all corresponding elementsx
of this iterator andy
ofthat
, otherwisefalse
- Definition Classes
- IterableOnceOps
- def count(p: (A) => Boolean): Int
Counts the number of elements in the priority queue which satisfy a predicate.
Counts the number of elements in the priority queue which satisfy a predicate.
- p
the predicate used to test elements.
- returns
the number of elements satisfying the predicate
p
.
- Definition Classes
- IterableOnceOps
- def dequeue(): A
Returns the element with the highest priority in the queue, and removes this element from the queue.
Returns the element with the highest priority in the queue, and removes this element from the queue.
- returns
the element with the highest priority.
- Exceptions thrown
NoSuchElementException
if no element to remove from heap
- def dequeueAll[A1 >: A]: immutable.Seq[A1]
Dequeues all elements and returns them in a sequence, in priority order.
- def drop(n: Int): PriorityQueue[A]
Selects all elements except the first
n
ones.Selects all elements except the first
n
ones.- n
the number of elements to drop from this priority queue.
- returns
a priority queue consisting of all elements of this priority queue except the first
n
ones, or else the empty priority queue, if this priority queue has less thann
elements. Ifn
is negative, don't drop any elements.
- Definition Classes
- IterableOps → IterableOnceOps
- def dropRight(n: Int): PriorityQueue[A]
The rest of the collection without its
n
last elements.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.
- n
the number of elements to drop from this priority queue.
- returns
a priority queue consisting of all elements of this priority queue except the last
n
ones, or else the empty priority queue, if this priority queue has less thann
elements. Ifn
is negative, don't drop any elements.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps
- def dropWhile(p: (A) => Boolean): PriorityQueue[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 priority 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 priority queue.
Example:
scala> List(1, 2, 3, 100, 4).dropWhile(n => n < 10) val res0: List[Int] = List(100, 4) scala> List(1, 2, 3, 100, 4).dropWhile(n => n == 0) val res1: List[Int] = 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.
- p
The predicate used to test elements.
- returns
the longest suffix of this priority queue whose first element does not satisfy the predicate
p
.
- Definition Classes
- IterableOps → IterableOnceOps
- def empty: PriorityQueue[A]
The empty iterable of the same type as this iterable.
The empty iterable of the same type as this iterable.
- returns
an empty iterable of type
C
.
- Definition Classes
- PriorityQueue → IterableFactoryDefaults → IterableOps
- def enqueue(elems: A*): Unit
Adds all elements to the queue.
Adds all elements to the queue.
- elems
the elements to add.
- def ensuring(cond: (PriorityQueue[A]) => Boolean, msg: => Any): PriorityQueue[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toEnsuring[PriorityQueue[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (PriorityQueue[A]) => Boolean): PriorityQueue[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toEnsuring[PriorityQueue[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): PriorityQueue[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toEnsuring[PriorityQueue[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): PriorityQueue[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toEnsuring[PriorityQueue[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
- def equals(arg0: AnyRef): Boolean
The equality method for reference types.
- def exists(p: (A) => Boolean): Boolean
Tests whether a predicate holds for at least one element of this priority queue.
Tests whether a predicate holds for at least one element of this priority queue.
- p
the predicate used to test elements.
- returns
true
if the given predicatep
is satisfied by at least one element of this priority queue, otherwisefalse
- Definition Classes
- IterableOnceOps
- def filter(pred: (A) => Boolean): PriorityQueue[A]
Selects all elements of this priority queue which satisfy a predicate.
Selects all elements of this priority queue which satisfy a predicate.
- returns
a new priority queue consisting of all elements of this priority queue that satisfy the given predicate
p
. The order of the elements is preserved.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def filterImpl(pred: (A) => Boolean, isFlipped: Boolean): PriorityQueue[A]
- Attributes
- protected[collection]
- Definition Classes
- StrictOptimizedIterableOps
- def filterNot(pred: (A) => Boolean): PriorityQueue[A]
Selects all elements of this priority queue which do not satisfy a predicate.
Selects all elements of this priority queue which do not satisfy a predicate.
- pred
the predicate used to test elements.
- returns
a new priority queue consisting of all elements of this priority queue that do not satisfy the given predicate
pred
. Their order may not be preserved.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the
finalize
method is invoked, as well as the interaction betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- Note
not specified by SLS as a member of AnyRef
- def find(p: (A) => Boolean): Option[A]
Finds the first element of the priority queue satisfying a predicate, if any.
Finds the first element of the priority queue satisfying a predicate, if any.
- p
the predicate used to test elements.
- returns
an option value containing the first element in the priority queue that satisfies
p
, orNone
if none exists.
- Definition Classes
- IterableOnceOps
- def fixDown(as: Array[AnyRef], m: Int, n: Int): Boolean
- Attributes
- protected
- def fixUp(as: Array[AnyRef], m: Int): Unit
- Attributes
- protected
- def flatMap[B](f: (A) => IterableOnce[B]): Iterable[B]
Builds a new priority queue by applying a function to all elements of this priority queue and using the elements of the resulting collections.
Builds a new priority queue by applying a function to all elements of this priority 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 priority 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) // lettersOf will return a Set[Char], not a Seq def lettersOf(words: Seq[String]) = words.toSet flatMap ((word: String) => 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)
- B
the element type of the returned collection.
- f
the function to apply to each element.
- returns
a new priority queue resulting from applying the given collection-valued function
f
to each element of this priority queue and concatenating the results.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def flatten[B](implicit toIterableOnce: (A) => IterableOnce[B]): Iterable[B]
Converts this priority queue of iterable collections into a priority queue formed by the elements of these iterable collections.
Converts this priority queue of iterable collections into a priority queue formed by the elements of these iterable collections.
The resulting collection's type will be guided by the type of priority 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)
- B
the type of the elements of each iterable collection.
- returns
a new priority queue resulting from concatenating all element priority queues.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1
Applies the given binary operator
op
to the given initial valuez
and all elements of this priority queue.Applies the given binary operator
op
to the given initial valuez
and all elements of this priority queue.For each application of the operator, each operand is either an element of this priority 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
forList
concatenation or1
for multiplication.The default implementation in
IterableOnce
is equivalent tofoldLeft
but may be overridden for more efficient traversal orders.- A1
The type parameter for the binary operator, a supertype of
A
.- 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.- op
A binary operator; must be associative for the result to always be the same across runs.
- returns
The result of applying
op
between all the elements andz
, orz
if this priority queue is empty.
- Definition Classes
- IterableOnceOps
- def foldLeft[B](z: B)(op: (B, A) => B): B
Applies the given binary operator
op
to the given initial valuez
and all elements of this priority queue, going left to right.Applies the given binary operator
op
to the given initial valuez
and all elements of this priority queue, going left to right. Returns the initial value if this priority queue is empty."Going left to right" only makes sense if this collection is ordered: then if
x1
,x2
, ...,xn
are the elements of this priority queue, the result isop( op( ... op( op(z, x1), x2) ... ), xn)
.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 priority queue and the initial value all appear exactly once in the computation.
- B
The result type of the binary operator.
- z
An initial value.
- op
A binary operator.
- returns
The result of applying
op
toz
and all elements of this priority queue, going left to right. Returnsz
if this priority queue is empty.
- Definition Classes
- IterableOnceOps
- def foldRight[B](z: B)(op: (A, B) => B): B
Applies the given binary operator
op
to all elements of this priority queue and the given initial valuez
, going right to left.Applies the given binary operator
op
to all elements of this priority queue and the given initial valuez
, going right to left. Returns the initial value if this priority queue is empty."Going right to left" only makes sense if this collection is ordered: then if
x1
,x2
, ...,xn
are the elements of this priority queue, the result isop(x1, op(x2, op( ... op(xn, 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 priority queue and the initial value all appear exactly once in the computation.
- B
The result type of the binary operator.
- z
An initial value.
- op
A binary operator.
- returns
The result of applying
op
to all elements of this priority queue andz
, going right to left. Returnsz
if this priority queue is empty.
- Definition Classes
- IterableOnceOps
- def forall(p: (A) => Boolean): Boolean
Tests whether a predicate holds for all elements of this priority queue.
Tests whether a predicate holds for all elements of this priority queue.
- p
the predicate used to test elements.
- returns
true
if this priority queue is empty or the given predicatep
holds for all elements of this priority queue, otherwisefalse
.
- Definition Classes
- IterableOnceOps
- def foreach[U](f: (A) => U): Unit
Applies
f
to each element for its side effects.Applies
f
to each element for its side effects. Note:U
parameter needed to help scalac's type inference.- Definition Classes
- IterableOnceOps
- def fromSpecific(coll: IterableOnce[A]): PriorityQueue[A]
Defines how to turn a given
Iterable[A]
into a collection of typeC
.Defines how to turn a given
Iterable[A]
into a collection of typeC
.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.
- Attributes
- protected
- Definition Classes
- PriorityQueue → IterableFactoryDefaults → IterableOps
- 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 whereC =:= 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 anIterable[A]
obtained fromthis
collection (as it is the case in the implementations of operations where we use aView[A]
), it is safe.
- final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- def groupBy[K](f: (A) => K): immutable.Map[K, PriorityQueue[A]]
Partitions this priority queue into a map of priority queues according to some discriminator function.
Partitions this priority queue into a map of priority queues according to some discriminator function.
Note: Even when applied to a view or a lazy collection it will always force the elements.
- K
the type of keys returned by the discriminator function.
- f
the discriminator function.
- returns
A map from keys to priority 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 priority queue of those elementsx
for whichf(x)
equalsk
.
- Definition Classes
- IterableOps
- def groupMap[K, B](key: (A) => K)(f: (A) => B): immutable.Map[K, Iterable[B]]
Partitions this priority queue into a map of priority queues according to a discriminator function
key
.Partitions this priority queue into a map of priority queues according to a discriminator function
key
. Each element in a group is transformed into a value of typeB
using thevalue
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.
- K
the type of keys returned by the discriminator function
- B
the type of values returned by the transformation function
- key
the discriminator function
- f
the element transformation function
- Definition Classes
- IterableOps
- def groupMapReduce[K, B](key: (A) => K)(f: (A) => B)(reduce: (B, B) => B): immutable.Map[K, B]
Partitions this priority queue into a map according to a discriminator function
key
.Partitions this priority queue into a map according to a discriminator function
key
. All the values that have the same discriminator are then transformed by thef
function and then reduced into a single value with thereduce
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.
- Definition Classes
- IterableOps
- def grouped(size: Int): Iterator[PriorityQueue[A]]
Partitions elements in fixed size priority queues.
Partitions elements in fixed size priority queues.
- size
the number of elements per group
- returns
An iterator producing priority queues of size
size
, except the last will be less than sizesize
if the elements don't divide evenly.
- Definition Classes
- IterableOps
- See also
scala.collection.Iterator, method
grouped
- def hashCode(): Int
The hashCode method for reference types.
- def head: A
Returns the element with the highest priority in the queue, or throws an error if there is no element contained in the queue.
Returns the element with the highest priority in the queue, or throws an error if there is no element contained in the queue.
- returns
the element with the highest priority.
- Definition Classes
- PriorityQueue → IterableOps
- def headOption: Option[A]
Optionally selects the first element.
Optionally selects the first element.
- returns
the first element of this priority queue if it is nonempty,
None
if it is empty.
- Definition Classes
- IterableOps
- def init: PriorityQueue[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.
- Definition Classes
- IterableOps
- def inits: Iterator[PriorityQueue[A]]
Iterates over the inits of this priority queue.
Iterates over the inits of this priority queue. The first value will be this priority queue and the final one will be an empty priority 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.
- returns
an iterator over all the inits of this priority queue
- Definition Classes
- IterableOps
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Example: - def isEmpty: Boolean
Tests whether the priority queue is empty.
Tests whether the priority queue is empty.
Note: The default implementation creates and discards an iterator.
Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when
isEmpty
is called.- returns
true
if the priority queue contains no elements,false
otherwise.
- Definition Classes
- PriorityQueue → IterableOnceOps
- final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object has the same erasure as
T0
.Test whether the dynamic type of the receiver object has the same erasure as
T0
.Depending on what
T0
is, the test is done in one of the below ways:T0
is a non-parameterized class type, e.g.BigDecimal
: this method returnstrue
if the value of the receiver object is aBigDecimal
or a subtype ofBigDecimal
.T0
is a parameterized class type, e.g.List[Int]
: this method returnstrue
if the value of the receiver object is someList[X]
for anyX
. For example,List(1, 2, 3).isInstanceOf[List[String]]
will return true.T0
is some singleton typex.type
or literalx
: this method returnsthis.eq(x)
. For example,x.isInstanceOf[1]
is equivalent tox.eq(1)
T0
is an intersectionX with Y
orX & Y: this method is equivalent to
x.isInstanceOf[X] && x.isInstanceOf[Y]T0
is a unionX | Y
: this method is equivalent tox.isInstanceOf[X] || x.isInstanceOf[Y]
T0
is a type parameter or an abstract type member: this method is equivalent toisInstanceOf[U]
whereU
isT0
's upper bound,Any
ifT0
is unbounded. For example,x.isInstanceOf[A]
whereA
is an unbounded type parameter will return true for any value ofx
.
This is exactly equivalent to the type pattern
_: T0
- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
- Note
due to the unexpectedness of
List(1, 2, 3).isInstanceOf[List[String]]
returning true andx.isInstanceOf[A]
whereA
is a type parameter or abstract member returning true, these forms issue a warning.
- def isTraversableAgain: Boolean
Tests whether this priority queue can be repeatedly traversed.
Tests whether this priority queue can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.
- returns
true
if it is repeatedly traversable,false
otherwise.
- Definition Classes
- IterableOps → IterableOnceOps
- def iterableFactory: IterableFactory[Iterable]
The companion object of this priority queue, providing various factory methods.
The companion object of this priority queue, providing various factory methods.
- Definition Classes
- Iterable → Iterable → IterableOps
- 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).
- def iterator: Iterator[A]
Returns an iterator which yields all the elements.
Returns an iterator which yields all the elements.
Note: The order of elements returned is undefined. If you want to traverse the elements in priority queue order, use
clone().dequeueAll.iterator
.- returns
an iterator over all the elements.
- Definition Classes
- PriorityQueue → IterableOnce
- def knownSize: Int
The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.
The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.
- returns
The number of elements. The default implementation always returns -1.
- Definition Classes
- PriorityQueue → Growable → IterableOnce
- def last: A
Selects the last element.
Selects the last element.
- returns
The last element of this priority queue.
- Definition Classes
- IterableOps
- Exceptions thrown
NoSuchElementException
If the priority queue is empty.
- def lastOption: Option[A]
Optionally selects the last element.
Optionally selects the last element.
- returns
the last element of this priority queue$ if it is nonempty,
None
if it is empty.
- Definition Classes
- IterableOps
- def lazyZip[B](that: collection.Iterable[B]): LazyZip2[A, B, PriorityQueue.this.type]
Analogous to
zip
except that the elements in each collection are not consumed until a strict operation is invoked on the returnedLazyZip2
decorator.Analogous to
zip
except that the elements in each collection are not consumed until a strict operation is invoked on the returnedLazyZip2
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)
- B
the type of the second element in each eventual pair
- that
the iterable providing the second element of each eventual pair
- returns
a decorator
LazyZip2
that allows strict operations to be performed on the lazily evaluated pairs or chained calls tolazyZip
. Implicit conversion toIterable[(A, B)]
is also supported.
- Definition Classes
- Iterable
- def length: Int
Alias for size.
- def map[B](f: (A) => B): Iterable[B]
Builds a new priority queue by applying a function to all elements of this priority queue.
Builds a new priority queue by applying a function to all elements of this priority queue.
- B
the element type of the returned priority queue.
- f
the function to apply to each element.
- returns
a new priority queue resulting from applying the given function
f
to each element of this priority queue and collecting the results.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def mapInPlace(f: (A) => A): PriorityQueue.this.type
Replace the contents of this priority queue with the mapped result.
Replace the contents of this priority queue with the mapped result.
- f
the mapping function
- returns
this priority queue
- def mapResult[NewTo](f: (PriorityQueue[A]) => NewTo): Builder[A, NewTo]
A builder resulting from this builder by mapping the result using
f
.A builder resulting from this builder by mapping the result using
f
.- Definition Classes
- Builder
- def max[B >: A](implicit ord: math.Ordering[B]): A
Finds the largest element.
Finds the largest element.
- B
The type over which the ordering is defined.
- ord
An ordering to be used for comparing elements.
- returns
the largest element of this priority queue with respect to the ordering
ord
.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this priority queue is empty.
- def maxBy[B](f: (A) => B)(implicit ord: math.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
.- B
The result type of the function
f
.- f
The measuring function.
- returns
the first element of this priority queue with the largest value measured by function
f
with respect to the orderingcmp
.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this priority queue is empty.
- def maxByOption[B](f: (A) => B)(implicit ord: math.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
.- B
The result type of the function
f
.- f
The measuring function.
- returns
an option value containing the first element of this priority queue with the largest value measured by function
f
with respect to the orderingcmp
.
- Definition Classes
- IterableOnceOps
- def maxOption[B >: A](implicit ord: math.Ordering[B]): Option[A]
Finds the largest element.
Finds the largest element.
- B
The type over which the ordering is defined.
- ord
An ordering to be used for comparing elements.
- returns
an option value containing the largest element of this priority queue with respect to the ordering
ord
.
- Definition Classes
- IterableOnceOps
- def min[B >: A](implicit ord: math.Ordering[B]): A
Finds the smallest element.
Finds the smallest element.
- B
The type over which the ordering is defined.
- ord
An ordering to be used for comparing elements.
- returns
the smallest element of this priority queue with respect to the ordering
ord
.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this priority queue is empty.
- def minBy[B](f: (A) => B)(implicit ord: math.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
.- B
The result type of the function
f
.- f
The measuring function.
- returns
the first element of this priority queue with the smallest value measured by function
f
with respect to the orderingcmp
.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this priority queue is empty.
- def minByOption[B](f: (A) => B)(implicit ord: math.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
.- B
The result type of the function
f
.- f
The measuring function.
- returns
an option value containing the first element of this priority queue with the smallest value measured by function
f
with respect to the orderingcmp
.
- Definition Classes
- IterableOnceOps
- def minOption[B >: A](implicit ord: math.Ordering[B]): Option[A]
Finds the smallest element.
Finds the smallest element.
- B
The type over which the ordering is defined.
- ord
An ordering to be used for comparing elements.
- returns
an option value containing the smallest element of this priority queue with respect to the ordering
ord
.
- Definition Classes
- IterableOnceOps
- final def mkString: String
Displays all elements of this priority queue in a string.
Displays all elements of this priority queue in a string.
Delegates to addString, which can be overridden.
- returns
a string representation of this priority queue. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this priority queue follow each other without any separator string.
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def mkString(sep: String): String
Displays all elements of this priority queue in a string using a separator string.
Displays all elements of this priority queue in a string using a separator string.
Delegates to addString, which can be overridden.
- sep
the separator string.
- returns
a string representation of this priority queue. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this priority queue are separated by the stringsep
.
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
List(1, 2, 3).mkString("|") = "1|2|3"
Example: - final def mkString(start: String, sep: String, end: String): String
Displays all elements of this priority queue in a string using start, end, and separator strings.
Displays all elements of this priority queue in a string using start, end, and separator strings.
Delegates to addString, which can be overridden.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
a string representation of this priority queue. The resulting string begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this priority queue are separated by the stringsep
.
- Definition Classes
- IterableOnceOps
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Example: - final def ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- def newSpecificBuilder: Builder[A, PriorityQueue[A]]
- returns
a strict builder for the same collection type. Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList), it is possible to implement this method but the resulting
Builder
will break laziness. As a consequence, operations should preferably be implemented withfromSpecific
instead of this method.
- Attributes
- protected
- Definition Classes
- PriorityQueue → IterableFactoryDefaults → IterableOps
- 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 whereC =:= 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 withA
values taken fromthis
instance, it is safe.
- def nonEmpty: Boolean
Tests whether the priority queue is not empty.
Tests whether the priority queue is not empty.
- returns
true
if the priority queue contains at least one element,false
otherwise.
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- implicit val ord: math.Ordering[A]
- def partition(p: (A) => Boolean): (PriorityQueue[A], PriorityQueue[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 priority 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
inStrictOptimizedIterableOps
, which requires only a single traversal.- Definition Classes
- StrictOptimizedIterableOps → IterableOps
- def partitionMap[A1, A2](f: (A) => Either[A1, A2]): (Iterable[A1], Iterable[A2])
Applies a function
f
to each element of the priority queue and returns a pair of priority queues: the first one made of those values returned byf
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 priority queue and returns a pair of priority queues: the first one made of those values returned byf
that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.Example:
val xs = PriorityQueue(1, "one", 2, "two", 3, "three") partitionMap { case i: Int => Left(i) case s: String => Right(s) } // xs == (PriorityQueue(1, 2, 3), // PriorityQueue(one, two, three))
- A1
the element type of the first resulting collection
- A2
the element type of the second resulting collection
- f
the 'split function' mapping the elements of this priority queue to an scala.util.Either
- returns
a pair of priority 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
- StrictOptimizedIterableOps → IterableOps
- def product[B >: A](implicit num: math.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.- B
the result type of the
*
operator.- num
an implicit parameter defining a set of numeric operations which includes the
*
operator to be used in forming the product.- returns
the product of all elements of this priority queue with respect to the
*
operator innum
.
- Definition Classes
- IterableOnceOps
- def reduce[B >: A](op: (B, B) => B): B
Applies the given binary operator
op
to all elements of this priority queue.Applies the given binary operator
op
to all elements of this priority queue.For each application of the operator, each operand is either an element of this priority 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.
- B
The type parameter for the binary operator, a supertype of
A
.- op
A binary operator; must be associative for the result to always be the same across runs.
- returns
The result of applying
op
between all the elements if the priority queue is nonempty.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this priority queue is empty.
- def reduceLeft[B >: A](op: (B, A) => B): B
Applies the given binary operator
op
to all elements of this priority queue, going left to right.Applies the given binary operator
op
to all elements of this priority queue, going left to right."Going left to right" only makes sense if this collection is ordered: then if
x1
,x2
, ...,xn
are the elements of this priority queue, the result isop( op( op( ... op(x1, x2) ... ), xn-1), xn)
.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 priority 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.
- B
The result type of the binary operator, a supertype of
A
.- op
A binary operator.
- returns
The result of applying
op
to all elements of this priority queue, going left to right.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this priority queue is empty.
- def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]
If this priority queue is nonempty, reduces it with the given binary operator
op
, going left to right.If this priority 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 priority 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.
- B
The result type of the binary operator, a supertype of
A
.- op
A binary operator.
- returns
The result of reducing this priority queue with
op
going left to right if the priority queue is nonempty, inside aSome
, andNone
otherwise.
- Definition Classes
- IterableOnceOps
- def reduceOption[B >: A](op: (B, B) => B): Option[B]
If this priority queue is nonempty, reduces it with the given binary operator
op
.If this priority 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 priority 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.
- B
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator; must be associative for the result to always be the same across runs.
- returns
The result of reducing this priority queue with
op
if the priority queue is nonempty, inside aSome
, andNone
otherwise.
- Definition Classes
- IterableOnceOps
- def reduceRight[B >: A](op: (A, B) => B): B
Applies the given binary operator
op
to all elements of this priority queue, going right to left.Applies the given binary operator
op
to all elements of this priority queue, going right to left."Going right to left" only makes sense if this collection is ordered: then if
x1
,x2
, ...,xn
are the elements of this priority queue, the result isop(x1, op(x2, op( ... op(xn-1, xn) ... )))
.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 priority 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.
- B
The result type of the binary operator, a supertype of
A
.- op
A binary operator.
- returns
The result of applying
op
to all elements of this priority queue, going right to left.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this priority queue is empty.
- def reduceRightOption[B >: A](op: (A, B) => B): Option[B]
If this priority queue is nonempty, reduces it with the given binary operator
op
, going right to left.If this priority 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 priority 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.
- B
The result type of the binary operator, a supertype of
A
.- op
A binary operator.
- returns
The result of reducing this priority queue with
op
going right to left if the priority queue is nonempty, inside aSome
, andNone
otherwise.
- Definition Classes
- IterableOnceOps
- def result(): PriorityQueue[A]
Result collection consisting of all elements appended so far.
Result collection consisting of all elements appended so far.
- Definition Classes
- PriorityQueue → Builder
- def reverse: PriorityQueue[A]
Returns the reverse of this priority queue.
Returns the reverse of this priority queue. The new priority queue has the same elements as the original, but the opposite ordering.
For example, the element with the highest priority in
pq
has the lowest priority inpq.reverse
, and vice versa.Ties are handled arbitrarily. Elements with equal priority may or may not be reversed with respect to each other.
- returns
the reversed priority queue.
- def reverseIterator: Iterator[A]
Returns an iterator which yields all the elements in the reverse order than that returned by the method
iterator
.Returns an iterator which yields all the elements in the reverse order than that returned by the method
iterator
.Note: The order of elements returned is undefined.
- returns
an iterator over all elements sorted in descending order.
- def reversed: collection.Iterable[A]
- Attributes
- protected
- Definition Classes
- IterableOnceOps
- def scan[B >: A](z: B)(op: (B, B) => B): Iterable[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.- B
element type of the resulting collection
- z
neutral element for the operator
op
- op
the associative operator for the scan
- returns
a new priority queue containing the prefix scan of the elements in this priority queue
- Definition Classes
- IterableOps
- def scanLeft[B](z: B)(op: (B, A) => B): Iterable[B]
Produces a priority queue containing cumulative results of applying the operator going left to right, including the initial value.
Produces a priority queue containing cumulative results of applying the operator going left to right, including the initial value.
- B
the type of the elements in the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- returns
collection with intermediate results
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def scanRight[B](z: B)(op: (A, B) => B): Iterable[B]
Produces a collection containing cumulative results of applying the operator going right to left.
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)
- B
the type of the elements in the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- returns
collection with intermediate results
- Definition Classes
- IterableOps
- def size: Int
The size of this priority queue.
The size of this priority queue.
- returns
the number of elements in this priority queue.
- Definition Classes
- PriorityQueue → IterableOnceOps
- def sizeCompare(that: collection.Iterable[_]): Int
Compares the size of this priority queue to the size of another
Iterable
.Compares the size of this priority queue to the size of another
Iterable
.- that
the
Iterable
whose size is compared with this priority queue's size.- returns
A value
x
wherex < 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 isO(this.size min that.size)
instead ofO(this.size + that.size)
. The method should be overridden if computingsize
is cheap andknownSize
returns-1
.
- Definition Classes
- IterableOps
- def sizeCompare(otherSize: Int): Int
Compares the size of this priority queue to a test value.
Compares the size of this priority queue to a test value.
- otherSize
the test value that gets compared with the size.
- returns
A value
x
wherex < 0 if this.size < otherSize x == 0 if this.size == otherSize x > 0 if this.size > otherSize
The method as implemented here does not call
size
directly; its running time isO(size min otherSize)
instead ofO(size)
. The method should be overridden if computingsize
is cheap andknownSize
returns-1
.
- Definition Classes
- IterableOps
- See also
- final def sizeHint(coll: IterableOnce[_], delta: Int = 0): Unit
Gives a hint that the
result
of this builder is expected to have the same size as the given collection, plus some delta.Gives a hint that the
result
of this builder is expected to have the same size as the given collection, plus some delta.This method provides a hint only if the collection has a known size, as specified by the following pseudocode:
if (coll.knownSize != -1) if (coll.knownSize + delta <= 0) sizeHint(0) else sizeHint(coll.knownSize + delta)
If the delta is negative and the result size is known to be negative, then the size hint is issued at zero.
Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, i.e., if a different number of elements is added.
- coll
the collection which serves as a hint for the result's size.
- delta
a correction to add to the
coll.size
to produce the size hint (zero if omitted).
- Definition Classes
- Builder
- def sizeHint(size: Int): Unit
Gives a hint how many elements are expected to be added in total by the time
result
is called.Gives a hint how many elements are expected to be added in total by the time
result
is called.Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, e.g., a different number of elements is added, or the hint is out of range.
The default implementation simply ignores the hint.
- size
the hint how many elements will be added.
- Definition Classes
- Builder
- final def sizeHintBounded(size: Int, boundingColl: collection.Iterable[_]): Unit
Gives a hint how many elements are expected to be added when the next
result
is called, together with an upper bound given by the size of some other collection.Gives a hint how many elements are expected to be added when the next
result
is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.- size
the hint how many elements will be added.
- boundingColl
the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.
- Definition Classes
- Builder
- final def sizeIs: SizeCompareOps
Returns a value class containing operations for comparing the size of this priority queue to a test value.
Returns a value class containing operations for comparing the size of this priority 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
- Definition Classes
- IterableOps
- Annotations
- @inline()
- def slice(from: Int, until: Int): PriorityQueue[A]
Selects an interval of elements.
Selects an interval of elements. The returned priority queue is made up of all elements
x
which satisfy the invariant:from <= indexOf(x) < until
- from
the lowest index to include from this priority queue.
- until
the lowest index to EXCLUDE from this priority queue.
- returns
a priority queue containing the elements greater than or equal to index
from
extending up to (but not including) indexuntil
of this priority queue.
- Definition Classes
- IterableOps → IterableOnceOps
- def sliding(size: Int, step: Int): Iterator[PriorityQueue[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.
- size
the number of elements per group
- step
the distance between the first elements of successive groups
- returns
An iterator producing priority queues of size
size
, except the last element (which may be the only element) will be smaller if there are fewer thansize
elements remaining to be grouped.
- Definition Classes
- IterableOps
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))
- See also
scala.collection.Iterator, method
sliding
Examples: - def sliding(size: Int): Iterator[PriorityQueue[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.
- size
the number of elements per group
- returns
An iterator producing priority queues of size
size
, except for a non-empty collection with less thansize
elements, which returns an iterator that produces the source collection itself as its only element.
- Definition Classes
- IterableOps
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))
- See also
scala.collection.Iterator, method
sliding
Examples: - def span(p: (A) => Boolean): (PriorityQueue[A], PriorityQueue[A])
Splits this priority queue into a prefix/suffix pair according to a predicate.
Splits this priority 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 predicatep
does not cause any side-effects.- p
the test predicate
- returns
a pair consisting of the longest prefix of this priority queue whose elements all satisfy
p
, and the rest of this priority queue.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def splitAt(n: Int): (PriorityQueue[A], PriorityQueue[A])
Splits this priority queue into a prefix/suffix pair at a given position.
Splits this priority 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)
.- n
the position at which to split.
- returns
a pair of priority queues consisting of the first
n
elements of this priority queue, and the other elements.
- Definition Classes
- IterableOps → IterableOnceOps
- 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.
- For collections of
Int
,Short
,Byte
orChar
, an scala.collection.IntStepper is returned - For collections of
Double
orFloat
, a scala.collection.DoubleStepper is returned - For collections of
Long
a scala.collection.LongStepper is returned - For any other element type, an scala.collection.AnyStepper is returned
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.- Definition Classes
- IterableOnce
- For collections of
- final def strictOptimizedCollect[B, C2](b: Builder[B, C2], pf: PartialFunction[A, B]): C2
- B
Type of elements of the resulting collection (e.g.
String
)- C2
Type of the resulting collection (e.g.
List[String]
)- b
Builder to use to build the resulting collection
- pf
Element transformation partial function
- returns
The resulting collection
- Attributes
- protected[this]
- Definition Classes
- StrictOptimizedIterableOps
- Annotations
- @inline()
- final def strictOptimizedConcat[B >: A, C2](that: IterableOnce[B], b: Builder[B, C2]): C2
- B
Type of elements of the resulting collections (e.g.
Int
)- C2
Type of the resulting collection (e.g.
List[Int]
)- that
Elements to concatenate to this collection
- b
Builder to use to build the resulting collection
- returns
The resulting collection
- Attributes
- protected[this]
- Definition Classes
- StrictOptimizedIterableOps
- Annotations
- @inline()
- final def strictOptimizedFlatMap[B, C2](b: Builder[B, C2], f: (A) => IterableOnce[B]): C2
- B
Type of elements of the resulting collection (e.g.
String
)- C2
Type of the resulting collection (e.g.
List[String]
)- b
Builder to use to build the resulting collection
- f
Element transformation function
- returns
The resulting collection
- Attributes
- protected[this]
- Definition Classes
- StrictOptimizedIterableOps
- Annotations
- @inline()
- final def strictOptimizedFlatten[B, C2](b: Builder[B, C2])(implicit toIterableOnce: (A) => IterableOnce[B]): C2
- B
Type of elements of the resulting collection (e.g.
Int
)- C2
Type of the resulting collection (e.g.
List[Int]
)- b
Builder to use to build the resulting collection
- toIterableOnce
Evidence that
A
can be seen as anIterableOnce[B]
- returns
The resulting collection
- Attributes
- protected[this]
- Definition Classes
- StrictOptimizedIterableOps
- Annotations
- @inline()
- final def strictOptimizedMap[B, C2](b: Builder[B, C2], f: (A) => B): C2
- B
Type of elements of the resulting collection (e.g.
String
)- C2
Type of the resulting collection (e.g.
List[String]
)- b
Builder to use to build the resulting collection
- f
Element transformation function
- returns
The resulting collection
- Attributes
- protected[this]
- Definition Classes
- StrictOptimizedIterableOps
- Annotations
- @inline()
- final def strictOptimizedZip[B, C2](that: IterableOnce[B], b: Builder[(A, B), C2]): C2
- B
Type of elements of the second collection (e.g.
String
)- C2
Type of the resulting collection (e.g.
List[(Int, String)]
)- that
Collection to zip with this collection
- b
Builder to use to build the resulting collection
- returns
The resulting collection
- Attributes
- protected[this]
- Definition Classes
- StrictOptimizedIterableOps
- Annotations
- @inline()
- def stringPrefix: String
- Attributes
- protected[this]
- Definition Classes
- Iterable
- Annotations
- @deprecatedOverriding()
- def sum[B >: A](implicit num: math.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.- B
the result type of the
+
operator.- num
an implicit parameter defining a set of numeric operations which includes the
+
operator to be used in forming the sum.- returns
the sum of all elements of this priority queue with respect to the
+
operator innum
.
- Definition Classes
- IterableOnceOps
- final def synchronized[T0](arg0: => T0): T0
Executes the code in
body
with an exclusive lock onthis
.Executes the code in
body
with an exclusive lock onthis
.- returns
the result of
body
- Definition Classes
- AnyRef
- def tail: PriorityQueue[A]
The rest of the collection without its first element.
The rest of the collection without its first element.
- Definition Classes
- IterableOps
- def tails: Iterator[PriorityQueue[A]]
Iterates over the tails of this priority queue.
Iterates over the tails of this priority queue. The first value will be this priority queue and the final one will be an empty priority queue, with the intervening values the results of successive applications of
tail
.- returns
an iterator over all the tails of this priority queue
- Definition Classes
- IterableOps
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Example: - def take(n: Int): PriorityQueue[A]
Selects the first
n
elements.Selects the first
n
elements.- n
the number of elements to take from this priority queue.
- returns
a priority queue consisting only of the first
n
elements of this priority queue, or else the whole priority queue, if it has less thann
elements. Ifn
is negative, returns an empty priority queue.
- Definition Classes
- IterableOps → IterableOnceOps
- def takeRight(n: Int): PriorityQueue[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.
- n
the number of elements to take from this priority queue.
- returns
a priority queue consisting only of the last
n
elements of this priority queue, or else the whole priority queue, if it has less thann
elements. Ifn
is negative, returns an empty priority queue.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps
- def takeWhile(p: (A) => Boolean): PriorityQueue[A]
Takes longest prefix of elements that satisfy a predicate.
Takes longest prefix of elements that satisfy a predicate.
- p
The predicate used to test elements.
- returns
the longest prefix of this priority queue whose elements all satisfy the predicate
p
.
- Definition Classes
- IterableOps → IterableOnceOps
- def tapEach[U](f: (A) => U): PriorityQueue[A]
Applies a side-effecting function to each element in this collection.
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 applyf
on each element if and when that element is evaluated, and each time that element is evaluated.- U
the return type of f
- f
a function to apply to each element in this priority queue
- returns
The same logical collection as this
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
- def to[C1](factory: Factory[A, C1]): C1
Given a collection factory
factory
, converts this priority queue to the appropriate representation for the current element typeA
.Given a collection factory
factory
, converts this priority queue to the appropriate representation for the current element typeA
. Example uses:xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // for xs: Iterable[Int]
- Definition Classes
- IterableOnceOps
- def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
Converts this priority queue to an
Array
.Converts this priority queue to an
Array
.Implementation note: DO NOT call Array.from from this method.
- B
The type of elements of the result, a supertype of
A
.- returns
This priority queue as an
Array[B]
.
- Definition Classes
- IterableOnceOps
- final def toBuffer[B >: A]: Buffer[B]
Converts this priority queue to a
Buffer
.Converts this priority queue to a
Buffer
.- B
The type of elements of the result, a supertype of
A
.- returns
This priority queue as a
Buffer[B]
.
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- def toIndexedSeq: immutable.IndexedSeq[A]
Converts this priority queue to an
IndexedSeq
.Converts this priority queue to an
IndexedSeq
.- returns
This priority queue as an
IndexedSeq[A]
.
- Definition Classes
- IterableOnceOps
- def toList: immutable.List[A]
Converts this priority queue to a list.
Converts this priority queue to a list.
Note: the order of elements is undefined.
- returns
a list containing all elements of this priority queue.
- Definition Classes
- PriorityQueue → IterableOnceOps
- def toMap[K, V](implicit ev: <:<[A, (K, V)]): immutable.Map[K, V]
Converts this priority queue to a
Map
, given an implicit coercion from the priority queue's type to a key-value tuple.Converts this priority queue to a
Map
, given an implicit coercion from the priority queue's type to a key-value tuple.- K
The key type for the resulting map.
- V
The value type for the resulting map.
- ev
An implicit coercion from
A
to[K, V]
.- returns
This priority queue as a
Map[K, V]
.
- Definition Classes
- IterableOnceOps
- def toQueue: Queue[A]
Returns a regular queue containing the same elements.
Returns a regular queue containing the same elements.
Note: the order of elements is undefined.
- def toSeq: immutable.Seq[A]
- returns
This priority queue as a
Seq[A]
. This is equivalent toto(Seq)
but might be faster.
- Definition Classes
- IterableOnceOps
- def toSet[B >: A]: immutable.Set[B]
Converts this priority queue to a
Set
.Converts this priority queue to a
Set
.- B
The type of elements of the result, a supertype of
A
.- returns
This priority queue as a
Set[B]
.
- Definition Classes
- IterableOnceOps
- def toString(): String
Returns a textual representation of a queue as a string.
Returns a textual representation of a queue as a string.
- returns
the string representation of this queue.
- Definition Classes
- PriorityQueue → Iterable → AnyRef → Any
- def toVector: immutable.Vector[A]
Converts this priority queue to a
Vector
.Converts this priority queue to a
Vector
.- returns
This priority queue as a
Vector[A]
.
- Definition Classes
- IterableOnceOps
- def transpose[B](implicit asIterable: (A) => collection.Iterable[B]): Iterable[Iterable[B]]
Transposes this priority queue of iterable collections into a priority queue of priority queues.
Transposes this priority queue of iterable collections into a priority queue of priority queues.
The resulting collection's type will be guided by the static type of priority 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.
- B
the type of the elements of each iterable collection.
- asIterable
an implicit conversion which asserts that the element type of this priority queue is an
Iterable
.- returns
a two-dimensional priority queue of priority queues which has as nth row the nth column of this priority queue.
- Definition Classes
- IterableOps
- Exceptions thrown
IllegalArgumentException
if all collections in this priority queue are not of the same size.
- def unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (Iterable[A1], Iterable[A2])
Converts this priority queue of pairs into two collections of the first and second half of each pair.
Converts this priority queue of pairs into two collections of the first and second half of each pair.
val xs = PriorityQueue( (1, "one"), (2, "two"), (3, "three")).unzip // xs == (PriorityQueue(1, 2, 3), // PriorityQueue(one, two, three))
- A1
the type of the first half of the element pairs
- A2
the type of the second half of the element pairs
- asPair
an implicit conversion which asserts that the element type of this priority queue is a pair.
- returns
a pair of priority queues, containing the first, respectively second half of each element pair of this priority queue.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps
- def unzip3[A1, A2, A3](implicit asTriple: (A) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
Converts this priority queue of triples into three collections of the first, second, and third element of each triple.
Converts this priority queue of triples into three collections of the first, second, and third element of each triple.
val xs = PriorityQueue( (1, "one", '1'), (2, "two", '2'), (3, "three", '3')).unzip3 // xs == (PriorityQueue(1, 2, 3), // PriorityQueue(one, two, three), // PriorityQueue(1, 2, 3))
- 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
- asTriple
an implicit conversion which asserts that the element type of this priority queue is a triple.
- returns
a triple of priority queues, containing the first, second, respectively third member of each element triple of this priority queue.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps
- def view: View[A]
A view over the elements of this collection.
A view over the elements of this collection.
- Definition Classes
- IterableOps
- final def wait(): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- Note
not specified by SLS as a member of AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- Note
not specified by SLS as a member of AnyRef
- final def wait(arg0: Long): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.
- def withFilter(p: (A) => Boolean): WithFilter[A, [_]Iterable[_]]
Creates a non-strict filter of this priority queue.
Creates a non-strict filter of this priority queue.
Note: the difference between
c filter p
andc withFilter p
is that the former creates a new collection, whereas the latter only restricts the domain of subsequentmap
,flatMap
,foreach
, andwithFilter
operations.- p
the predicate used to test elements.
- returns
an object of class
WithFilter
, which supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this priority queue which satisfy the predicatep
.
- Definition Classes
- IterableOps
- def writeReplace(): AnyRef
- Attributes
- protected[this]
- def zip[B](that: IterableOnce[B]): Iterable[(A, B)]
Returns a priority queue formed from this priority queue and another iterable collection by combining corresponding elements in pairs.
Returns a priority queue formed from this priority 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.
- B
the type of the second half of the returned pairs
- that
The iterable providing the second half of each result pair
- returns
a new priority queue containing pairs consisting of corresponding elements of this priority queue and
that
. The length of the returned collection is the minimum of the lengths of this priority queue andthat
.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps
- def zipAll[A1 >: A, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]
Returns a priority queue formed from this priority queue and another iterable collection by combining corresponding elements in pairs.
Returns a priority queue formed from this priority 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.
- that
the iterable providing the second half of each result pair
- thisElem
the element to be used to fill up the result if this priority queue is shorter than
that
.- thatElem
the element to be used to fill up the result if
that
is shorter than this priority queue.- returns
a new collection of type
That
containing pairs consisting of corresponding elements of this priority queue andthat
. The length of the returned collection is the maximum of the lengths of this priority queue andthat
. If this priority queue is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this priority queue,thatElem
values are used to pad the result.
- Definition Classes
- IterableOps
- def zipWithIndex: Iterable[(A, Int)]
Zips this priority queue with its indices.
Zips this priority queue with its indices.
- returns
A new priority queue containing pairs consisting of all elements of this priority queue paired with their index. Indices start at
0
.
- Definition Classes
- StrictOptimizedIterableOps → IterableOps → IterableOnceOps
List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))
Example:
Deprecated Value Members
- def ++:[B >: A](that: IterableOnce[B]): Iterable[B]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use ++ instead of ++: for collections of type Iterable
- final def +=(elem1: A, elem2: A, elems: A*): PriorityQueue.this.type
Adds two or more elements to this priority queue.
Adds two or more elements to this priority queue.
- elem1
the first element to add.
- elem2
the second element to add.
- elems
the remaining elements to add.
- returns
the priority queue itself
- Definition Classes
- Growable
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use
++=
akaaddAll
instead of varargs+=
; infix operations with an operand of multiple args will be deprecated
- def /:[B](z: B)(op: (B, A) => B): B
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A])./:(z)(op)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.foldLeft instead
- final def /:[B](z: B)(op: (B, A) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use foldLeft instead of /:
- def :\[B](z: B)(op: (A, B) => B): B
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).:\(z)(op)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.foldRight instead
- final def :\[B](z: B)(op: (A, B) => B): B
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use foldRight instead of :\
- 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 preferfoldLeft
for that case.For parallel collections, use the
aggregate
method specified byscala.collection.parallel.ParIterableLike
.- B
the result type, produced by
seqop
,combop
, and by this function as a final result.- z
the start value, a neutral element for
seqop
.- seqop
the binary operator used to accumulate the result.
- combop
an associative operator for combining sequential results, unused for sequential collections.
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) For sequential collections, prefer
foldLeft(z)(seqop)
. For parallel collections, useParIterableLike#aggregate
.
- def collectFirst[B](f: PartialFunction[A, B]): Option[B]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).collectFirst(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.collectFirst(...) instead
- def companion: IterableFactory[[_]Iterable[_]]
- Definition Classes
- IterableOps
- Annotations
- @deprecated @deprecatedOverriding() @inline()
- Deprecated
(Since version 2.13.0) Use iterableFactory instead
- def copyToBuffer(dest: Buffer[A]): Unit
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).copyToBuffer(dest)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.copyToBuffer(...) instead
- final def copyToBuffer[B >: A](dest: Buffer[B]): Unit
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use
dest ++= coll
instead
- def count(f: (A) => Boolean): Int
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).count(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.count(...) instead
- def exists(f: (A) => Boolean): Boolean
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).exists(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.exists(...) instead
- def filter(f: (A) => Boolean): Iterator[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).filter(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.filter(...) instead
- def find(p: (A) => Boolean): Option[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).find(p)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.find instead
- def flatMap[B](f: (A) => IterableOnce[B]): IterableOnce[B]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).flatMap(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.flatMap instead or consider requiring an Iterable
- def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).fold(z)(op)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.fold instead
- def foldLeft[B](z: B)(op: (B, A) => B): B
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).foldLeft(z)(op)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.foldLeft instead
- def foldRight[B](z: B)(op: (A, B) => B): B
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).foldRight(z)(op)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.foldRight instead
- def forall(f: (A) => Boolean): Boolean
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).forall(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.forall(...) instead
- def foreach[U](f: (A) => U): Unit
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).foreach(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.foreach(...) instead
- def formatted(fmtstr: String): String
Returns string formatted according to given
format
string.Returns string formatted according to given
format
string. Format strings are as forString.format
(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toStringFormat[PriorityQueue[A]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def hasDefiniteSize: Boolean
Tests whether this priority queue is known to have a finite size.
Tests whether this priority 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 returnstrue
if all elements have been computed. It returnsfalse
if the stream is not yet evaluated to the end. Non-empty Iterators usually returnfalse
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
returnstrue
. However, checkinghasDefiniteSize
can provide an assurance that size is well-defined and non-termination is not a concern.- returns
true
if this collection is known to have finite size,false
otherwise.
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
- See also
method
knownSize
for a more useful alternative
- def isEmpty: Boolean
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).isEmpty
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.isEmpty instead
- def map[B](f: (A) => B): IterableOnce[B]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).map(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.map instead or consider requiring an Iterable
- def max(implicit ord: math.Ordering[A]): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).max(ord)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.max instead
- def maxBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).maxBy(f)(cmp)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.maxBy(...) instead
- def min(implicit ord: math.Ordering[A]): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).min(ord)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.min instead
- def minBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).minBy(f)(cmp)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.minBy(...) instead
- def mkString: String
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).mkString
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
- def mkString(sep: String): String
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).mkString(sep)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
- def mkString(start: String, sep: String, end: String): String
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).mkString(start, sep, end)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
- def nonEmpty: Boolean
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).nonEmpty
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.nonEmpty instead
- def orderedCompanion: PriorityQueue.type
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
PriorityQueue
instead
- def product(implicit num: math.Numeric[A]): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).product(num)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.product instead
- def reduce(f: (A, A) => A): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).reduce(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.reduce(...) instead
- def reduceLeft(f: (A, A) => A): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).reduceLeft(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.reduceLeft(...) instead
- def reduceLeftOption(f: (A, A) => A): Option[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).reduceLeftOption(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.reduceLeftOption(...) instead
- def reduceOption(f: (A, A) => A): Option[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).reduceOption(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.reduceOption(...) instead
- def reduceRight(f: (A, A) => A): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).reduceRight(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.reduceRight(...) instead
- def reduceRightOption(f: (A, A) => A): Option[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).reduceRightOption(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.reduceRightOption(...) instead
- final def repr: PriorityQueue[A]
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use coll instead of repr in a collection implementation, use the collection value itself from the outside
- def sameElements[B >: A](that: IterableOnce[B]): Boolean
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.sameElements instead
- def seq: PriorityQueue.this.type
- Definition Classes
- Iterable
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Iterable.seq always returns the iterable itself
- def size: Int
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).size
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.size instead
- def sum(implicit num: math.Numeric[A]): A
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).sum(num)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.sum instead
- def to[C1](factory: Factory[A, C1]): C1
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).to(factory)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.to(factory) instead
- def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toArray(arg0)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.toArray
- def toBuffer[B >: A]: Buffer[B]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toBuffer
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.to(ArrayBuffer) instead
- def toIndexedSeq: collection.IndexedSeq[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toIndexedSeq
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.toIndexedSeq instead
- final def toIterable: collection.Iterable[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toIterable
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Iterable) instead
- final def toIterable: PriorityQueue.this.type
- returns
This collection as an
Iterable[A]
. No new collection will be built ifthis
is already anIterable[A]
.
- Definition Classes
- Iterable → IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to
toList
ortoSeq
, but it doesn't copy non-immutable collections
- def toIterator: Iterator[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toIterator
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator instead
- final def toIterator: Iterator[A]
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator instead of .toIterator
- def toList: immutable.List[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toList
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.to(List) instead
- def toMap[K, V](implicit ev: <:<[A, (K, V)]): immutable.Map[K, V]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toMap(ev)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.to(Map) instead
- def toSeq: immutable.Seq[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toSeq
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Seq) instead
- def toSet[B >: A]: immutable.Set[B]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toSet
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Set) instead
- def toStream: immutable.Stream[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toStream
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(LazyList) instead
- final def toStream: immutable.Stream[A]
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .to(LazyList) instead of .toStream
- final def toTraversable: collection.Traversable[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toTraversable
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Iterable) instead
- final def toTraversable: collection.Traversable[A]
Converts this priority queue to an unspecified Iterable.
Converts this priority queue to an unspecified Iterable. Will return the same collection if this instance is already Iterable.
- returns
An Iterable containing all elements of this priority queue.
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) toTraversable is internal and will be made protected; its name is similar to
toList
ortoSeq
, but it doesn't copy non-immutable collections
- def toVector: immutable.Vector[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).toVector
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Vector) instead
- 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.
- Definition Classes
- IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .view.slice(from, until) instead of .view(from, until)
- def withFilter(f: (A) => Boolean): Iterator[A]
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(priorityQueue: IterableOnceExtensionMethods[A]).withFilter(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.withFilter(...) instead
- def →[B](y: B): (PriorityQueue[A], B)
- Implicit
- This member is added by an implicit conversion from PriorityQueue[A] toArrowAssoc[PriorityQueue[A]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.collection.parallel
- Parallel collections (scala-parallel-collections.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.