Display the source code in std/container/binaryheap.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Module `std.container.binaryheap`

This module provides a BinaryHeap (aka priority queue) adaptor that makes a binary heap out of any user-provided random-access range.

This module is a submodule of std.container.

Example

import std.algorithm.comparison : equal;
import std.range : take;
auto maxHeap = heapify([4, 7, 3, 1, 5]);
assert(maxHeap.take(3).equal([7, 5, 4]));

auto minHeap = heapify!"a > b"([4, 7, 3, 1, 5]);
assert(minHeap.take(3).equal([1, 3, 4]));

Functions

Name	Description
`heapify(s, initialSize)`	Convenience function that returns a `BinaryHeap!Store` object initialized with `s` and `initialSize`.

Structs

Name	Description
`BinaryHeap`	Implements a binary heap container on top of a given random-access range type (usually `T[]`) or a random-access container type (usually `Array!T`). The documentation of `BinaryHeap` will refer to the underlying range or container as the store of the heap.

Authors

Andrei Alexandrescu

License

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at ).