Auto merge of #434 - Amanieu:release-0.14.0, r=Amanieu

Prepare release of v0.14.0 See the changelog for highlights.
rust-lang · Jun 5, 2023 · 3056ee9 · 3056ee9
2 parents 3784c2f + 32b125e
commit 3056ee9
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,20 +7,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+## [v0.14.0] - 2023-06-01
+
 ### Added
 
 - Support for `allocator-api2` crate
-  for interfacing with custom allocators on stable.
+  for interfacing with custom allocators on stable. (#417)
+- Optimized implementation for ARM using NEON instructions. (#430)
+- Support for rkyv serialization. (#432)
+- `Equivalent` trait to look up values without `Borrow`. (#345)
+- `Hash{Map,Set}::raw_table_mut` is added whic returns a mutable reference. (#404)
+- Fast path for `clear` on empty tables. (#428)
 
 ### Changed
 
-- Bumped MSRV to 1.63.0.
+- Optimized insertion to only perform a single lookup. (#277)
+- `DrainFilter` has been renamed to `ExtractIf` and no longer drops remaining
+  elements when the iterator is dropped. #(374)
+- Bumped MSRV to 1.64.0. (#431)
+- `{Map,Set}::raw_table` now returns an immutable reference. (#404)
+- `VacantEntry` and `OccupiedEntry` now use the default hasher if none is
+  specified in generics. (#389)
+- `RawTable::data_start` now returns a `NonNull` to match `RawTable::data_end`. (#387)
+- `RawIter::{reflect_insert, reflect_remove}` are now unsafe. (#429)
+- `RawTable::find_potential` is renamed to `find_or_find_insert_slot` and returns an `InsertSlot`. (#429)
+- `RawTable::remove` now also returns an `InsertSlot`. (#429)
+- `InsertSlot` can be used to insert an element with `RawTable::insert_in_slot`. (#429)
+- `RawIterHash` no longer has a lifetime tied to that of the `RawTable`. (#427)
+- The trait bounds of `HashSet::raw_table` have been relaxed to not require `Eq + Hash`. (#423)
+- `EntryRef::and_replace_entry_with` and `OccupiedEntryRef::replace_entry_with`
+  were changed to give a `&K` instead of a `&Q` to the closure.
 
 ### Removed
 
 - Support for `bumpalo` as an allocator with custom wrapper.
   Use `allocator-api2` feature in `bumpalo` to use it as an allocator
-  for `hashbrown` collections.
+  for `hashbrown` collections. (#417)
 
 ## [v0.13.2] - 2023-01-12
 
@@ -263,7 +285,7 @@ This release was _yanked_ due to inconsistent hashes being generated with the `n
 ## [v0.6.2] - 2019-10-23
 
 ### Added
-- Added an `inline-more` feature (enabled by default) which allows choosing a tradeoff between 
+- Added an `inline-more` feature (enabled by default) which allows choosing a tradeoff between
   runtime performance and compilation time. (#119)
 
 ## [v0.6.1] - 2019-10-04
@@ -411,7 +433,8 @@ This release was _yanked_ due to a breaking change for users of `no-default-feat
 
 - Initial release
 
-[Unreleased]: https://github.com/rust-lang/hashbrown/compare/v0.13.2...HEAD
+[Unreleased]: https://github.com/rust-lang/hashbrown/compare/v0.14.0...HEAD
+[v0.14.0]: https://github.com/rust-lang/hashbrown/compare/v0.13.2...v0.14.0
 [v0.13.2]: https://github.com/rust-lang/hashbrown/compare/v0.13.1...v0.13.2
 [v0.13.1]: https://github.com/rust-lang/hashbrown/compare/v0.12.3...v0.13.1
 [v0.12.3]: https://github.com/rust-lang/hashbrown/compare/v0.12.2...v0.12.3

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "hashbrown"
-version = "0.13.2"
+version = "0.14.0"
 authors = ["Amanieu d'Antras <amanieu@gmail.com>"]
 description = "A Rust port of Google's SwissTable hash map"
 license = "MIT OR Apache-2.0"

diff --git a/README.md b/README.md
@@ -40,52 +40,52 @@ Compared to the previous implementation of `std::collections::HashMap` (Rust 1.3
 
 With the hashbrown default AHash hasher:
 
-| name                    |  oldstdhash ns/iter | hashbrown ns/iter | diff ns/iter |  diff %  | speedup |
-|:------------------------|:-------------------:|------------------:|:------------:|---------:|---------|
-| insert_ahash_highbits       | 18,865      | 8,020         |               -10,845 | -57.49%  | x 2.35 |
-| insert_ahash_random         | 19,711      | 8,019         |               -11,692 | -59.32%  | x 2.46 |
-| insert_ahash_serial         | 19,365      | 6,463         |               -12,902 | -66.63%  | x 3.00 |
-| insert_erase_ahash_highbits | 51,136      | 17,916        |               -33,220 | -64.96%  | x 2.85 |
-| insert_erase_ahash_random   | 51,157      | 17,688        |               -33,469 | -65.42%  | x 2.89 |
-| insert_erase_ahash_serial   | 45,479      | 14,895        |               -30,584 | -67.25%  | x 3.05 |
-| iter_ahash_highbits         | 1,399       | 1,092         |                  -307 | -21.94%  | x 1.28 |
-| iter_ahash_random           | 1,586       | 1,059         |                  -527 | -33.23%  | x 1.50 |
-| iter_ahash_serial           | 3,168       | 1,079         |                -2,089 | -65.94%  | x 2.94 |
-| lookup_ahash_highbits       | 32,351      | 4,792         |               -27,559 | -85.19%  | x 6.75 |
-| lookup_ahash_random         | 17,419      | 4,817         |               -12,602 | -72.35%  | x 3.62 |
-| lookup_ahash_serial         | 15,254      | 3,606         |               -11,648 | -76.36%  | x 4.23 |
-| lookup_fail_ahash_highbits  | 21,187      | 4,369         |               -16,818 | -79.38%  | x 4.85 |
-| lookup_fail_ahash_random    | 21,550      | 4,395         |               -17,155 | -79.61%  | x 4.90 |
-| lookup_fail_ahash_serial    | 19,450      | 3,176         |               -16,274 | -83.67%  | x 6.12 |
+| name                        | oldstdhash ns/iter | hashbrown ns/iter | diff ns/iter |  diff % | speedup |
+| :-------------------------- | :----------------: | ----------------: | :----------: | ------: | ------- |
+| insert_ahash_highbits       |       18,865       |             8,020 |   -10,845    | -57.49% | x 2.35  |
+| insert_ahash_random         |       19,711       |             8,019 |   -11,692    | -59.32% | x 2.46  |
+| insert_ahash_serial         |       19,365       |             6,463 |   -12,902    | -66.63% | x 3.00  |
+| insert_erase_ahash_highbits |       51,136       |            17,916 |   -33,220    | -64.96% | x 2.85  |
+| insert_erase_ahash_random   |       51,157       |            17,688 |   -33,469    | -65.42% | x 2.89  |
+| insert_erase_ahash_serial   |       45,479       |            14,895 |   -30,584    | -67.25% | x 3.05  |
+| iter_ahash_highbits         |       1,399        |             1,092 |     -307     | -21.94% | x 1.28  |
+| iter_ahash_random           |       1,586        |             1,059 |     -527     | -33.23% | x 1.50  |
+| iter_ahash_serial           |       3,168        |             1,079 |    -2,089    | -65.94% | x 2.94  |
+| lookup_ahash_highbits       |       32,351       |             4,792 |   -27,559    | -85.19% | x 6.75  |
+| lookup_ahash_random         |       17,419       |             4,817 |   -12,602    | -72.35% | x 3.62  |
+| lookup_ahash_serial         |       15,254       |             3,606 |   -11,648    | -76.36% | x 4.23  |
+| lookup_fail_ahash_highbits  |       21,187       |             4,369 |   -16,818    | -79.38% | x 4.85  |
+| lookup_fail_ahash_random    |       21,550       |             4,395 |   -17,155    | -79.61% | x 4.90  |
+| lookup_fail_ahash_serial    |       19,450       |             3,176 |   -16,274    | -83.67% | x 6.12  |
 
 
 With the libstd default SipHash hasher:
 
-|name                     |  oldstdhash ns/iter | hashbrown ns/iter | diff ns/iter |  diff %  | speedup |
-|:------------------------|:-------------------:|------------------:|:------------:|---------:|---------|
-|insert_std_highbits       |19,216      |16,885           |            -2,331    |   -12.13%  | x 1.14 |
-|insert_std_random         |19,179      |17,034           |            -2,145    |   -11.18%  | x 1.13 |
-|insert_std_serial         |19,462      |17,493           |            -1,969    |   -10.12%  | x 1.11 |
-|insert_erase_std_highbits |50,825      |35,847           |            -14,978   |   -29.47%  | x 1.42 |
-|insert_erase_std_random   |51,448      |35,392           |            -16,056   |   -31.21%  | x 1.45 |
-|insert_erase_std_serial   |87,711      |38,091           |            -49,620   |   -56.57%  | x 2.30 |
-|iter_std_highbits         |1,378       |1,159            |            -219      |   -15.89%  | x 1.19 |
-|iter_std_random           |1,395       |1,132            |            -263      |   -18.85%  | x 1.23 |
-|iter_std_serial           |1,704       |1,105            |            -599      |   -35.15%  | x 1.54 |
-|lookup_std_highbits       |17,195      |13,642           |            -3,553    |   -20.66%  | x 1.26 |
-|lookup_std_random         |17,181      |13,773           |            -3,408    |   -19.84%  | x 1.25 |
-|lookup_std_serial         |15,483      |13,651           |            -1,832    |   -11.83%  | x 1.13 |
-|lookup_fail_std_highbits  |20,926      |13,474           |            -7,452    |   -35.61%  | x 1.55 |
-|lookup_fail_std_random    |21,766      |13,505           |            -8,261    |   -37.95%  | x 1.61 |
-|lookup_fail_std_serial    |19,336      |13,519           |            -5,817    |   -30.08%  | x 1.43 |
+| name                      | oldstdhash ns/iter | hashbrown ns/iter | diff ns/iter |  diff % | speedup |
+| :------------------------ | :----------------: | ----------------: | :----------: | ------: | ------- |
+| insert_std_highbits       |       19,216       |            16,885 |    -2,331    | -12.13% | x 1.14  |
+| insert_std_random         |       19,179       |            17,034 |    -2,145    | -11.18% | x 1.13  |
+| insert_std_serial         |       19,462       |            17,493 |    -1,969    | -10.12% | x 1.11  |
+| insert_erase_std_highbits |       50,825       |            35,847 |   -14,978    | -29.47% | x 1.42  |
+| insert_erase_std_random   |       51,448       |            35,392 |   -16,056    | -31.21% | x 1.45  |
+| insert_erase_std_serial   |       87,711       |            38,091 |   -49,620    | -56.57% | x 2.30  |
+| iter_std_highbits         |       1,378        |             1,159 |     -219     | -15.89% | x 1.19  |
+| iter_std_random           |       1,395        |             1,132 |     -263     | -18.85% | x 1.23  |
+| iter_std_serial           |       1,704        |             1,105 |     -599     | -35.15% | x 1.54  |
+| lookup_std_highbits       |       17,195       |            13,642 |    -3,553    | -20.66% | x 1.26  |
+| lookup_std_random         |       17,181       |            13,773 |    -3,408    | -19.84% | x 1.25  |
+| lookup_std_serial         |       15,483       |            13,651 |    -1,832    | -11.83% | x 1.13  |
+| lookup_fail_std_highbits  |       20,926       |            13,474 |    -7,452    | -35.61% | x 1.55  |
+| lookup_fail_std_random    |       21,766       |            13,505 |    -8,261    | -37.95% | x 1.61  |
+| lookup_fail_std_serial    |       19,336       |            13,519 |    -5,817    | -30.08% | x 1.43  |
 
 ## Usage
 
 Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-hashbrown = "0.13"
+hashbrown = "0.14"
 ```
 
 Then:
@@ -101,6 +101,7 @@ This crate has the following Cargo features:
 
 - `nightly`: Enables nightly-only features including: `#[may_dangle]`.
 - `serde`: Enables serde serialization support.
+- `rkyv`: Enables rkyv serialization support.
 - `rayon`: Enables rayon parallel iterator support.
 - `raw`: Enables access to the experimental and unsafe `RawTable` API.
 - `inline-more`: Adds inline hints to most functions, improving run-time performance at the cost