CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.5.0] - 2022-09-30

Added

• #[must_use] attribute to many methods, porting and extending several rust-lang/rust PRs
• Method shrink_to(), ported from rust-lang/rust
• Implementation of From<[T; N]> for BinaryHeap<T>, ported from rust-lang/rust#84111
• Links to referenced items in the documenation
• Example of a min-heap, ported from rust-lang/rust#60451
• Documentation of time complexities of several methods, ported from rust-lang/rust#60952

Changed

• Migrate to Rust 2021 Edition
• Increase MSRV (minimum supported rust version) to rust 1.56.0.
• Implement From<BinaryHeap<T, C>> for Vec<T> instead of Into<Vec<T>> for BinaryHeap<T, C>
• Port rust-lang/rust#77435 improvement to rebuild heuristic of BinaryHeap::append()
• Use italics with big-O notation in documentation, ported from rust-lang/rust#71167
• Relax trait bound C: Compare<T> on BinaryHeap<T, C> struct and certain methods, in part ported from rust-lang/rust#58421
• Synchronize internal implementation details with std::collections::BinaryHeap in Rust 1.62.0

[0.4.1] - 2021-01-06

Added

• Performance improvement (#28)
  • Port rust-lang/rust#78857 - Improve BinaryHeap performance

[0.4.0] - 2020-09-29

Added

• Performance improvement (#27)
  • Avoid sift_down for unmutated PeekMut (rust#75974)

Changed

• Bump MSRV (minimum supported rust version) to rust 1.32.0.

[0.3.1] - 2020-09-24

Added

• generic constructor from_vec_cmp_raw().
• replace_cmp() which replace the comparator of heap and its unsafe version replace_cmp_raw().

[0.3.0] - 2020-07-08

Added

• Quickstart section in the doc
• .into_iter_sorted() which returns the values in heap order. (#13)
  • Note: .into_iter() returns the values in arbitrary order. There is a good reason (ex. make .extend() efficient) for std to do that, it was surprising to some people.

Changed

• Migrate to Rust 2018 Edition.
• Bump MSRV (minimum supported rust version) to rust 1.31.1.
• [CI] Switched to Github actions.
• [CI] travis is removed because it was unreliable.
• [CI] appveyor is removed because it's slow.

[0.2.0] - 2019-05-27

Changed

• [COMPATIBILITY] Use Compare trait from compare crate instead of our own definition. Most users should not be affected by this. TIP: External Compare<T> impls needs to be updated to use Fn instead of FnMut.
• [COMPATIBILITY] rename feature serde1 to serde in order to comply with the guideline: https://rust-lang-nursery.github.io/api-guidelines/interoperability.html#c-serde
• Refactor ctor impl.

[0.1.6] - 2019-05-21

Added

• generic constructor from_vec() and from_vec_cmp().

Changed

• Refactor other ctor to call above methods.

[0.1.5] - 2019-05-20

Added

• serde1 feature which adds Serialize/Deserialize

[0.1.4]

Fixed

• Merge #1) Do not require T: Ord when a custom comparator is provided

[0.1.3] - 2018-05-14

• Add comprehensive CI based on trust CI template v0.1.2
• README.md tweaks.

[0.1.2] - 2018-05-14

• Cargo.toml tweaks

[0.1.1] - 2018-05-14

• Initial tag