PQueue

cats.effect.std.PQueue
See thePQueue companion object
abstract class PQueue[F[_], A] extends PQueueSource[F, A], PQueueSink[F, A]

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

Assumes an Order instance is in scope for A

Attributes

Companion
object
Source
PQueue.scala
Graph
Supertypes
trait PQueueSink[F, A]
trait QueueSink[F, A]
trait PQueueSource[F, A]
trait QueueSource[F, A]
class Object
trait Matchable
class Any
Show all
Self type
PQueue[F, A]

Members list

Value members

Concrete methods

def mapK[G[_]](f: FunctionK[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)

Attributes

Returns

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

Source
PQueue.scala

Inherited methods

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.

Value parameters

a

the element to be put at the back of the queue

Attributes

Inherited from:
QueueSink
Source
QueueSink.scala
def size: F[Int]

Attributes

Inherited from:
QueueSource
Source
QueueSource.scala
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.

Attributes

Inherited from:
QueueSource
Source
QueueSource.scala
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.

Value parameters

a

the element to be put at the back of the queue

Attributes

Returns

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

Inherited from:
QueueSink
Source
QueueSink.scala
override 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.

Value parameters

list

the elements to be put in the PQueue

Attributes

Returns

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

Definition Classes
Inherited from:
PQueueSink
Source
PQueue.scala
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.

Attributes

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

Inherited from:
QueueSource
Source
QueueSource.scala
override 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.

Value parameters

maxN

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

Attributes

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
Inherited from:
PQueueSource
Source
PQueue.scala