abstract class PQueue[F[_], A] extends PQueueSource[F, A] with PQueueSink[F, A]

A purely functional Priority Queue implementation based on a binomial heap (Okasaki)

Assumes an Order instance is in scope for A

Self Type
PQueue[F, A]
Source
PQueue.scala
Linear Supertypes
PQueueSink[F, A], QueueSink[F, A], PQueueSource[F, A], QueueSource[F, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PQueue
  2. PQueueSink
  3. QueueSink
  4. PQueueSource
  5. QueueSource
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PQueue()

Abstract Value Members

  1. abstract def offer(a: A): F[Unit]

    Enqueues the given element at the back of the queue, possibly fiber blocking until sufficient capacity becomes available.

    Enqueues the given element at the back of the queue, possibly fiber blocking until sufficient capacity becomes available.

    a

    the element to be put at the back of the queue

    Definition Classes
    QueueSink
  2. abstract def size: F[Int]
    Definition Classes
    QueueSource
  3. abstract def take: F[A]

    Dequeues an element from the front of the queue, possibly fiber blocking until an element becomes available.

    Dequeues an element from the front of the queue, possibly fiber blocking until an element becomes available.

    Definition Classes
    QueueSource
  4. abstract def tryOffer(a: A): F[Boolean]

    Attempts to enqueue the given element at the back of the queue without semantically blocking.

    Attempts to enqueue the given element at the back of the queue without semantically blocking.

    a

    the element to be put at the back of the queue

    returns

    an effect that describes whether the enqueuing of the given element succeeded without blocking

    Definition Classes
    QueueSink
  5. abstract def tryTake: F[Option[A]]

    Attempts to dequeue an element from the front of the queue, if one is available without fiber blocking.

    Attempts to dequeue an element from the front of the queue, if one is available without fiber blocking.

    returns

    an effect that describes whether the dequeueing of an element from the queue succeeded without blocking, with None denoting that no element was available

    Definition Classes
    QueueSource

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def mapK[G[_]](f: ~>[F, G]): PQueue[G, A]

    Modifies the context in which this PQueue is executed using the natural transformation f.

    Modifies the context in which this PQueue is executed using the natural transformation f.

    O(1)

    returns

    a PQueue in the new context obtained by mapping the current one using f

  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. def tryOfferN(list: List[A])(implicit F: Monad[F]): F[List[A]]

    Attempts to enqueue the given elements without semantically blocking.

    Attempts to enqueue the given elements without semantically blocking. If an item in the list cannot be enqueued, the remaining elements will be returned. This is a convenience method that recursively runs tryOffer and does not offer any additional performance benefits.

    list

    the elements to be put in the PQueue

    returns

    an effect that contains the remaining valus that could not be offered.

    Definition Classes
    PQueueSinkQueueSink
  19. def tryTakeN(maxN: Option[Int])(implicit F: Monad[F]): F[List[A]]

    Attempts to dequeue elements from the PQueue, if they are available without semantically blocking.

    Attempts to dequeue elements from the PQueue, if they are available without semantically blocking. This is a convenience method that recursively runs tryTake. It does not provide any additional performance benefits.

    maxN

    The max elements to dequeue. Passing None will try to dequeue the whole queue.

    returns

    an effect that contains the dequeued elements from the PQueue Note: If there are multiple elements with least priority, the order in which they are dequeued is undefined.

    Definition Classes
    PQueueSourceQueueSource
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from PQueueSink[F, A]

Inherited from QueueSink[F, A]

Inherited from PQueueSource[F, A]

Inherited from QueueSource[F, A]

Inherited from AnyRef

Inherited from Any

Ungrouped