Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc aliases for BinaryHeap pushpop and heapify implementations #84939

Closed
wants to merge 2 commits into from
Closed

Add doc aliases for BinaryHeap pushpop and heapify implementations #84939

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1b7643
Add doc aliases for BinaryHeap pushpop and heapify implementations
lopopolo May 5, 2021
e9800a2
Add 'priority queue' doc alias to BinaryHeap to match C++
lopopolo May 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions library/alloc/src/collections/binary_heap.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,8 @@ use super::SpecExtend;
/// [peek\_mut]: BinaryHeap::peek_mut
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(not(test), rustc_diagnostic_item = "BinaryHeap")]
#[doc(alias = "priority queue")]
#[doc(alias = "priority_queue")]
pub struct BinaryHeap<T> {
data: Vec<T>,
}
Expand Down Expand Up @@ -405,6 +407,8 @@ impl<T: Ord> BinaryHeap<T> {
/// If the item is modified then the worst case time complexity is *O*(log(*n*)),
/// otherwise it's *O*(1).
#[stable(feature = "binary_heap_peek_mut", since = "1.12.0")]
#[doc(alias = "pushpop")]
#[doc(alias = "push_pop")]
pub fn peek_mut(&mut self) -> Option<PeekMut<'_, T>> {
if self.is_empty() { None } else { Some(PeekMut { heap: self, sift: false }) }
}
Expand Down Expand Up @@ -1457,6 +1461,7 @@ impl<T: Ord> From<Vec<T>> for BinaryHeap<T> {
/// Converts a `Vec<T>` into a `BinaryHeap<T>`.
///
/// This conversion happens in-place, and has *O*(*n*) time complexity.
#[doc(alias = "heapify")]
fn from(vec: Vec<T>) -> BinaryHeap<T> {
let mut heap = BinaryHeap { data: vec };
heap.rebuild();
Expand Down