Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
948cf78
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
88c0239
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
b49cb17
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
51162a2
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
ba2c430
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
085aa69
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
b2815d5
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
b410f8e
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
2613767
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
b29d44b
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
87606b0
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
bb57d85
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
46c7eef
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
b2e2b57
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
1271ffb
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
069ff85
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
56c18df
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
57d3820
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
914e46a
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
f14289f
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
8f84c06
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
41863b0
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
c9ba490
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
89b0da4
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
26750fb
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
f74d9b1
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
2f0f134
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
2f3ae2c
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
649a417
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
563f4bd
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
f6d466f
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
27b684b
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
9cb778b
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
356c681
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
404baed
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
a5dd4b2
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
b8588c0
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
da4fb68
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
d38088c
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
2ac9569
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
508f678
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
f9e18fb
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
9209ef2
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
b361ed1
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
755ed4d
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
3adb7e4
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
12114fc
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
7cd144e
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
840f4c3
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
68bec4c
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
8efe4cc
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
e95d03b
Added translation using Weblate (Chinese (Simplified Han script))
will-cppa Jun 5, 2026
35a8e6f
Update translation files
weblate Jun 5, 2026
0f868c8
Update translation files
weblate Jun 5, 2026
9dfd142
Update translation files
weblate Jun 5, 2026
d6b8911
Update translation files
weblate Jun 5, 2026
9714a40
Update translation files
weblate Jun 5, 2026
971071d
Update translation files
weblate Jun 5, 2026
a778cd7
Update translation files
weblate Jun 5, 2026
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
51 changes: 51 additions & 0 deletions doc/modules/ROOT/nav_zh_Hans.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
* xref:intro.adoc[]
* xref:buckets.adoc[]
* xref:hash_equality.adoc[]
* xref:regular.adoc[]
* xref:concurrent.adoc[]
* xref:hash_quality.adoc[]
* xref:compliance.adoc[]
* xref:structures.adoc[]
* xref:debuggability.adoc[]
* xref:benchmarks.adoc[]
* xref:rationale.adoc[]
* xref:ref.adoc[]
** xref:reference/header_unordered_map_fwd.adoc[`<boost/unordered/unordered_map_fwd.hpp>`]
** xref:reference/header_unordered_map_top.adoc[`<boost/unordered_map.hpp>`]
** xref:reference/header_unordered_map.adoc[`<boost/unordered/unordered_map.hpp>`]
** xref:reference/unordered_map.adoc[`unordered_map`]
** xref:reference/unordered_multimap.adoc[`unordered_multimap`]
** xref:reference/header_unordered_set_fwd.adoc[`<boost/unordered/unordered_set_fwd.hpp>`]
** xref:reference/header_unordered_set_top.adoc[`<boost/unordered_set.hpp>`]
** xref:reference/header_unordered_set.adoc[`<boost/unordered/unordered_set.hpp>`]
** xref:reference/unordered_set.adoc[`unordered_set`]
** xref:reference/unordered_multiset.adoc[`unordered_multiset`]
** xref:reference/hash_traits.adoc[Hash Traits]
** xref:reference/stats.adoc[Statistics]
** xref:reference/header_unordered_flat_map_fwd.adoc[`<boost/unordered/unordered_flat_map_fwd.hpp>`]
** xref:reference/header_unordered_flat_map.adoc[`<boost/unordered/unordered_flat_map.hpp>`]
** xref:reference/unordered_flat_map.adoc[`unordered_flat_map`]
** xref:reference/header_unordered_flat_set_fwd.adoc[`<boost/unordered/unordered_flat_set_fwd.hpp>`]
** xref:reference/header_unordered_flat_set.adoc[`<boost/unordered/unordered_flat_set.hpp>`]
** xref:reference/unordered_flat_set.adoc[`unordered_flat_set`]
** xref:reference/header_unordered_node_map_fwd.adoc[`<boost/unordered/unordered_node_map_fwd.hpp>`]
** xref:reference/header_unordered_node_map.adoc[`<boost/unordered/unordered_node_map.hpp>`]
** xref:reference/unordered_node_map.adoc[`unordered_node_map`]
** xref:reference/header_unordered_node_set_fwd.adoc[`<boost/unordered/unordered_node_set_fwd.hpp>`]
** xref:reference/header_unordered_node_set.adoc[`<boost/unordered/unordered_node_set.hpp>`]
** xref:reference/unordered_node_set.adoc[`unordered_node_set`]
** xref:reference/header_concurrent_flat_map_fwd.adoc[`<boost/unordered/concurrent_flat_map_fwd.hpp>`]
** xref:reference/header_concurrent_flat_map.adoc[`<boost/unordered/concurrent_flat_map.hpp>`]
** xref:reference/concurrent_flat_map.adoc[`concurrent_flat_map`]
** xref:reference/header_concurrent_flat_set_fwd.adoc[`<boost/unordered/concurrent_flat_set_fwd.hpp>`]
** xref:reference/header_concurrent_flat_set.adoc[`<boost/unordered/concurrent_flat_set.hpp>`]
** xref:reference/concurrent_flat_set.adoc[`concurrent_flat_set`]
** xref:reference/header_concurrent_node_map_fwd.adoc[`<boost/unordered/concurrent_node_map_fwd.hpp>`]
** xref:reference/header_concurrent_node_map.adoc[`<boost/unordered/concurrent_node_map.hpp>`]
** xref:reference/concurrent_node_map.adoc[`concurrent_node_map`]
** xref:reference/header_concurrent_node_set_fwd.adoc[`<boost/unordered/concurrent_node_set_fwd.hpp>`]
** xref:reference/header_concurrent_node_set.adoc[`<boost/unordered/concurrent_node_set.hpp>`]
** xref:reference/concurrent_node_set.adoc[`concurrent_node_set`]
* xref:changes.adoc[]
* xref:bibliography.adoc[]
* xref:copyright.adoc[]
553 changes: 553 additions & 0 deletions doc/modules/ROOT/pages/benchmarks_zh_Hans.adoc

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions doc/modules/ROOT/pages/bibliography_zh_Hans.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[#bibliography]

:idprefix: bibliography_

= Bibliography

* _C/C++ Users Journal_. February, 2006. Pete Becker. http://www.ddj.com/cpp/184402066[STL and TR1: Part III - Unordered containers^]. +
An introduction to the standard unordered containers.
* _Wikipedia_. https://en.wikipedia.org/wiki/Hash_table[Hash table^]. +
An introduction to hash table implementations. Discusses the differences between closed-addressing and open-addressing approaches.
* Peter Dimov, 2022. https://pdimov.github.io/articles/unordered_dev_plan.html[Development Plan for Boost.Unordered^].

101 changes: 101 additions & 0 deletions doc/modules/ROOT/pages/buckets_zh_Hans.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
[#buckets]
:idprefix: buckets_

= Basics of Hash Tables

The containers are made up of a number of _buckets_, each of which can contain any number of elements. For example, the following diagram shows a `xref:reference/unordered_set.adoc#unordered_set[boost::unordered_set]` with 7 buckets containing 5 elements, `A`, `B`, `C`, `D` and `E` (this is just for illustration, containers will typically have more buckets).

image::buckets.png[]

In order to decide which bucket to place an element in, the container applies the hash function, `Hash`, to the element's key (for sets the key is the whole element, but is referred to as the key so that the same terminology can be used for sets and maps). This returns a value of type `std::size_t`. `std::size_t` has a much greater range of values then the number of buckets, so the container applies another transformation to that value to choose a bucket to place the element in.

Retrieving the elements for a given key is simple. The same process is applied to the key to find the correct bucket. Then the key is compared with the elements in the bucket to find any elements that match (using the equality predicate `Pred`). If the hash function has worked well the elements will be evenly distributed amongst the buckets so only a small number of elements will need to be examined.

There is xref:hash_equality.adoc#hash_equality[more information on hash functions and equality predicates in the next section].

You can see in the diagram that `A` & `D` have been placed in the same bucket. When looking for elements in this bucket up to 2 comparisons are made, making the search slower. This is known as a *collision*. To keep things fast we try to keep collisions to a minimum.

If instead of `boost::unordered_set` we had used `xref:reference/unordered_flat_set.adoc[boost::unordered_flat_set]`, the diagram would look as follows:

image::buckets-oa.png[]

In open-addressing containers, buckets can hold at most one element; if a collision happens (like is the case of `D` in the example), the element uses some other available bucket in the vicinity of the original position. Given this simpler scenario, Boost.Unordered open-addressing containers offer a very limited API for accessing buckets.

[caption=, title='Table {counter:table-counter}. Methods for Accessing Buckets']
[cols="1,.^1", frame=all, grid=rows]
|===
2+^h| *All containers* h|*Method* h|*Description*

|`size_type bucket_count() const`
|The number of buckets.

2+^h| *Closed-addressing containers only* h|*Method* h|*Description*

|`size_type max_bucket_count() const`
|An upper bound on the number of buckets.
|`size_type bucket_size(size_type n) const`
|The number of elements in bucket `n`.

|`size_type bucket(key_type const& k) const`
|Returns the index of the bucket which would contain `k`.

|`local_iterator begin(size_type n)`
1.6+|Return begin and end iterators for bucket `n`.

|`local_iterator end(size_type n)`

|`const_local_iterator begin(size_type n) const`

|`const_local_iterator end(size_type n) const`

|`const_local_iterator cbegin(size_type n) const`

|`const_local_iterator cend(size_type n) const`

|===

== Controlling the Number of Buckets

As more elements are added to an unordered associative container, the number of collisions will increase causing performance to degrade. To combat this the containers increase the bucket count as elements are inserted. You can also tell the container to change the bucket count (if required) by calling `rehash`.

The standard leaves a lot of freedom to the implementer to decide how the number of buckets is chosen, but it does make some requirements based on the container's _load factor_, the number of elements divided by the number of buckets. Containers also have a _maximum load factor_ which they should try to keep the load factor below.

You can't control the bucket count directly but there are two ways to influence it:

* Specify the minimum number of buckets when constructing a container or when calling `rehash`.
* Suggest a maximum load factor by calling `max_load_factor`.

`max_load_factor` doesn't let you set the maximum load factor yourself, it just lets you give a _hint_. And even then, the standard doesn't actually require the container to pay much attention to this value. The only time the load factor is _required_ to be less than the maximum is following a call to `rehash`. But most implementations will try to keep the number of elements below the max load factor, and set the maximum load factor to be the same as or close to the hint - unless your hint is unreasonably small or large.

[caption=, title='Table {counter:table-counter}. Methods for Controlling Bucket Size']
[cols="1,.^1", frame=all, grid=rows]
|===
2+^h| *All containers* h|*Method* h|*Description*

|`X(size_type n)`
|Construct an empty container with at least `n` buckets (`X` is the container type).

|`X(InputIterator i, InputIterator j, size_type n)`
|Construct an empty container with at least `n` buckets and insert elements from the range `[i, j)` (`X` is the container type).

|`float load_factor() const`
|The average number of elements per bucket.

|`float max_load_factor() const`
|Returns the current maximum load factor.

|`float max_load_factor(float z)`
|Changes the container's maximum load factor, using `z` as a hint. +
**Open-addressing and concurrent containers:** this function does nothing: users are not allowed to change the maximum load factor.

|`void rehash(size_type n)`
|Changes the number of buckets so that there at least `n` buckets, and so that the load factor is less than the maximum load factor.

2+^h| *Open-addressing and concurrent containers only* h|*Method* h|*Description*

|`size_type max_load() const`
|Returns the maximum number of allowed elements in the container before rehash.

|===

A note on `max_load` for open-addressing and concurrent containers: the maximum load will be (`max_load_factor() * bucket_count()`) right after `rehash` or on container creation, but may slightly decrease when erasing elements in high-load situations. For instance, if we have a `xref:reference/unordered_flat_map.adoc#unordered_flat_map[boost::unordered_flat_map]` with `size()` almost at `max_load()` level and then erase 1,000 elements, `max_load()` may decrease by around a few dozen elements. This is done internally by Boost.Unordered in order to keep its performance stable, and must be taken into account when planning for rehash-free insertions.
Loading