Class PriorityQueue

A Queue implemented using a backing Array where the front of the queue is the smallest element according to the order relation defined by compare() function. Note that this implementation doesn't guarantee the back/last element to be the largest element of the queue.

The size of the backing Array is called the capacity of the PriorityQueue. The capacity of a new instance is specified by the given initialCapacity. The capacity is increased when size exceeds the capacity. The new capacity is the product of the needed capacity and the given growthFactor.

By: Loic Rouchon

Anything
- Object
  - Basic ...and other supertypes
    PriorityQueue ...and other supertypes

PriorityQueue
- Basic
  - Identifiable
  - Object
    Anything
- Collection
  - Iterable
    Category
- Queue

no subtypes hierarchy

Initializer
`PriorityQueue(Comparison compare(Element x, Element y), Integer initialCapacity = 0, Float growthFactor = ..., {Element}Go to Iterable abbreviation {X+} or {X} means Iterable<X,Nothing> or Iterable<X,Null> elements = ...)` Parameters: `compare` A comparator function used to order elements. `initialCapacity = 0` The initial size of the backing array. `growthFactor = 1.5` The factor used to determine the new size of the backing array when a new backing array is allocated. `elements = {}` The initial elements of the queue.

Initializer

PriorityQueue(Comparison compare(Element x, Element y), Integer initialCapacity = 0, Float growthFactor = ..., {Element*}Go to Iterable abbreviation {X+} or {X*} means Iterable<X,Nothing> or Iterable<X,Null> elements = ...)

Parameters:

compare
A comparator function used to order elements.
initialCapacity = 0
The initial size of the backing array.
growthFactor = 1.5
The factor used to determine the new size of the backing array when a new backing array is allocated.
elements = {}
The initial elements of the queue.

Attributes
`back`	Source Code`shared actual Element?Go to Null abbreviations X? means Null\|X back` The element currently at the end of the queue, or `null` if the queue is empty. This is not necessarily the largest element (regarding the order relation defined by `compare()`) of the queue. Refines `Queue.back`
`front`	Source Code`shared actual Element?Go to Null abbreviations X? means Null\|X front` The smallest element (regarding the order relation defined by `compare()`) of the queue, or `null` if the queue is empty. Refines `Queue.front`
`last`	Source Code`shared actual Element?Go to Null abbreviations X? means Null\|X last` The element currently at the end of the queue, or `null` if the queue is empty. This is not necessarily the largest element (regarding the order relation defined by `compare()`) of the queue. Refines `Iterable.last`
`size`	Source Code`shared actual Integer size` The number of elements returned by the `iterator` of this stream, if the iterator terminates. In the case of an infinite stream, this operation never terminates. Refines `Iterable.size`

Inherited Attributes
Attributes inherited from: `Object` `Object.hash`, `Object.string`
Attributes inherited from: `Collection<Element>` `Collection.string`
Attributes inherited from: `Iterable<Element,Absent>` `Iterable.coalesced`, `Iterable.cycled`, `Iterable.empty`, `Iterable.exceptLast`, `Iterable.first`, `Iterable.indexed`, `Iterable.last`, `Iterable.paired`, `Iterable.rest`, `Iterable.size`, `Iterable.string`
Attributes inherited from: `Queue<Element>` `Queue.back`, `Queue.front`

Methods
`accept`	Source Code`shared actual Element?Go to Null abbreviations X? means Null\|X accept()` Remove and return the smallest element (`front` element) from this queue Refines `Queue.accept`
`clone`	Source Code`shared actual Collection<Element> clone()` A shallow copy of this collection, that is, a collection with identical elements which does not change if this collection changes. If this collection is immutable, it is acceptable to return a reference to this collection. If this collection is mutable, a newly instantiated collection must be returned. Refines `Collection.clone`
`iterator`	Source Code`shared actual Iterator<Element> iterator()` An iterator for the elements belonging to this queue. Elements returned by this iterator are not ordered Refines `Iterable.iterator`
`offer`	Source Code `shared actual void offer(Element element)` Add a new element to the queue. Refines `Queue.offer`

Inherited Methods
Methods inherited from: `Object` `Object.equals()`
Methods inherited from: `Category<Element>` `Category.contains()`, `Category.containsAny()`, `Category.containsEvery()`
Methods inherited from: `Collection<Element>` `Collection.clone()`
Methods inherited from: `Iterable<Element,Absent>` `Iterable.any()`, `Iterable.by()`, `Iterable.chain()`, `Iterable.collect()`, `Iterable.count()`, `Iterable.defaultNullElements()`, `Iterable.every()`, `Iterable.filter()`, `Iterable.find()`, `Iterable.findLast()`, `Iterable.flatMap()`, `Iterable.fold()`, `Iterable.follow()`, `Iterable.getFromFirst()`, `Iterable.interpose()`, `Iterable.iterator()`, `Iterable.longerThan()`, `Iterable.map()`, `Iterable.max()`, `Iterable.partition()`, `Iterable.product()`, `Iterable.reduce()`, `Iterable.repeat()`, `Iterable.scan()`, `Iterable.select()`, `Iterable.sequence()`, `Iterable.shorterThan()`, `Iterable.skip()`, `Iterable.skipWhile()`, `Iterable.sort()`, `Iterable.spread()`, `Iterable.take()`, `Iterable.takeWhile()`
Methods inherited from: `Queue<Element>` `Queue.accept()`, `Queue.offer()`

Keyboard Shortcuts

Documentation:

Search page:

Filter declarations by tags