book: translation of ch04

Update #12
2025-12-16 20:27:08 +03:00 · 2019-07-19 19:17:16 +02:00
parent bf6b09253b
commit 7776a59e97
9 changed files with 412 additions and 69 deletions
--- a/book/en-us/04-containers.md
+++ b/book/en-us/04-containers.md
@@ -6,9 +6,302 @@ order: 4

 # Chapter 04 Containers

-[Table of Content](./toc.md) | [Previous Chapter](./03-runtime.md) | [Next Chapter: Smart Pointers and Memory Management](./05-pointers.md)
+[TOC]

-## Further Readings
+## 4.1 Linear Container
+
+### `std::array`
+
+When you see this container, you will definitely have this problem:
+
+1. Why introduce `std::array` instead of `std::vector` directly?
+2. Already have a traditional array, why use `std::array`?
+
+First answer the first question. Unlike `std::vector`, the size of the `std::array` object is fixed. If the container size is fixed, then the `std::array` container can be used first.
+In addition, since `std::vector` is automatically expanded, when a large amount of data is stored, and the container is deleted,
+The container does not automatically return the corresponding memory of the deleted element. In this case, you need to manually run `shrink_to_fit()` to release this part of the memory.
+
+```cpp
+std::vector<int> v;
+std::cout << "size:" << v.size() << std::endl;         // output 0
+std::cout << "capacity:" << v.capacity() << std::endl; // output 0
+
+// As you can see, the storage of std::vector is automatically managed and 
+// automatically expanded as needed.
+// But if there is not enough space, you need to redistribute more memory, 
+// and reallocating memory is usually a performance-intensive operation.
+v.push_back(1);
+v.push_back(2);
+v.push_back(3);
+std::cout << "size:" << v.size() << std::endl;         // output 3
+std::cout << "capacity:" << v.capacity() << std::endl; // output 4
+
+// The auto-expansion logic here is very similar to Golang's slice.
+v.push_back(4);
+v.push_back(5);
+std::cout << "size:" << v.size() << std::endl;         // output 5
+std::cout << "capacity:" << v.capacity() << std::endl; // output 8
+
+// As can be seen below, although the container empties the element, 
+// the memory of the emptied element is not returned.
+v.clear();                                             
+std::cout << "size:" << v.size() << std::endl;         // output 0
+std::cout << "capacity:" << v.capacity() << std::endl; // output 8
+
+// Additional memory can be returned to the system via the shrink_to_fit() call
+v.shrink_to_fit();
+std::cout << "size:" << v.size() << std::endl;         // output 0
+std::cout << "capacity:" << v.capacity() << std::endl; // output 0
+```
+
+The second problem is much simpler. Using `std::array` can make the code more "modern" and encapsulate some manipulation functions, such as getting the array size and checking if it is not empty, and also using the standard friendly. Container algorithms in the library, such as `std::sort`.
+
+Using `std::array` is as simple as specifying its type and size:
+
+```cpp
+std::array<int, 4> arr = {1, 2, 3, 4};
+
+arr.empty(); // check if container is empty
+arr.size();  // return the size of the container
+
+// iterator support
+for (auto &i : arr)
+{
+    // ...
+}
+
+// use lambda expression for sort
+std::sort(arr.begin(), arr.end(), [](int a, int b) {
+    return b < a;
+});
+
+// array size must be constexpr
+constexpr int len = 4;
+std::array<int, len> arr = {1, 2, 3, 4};
+
+// illegal, different than C-style array, std::array will not deduce to T*
+// int *arr_p = arr;
+```
+
+When we started using `std::array`, it was inevitable that we would encounter a C-style compatible interface. There are three ways to do this:
+
+```cpp
+void foo(int *p, int len) {
+    return;
+}
+
+std::array<int, 4> arr = {1,2,3,4};
+
+// C-stype parameter passing
+// foo(arr, arr.size()); // illegal, cannot convert implicitly
+foo(&arr[0], arr.size());
+foo(arr.data(), arr.size());
+
+// use `std::sort`
+std::sort(arr.begin(), arr.end());
+```
+
+### `std::forward_list`
+
+`std::forward_list` is a list container, and the usage is basically similar to `std::list`, so we don't spend a lot of time introducing it.
+
+Need to know is that, unlike the implementation of the doubly linked list of `std::list`, `std::forward_list` is implemented using a singly linked list.
+Provides element insertion of `O(1)` complexity, does not support fast random access (this is also a feature of linked lists),
+It is also the only container in the standard library container that does not provide the `size()` method. Has a higher space utilization than `std::list` when bidirectional iteration is not required.
+
+## 4.2 Unordered Container
+
+We are already familiar with the ordered container `std::map`/`std::set` in traditional C++. These elements are internally implemented by red-black trees.
+The average complexity of inserts and searches is `O(log(size))`. When inserting an element, the element size is compared according to the `<` operator and the element is determined to be the same.
+And select the appropriate location to insert into the container. When traversing the elements in this container, the output will be traversed one by one in the order of the `<` operator.
+
+The elements in the unordered container are not sorted, and the internals are implemented by the Hash table. The average complexity of inserting and searching for elements is `O(constant)`,
+Significant performance gains can be achieved without concern for the order of the elements inside the container.
+
+C++11 introduces two sets of unordered containers: `std::unordered_map`/`std::unordered_multimap` and
+`std::unordered_set`/`std::unordered_multiset`.
+
+Their usage is basically similar to the original `std::map`/`std::multimap`/`std::set`/`set::multiset`
+Since these containers are already familiar to us, we will not compare them one by one. Let's compare `std::map` and `std::unordered_map` directly:
+
+```cpp
+#include <iostream>
+#include <string>
+#include <unordered_map>
+#include <map>
+
+int main() {
+    // initialized in same order
+    std::unordered_map<int, std::string> u = {
+        {1, "1"},
+        {3, "3"},
+        {2, "2"}
+    };
+    std::map<int, std::string> v = {
+        {1, "1"},
+        {3, "3"},
+        {2, "2"}
+    };
+    
+    // iterates in the same way
+    std::cout << "std::unordered_map" << std::endl;
+    for( const auto & n : u)
+        std::cout << "Key:[" << n.first << "] Value:[" << n.second << "]\n";
+    
+    std::cout << std::endl;
+    std::cout << "std::map" << std::endl;
+    for( const auto & n : v)
+        std::cout << "Key:[" << n.first << "] Value:[" << n.second << "]\n";
+}
+```
+
+The final output is:
+
+```txt
+std::unordered_map
+Key:[2] Value:[2]
+Key:[3] Value:[3]
+Key:[1] Value:[1]
+
+std::map
+Key:[1] Value:[1]
+Key:[2] Value:[2]
+Key:[3] Value:[3]
+```
+
+## 4.3 Tuples
+
+Programmers who have known Python should be aware of the concept of tuples. Looking at the containers in traditional C++, except for `std::pair`
+There seems to be no ready-made structure to store different types of data (usually we will define the structure ourselves).
+But the flaw of `std::pair` is obvious, only two elements can be saved.
+
+### Basic Operations
+
+There are three core functions for the use of tuples:
+
+1. `std::make_tuple`: construct tuple
+2. `std::get`: Get the value of a position in the tuple
+3. `std::tie`: tuple unpacking
+
+```cpp
+#include <tuple>
+#include <iostream>
+
+auto get_student(int id) {
+    if (id == 0)
+        return std::make_tuple(3.8, 'A', "John");
+    if (id == 1)
+        return std::make_tuple(2.9, 'C', "Jack");
+    if (id == 2)
+        return std::make_tuple(1.7, 'D', "Ive");
+
+    // it is not allowed to return 0 directly
+    // return type is std::tuple<double, char, std::string>
+    return std::make_tuple(0.0, 'D', "null");
+}
+
+int main() {
+    auto student = get_student(0);
+    std::cout << "ID: 0, "
+              << "GPA: "   << std::get<0>(student) << ", "
+              << "Grade: " << std::get<1>(student) << ", "
+              << "Name: "  << std::get<2>(student) << '\n';
+
+    double gpa;
+    char grade;
+    std::string name;
+
+    // unpack tuples
+    std::tie(gpa, grade, name) = get_student(1);
+    std::cout << "ID: 1, "
+              << "GPA: "   << gpa << ", "
+              << "Grade: " << grade << ", "
+              << "Name: "  << name << '\n';
+}
+```
+
+`std::get` In addition to using constants to get tuple objects, C++14 adds usage types to get objects in tuples:
+
+```cpp
+std::tuple<std::string, double, double, int> t("123", 4.5, 6.7, 8);
+std::cout << std::get<std::string>(t) << std::endl;
+std::cout << std::get<double>(t) << std::endl; // illegal, runtime error
+std::cout << std::get<3>(t) << std::endl;
+```
+
+### Runtime Indexing
+
+If you think about it, you might find the problem with the above code. `std::get<>` depends on a compile-time constant, so the following is not legal:
+
+```cpp
+int index = 1;
+std::get<index>(t);
+```
+
+So what do you do? The answer is to use `std::variant<>` (introduced by C++ 17) to provide type template parameters for `variant<>`
+You can have a `variant<>` to accommodate several types of variables provided (in other languages, such as Python/JavaScript, etc., as dynamic types):
+
+```cpp
+#include <variant>
+template <size_t n, typename... T>
+constexpr std::variant<T...> _tuple_index(const std::tuple<T...>& tpl, size_t i) {
+    if constexpr (n >= sizeof...(T))
+        throw std::out_of_range("越界.");
+    if (i == n)
+        return std::variant<T...>{ std::in_place_index<n>, std::get<n>(tpl) };
+    return _tuple_index<(n < sizeof...(T)-1 ? n+1 : 0)>(tpl, i);
+}
+template <typename... T>
+constexpr std::variant<T...> tuple_index(const std::tuple<T...>& tpl, size_t i) {
+    return _tuple_index<0>(tpl, i);
+}
+template <typename T0, typename ... Ts>
+std::ostream & operator<< (std::ostream & s, std::variant<T0, Ts...> const & v) { 
+    std::visit([&](auto && x){ s << x;}, v); 
+    return s;
+}
+```
+
+So we can:
+
+```cpp
+int i = 1;
+std::cout << tuple_index(t, i) << std::endl;
+```
+
+### Merge and Iteration
+
+Another common requirement is to merge two tuples, which can be done with `std::tuple_cat`:
+
+```cpp
+auto new_tuple = std::tuple_cat(get_student(1), std::move(t));
+```
+
+You can immediately see how quickly you can traverse a tuple? But we just introduced how to index a `tuple` by a very number at runtime, then the traversal becomes simpler.
+First we need to know the length of a tuple, which can:
+
+```cpp
+template <typename T>
+auto tuple_len(T &tpl) {
+    return std::tuple_size<T>::value;
+}
+```
+
+This will iterate over the tuple:
+
+```cpp
+for(int i = 0; i != tuple_len(new_tuple); ++i)
+    // runtime indexing
+    std::cout << tuple_index(i, new_tuple) << std::endl;
+```
+
+## Conclusion
+
+This chapter briefly introduces the new containers in modern C++. Their usage is similar to that of the existing containers in C++. It is relatively simple, and you can choose the containers you need to use according to the actual scene, so as to get better performance.
+
+Although `std::tuple` is effective, the standard library provides limited functionality and there is no way to meet the requirements of runtime indexing and iteration. Fortunately, we have other methods that we can implement on our own.
+
+[Table of Content](./toc.md) | [Previous Chapter](./03-runtime.md) | [Next Chapter: Smart Pointers and Memory Management](./05-pointers.md)

 ## Licenses

--- a/book/en-us/toc.md
+++ b/book/en-us/toc.md
@@ -56,13 +56,15 @@
        + Move semantics
        + Perfect forwarding
 - [**Chapter 04 Containers**](./04-containers.md)
-    + 4.1 `std::array` and `std::forward_list`
+    + 4.1 Linear containers
+        + `std::array`
+        + `std::forward_list`
    + 4.2 Unordered containers
-      + `std::unordered_set`
-      + `std::unordered_map`
+        + `std::unordered_set`
+        + `std::unordered_map`
    + 4.3 Tuples `std::tuple`
        + basic operation
-        + runtime indexing
+        + runtime indexing `std::variant`
        + merge and iteration
 - [**Chapter 05 Smart Pointers and Memory Management**](./05-pointers.md)
    + 5.1 RAII and reference counting
--- a/book/zh-cn/04-containers.md
+++ b/book/zh-cn/04-containers.md
@@ -8,7 +8,7 @@ order: 4

 [TOC]

-## 4.1 `std::array` 和 `std::forward_list`
+## 4.1 线性容器

 ### `std::array`

@@ -166,7 +166,7 @@ Key:[2] Value:[2]
 Key:[3] Value:[3]
 ```

-## 4.3 元组 `std::tuple`
+## 4.3 元组

 了解过 Python 的程序员应该知道元组的概念，纵观传统 C++ 中的容器，除了 `std::pair` 外，
 似乎没有现成的结构能够用来存放不同类型的数据（通常我们会自己定义结构）。
@@ -297,7 +297,7 @@ for(int i = 0; i != tuple_len(new_tuple); ++i)

 ## 总结

-本节简单介绍了 C++11/14 中新增的容器，它们的用法和传统 C++ 中已有的容器类似，相对简单，可以根据实际场景丰富的选择需要使用的容器，从而获得更好的性能。
+本章简单介绍了现代 C++ 中新增的容器，它们的用法和传统 C++ 中已有的容器类似，相对简单，可以根据实际场景丰富的选择需要使用的容器，从而获得更好的性能。

 `std::tuple` 虽然有效，但是标准库提供的功能有限，没办法满足运行期索引和迭代的需求，好在我们还有其他的方法可以自行实现。

--- a/book/zh-cn/toc.md
+++ b/book/zh-cn/toc.md
@@ -56,13 +56,15 @@
        + 移动语义
        + 完美转发
 - [**第 4 章 标准库: 容器**](./04-containers.md)
-    + 4.1 `std::array` 和 `std::forward_list`
+    + 4.1 线性容器
+        + `std::array`
+        + `std::forward_list`
    + 4.2 无序容器
        + `std::unordered_set`
        + `std::unordered_map`
    + 4.3 元组 `std::tuple`
        + 基本操作
-        + 运行期索引
+        + 运行期索引 `std::variant`
        + 合并与迭代
 - [**第 5 章 标准库: 指针**](./05-pointers.md)
    + 5.1 RAII 与引用计数
--- a/code/4/4.1.cpp
+++ b/code/4/4.1.cpp
@@ -1,36 +0,0 @@
-//
-// 4.1.cpp
-// modern c++ tutorial
-//
-// created by changkun at changkun.de
-// https://github.com/changkun/modern-cpp-tutorial
-//
-// std::array
-
-#include <iostream>
-#include <array>
-
-void foo(int *p, int len) {
-    for (int i = 0; i != len; ++i) {
-        std::cout << p[i] << std::endl;
-    }
-}
-
-int main() {
-    std::array<int, 4> arr= {1,4,3,2};
-    
-    //int len = 4;
-    //std::array<int, len> arr = {1,2,3,4}; // 非法, 数组大小参数必须是常量表达式
-    
-    // C 风格接口传参
-    // foo(arr, arr.size());           // 非法, 无法隐式转换
-    foo(&arr[0], arr.size());
-    foo(arr.data(), arr.size());
-    
-    // 更多接口使用
-    std::sort(arr.begin(), arr.end());
-    for(auto &i : arr)
-        std::cout << i << std::endl;
-    
-    return 0;
-}
--- a/code/4/4.1.linear.container.cpp
+++ b/code/4/4.1.linear.container.cpp
@@ -0,0 +1,68 @@
+//
+// 4.1.linear.container.cpp
+// modern c++ tutorial
+//
+// created by changkun at changkun.de
+// https://github.com/changkun/modern-cpp-tutorial
+//
+
+#include <iostream>
+#include <array>
+#include <vector>
+
+void foo(int *p, int len) {
+    for (int i = 0; i != len; ++i) {
+        std::cout << p[i] << std::endl;
+    }
+}
+
+int main() {
+    std::vector<int> v;
+    std::cout << "size:" << v.size() << std::endl;         // output 0
+    std::cout << "capacity:" << v.capacity() << std::endl; // output 0
+
+    // As you can see, the storage of std::vector is automatically managed and 
+    // automatically expanded as needed.
+    // But if there is not enough space, you need to redistribute more memory, 
+    // and reallocating memory is usually a performance-intensive operation.
+    v.push_back(1);
+    v.push_back(2);
+    v.push_back(3);
+    std::cout << "size:" << v.size() << std::endl;         // output 3
+    std::cout << "capacity:" << v.capacity() << std::endl; // output 4
+
+    // The auto-expansion logic here is very similar to Golang's slice.
+    v.push_back(4);
+    v.push_back(5);
+    std::cout << "size:" << v.size() << std::endl;         // output 5
+    std::cout << "capacity:" << v.capacity() << std::endl; // output 8
+
+    // As can be seen below, although the container empties the element, 
+    // the memory of the emptied element is not returned.
+    v.clear();                                             
+    std::cout << "size:" << v.size() << std::endl;         // output 0
+    std::cout << "capacity:" << v.capacity() << std::endl; // output 8
+
+    // Additional memory can be returned to the system via the shrink_to_fit() call
+    v.shrink_to_fit();
+    std::cout << "size:" << v.size() << std::endl;         // output 0
+    std::cout << "capacity:" << v.capacity() << std::endl; // output 0
+
+
+    std::array<int, 4> arr= {1,4,3,2};
+    
+    //int len = 4;
+    //std::array<int, len> arr = {1,2,3,4}; // illegal, size of array must be constexpr
+    
+    // C style parameter passing
+    // foo(arr, arr.size());           // illegal, cannot convert implicitly
+    foo(&arr[0], arr.size());
+    foo(arr.data(), arr.size());
+
+    // more usage
+    std::sort(arr.begin(), arr.end());
+    for(auto &i : arr)
+        std::cout << i << std::endl;
+    
+    return 0;
+}
--- a/code/4/4.2.unordered.map.cpp
+++ b/code/4/4.2.unordered.map.cpp
@@ -1,11 +1,11 @@
 //
-// 4.2.cpp
+// 4.2.unordered.map.cpp
+// chapter 04 containers
 // modern c++ tutorial
 //
 // created by changkun at changkun.de
 // https://github.com/changkun/modern-cpp-tutorial
 //
-// 无序容器

 #include <iostream>
 #include <string>
@@ -13,7 +13,7 @@
 #include <map>

 int main() {
-    // 两组结构按同样的顺序初始化
+    // initialized in same order
    std::unordered_map<int, std::string> u = {
        {1, "1"},
        {3, "3"},
@@ -25,7 +25,7 @@ int main() {
        {2, "2"}
    };
    
-    // 分别对两组结构进行遍历
+    // iterates in the same way
    std::cout << "std::unordered_map" << std::endl;
    for( const auto & n : u)
        std::cout << "Key:[" << n.first << "] Value:[" << n.second << "]\n";
--- a/code/4/4.3.tuples.cpp
+++ b/code/4/4.3.tuples.cpp
@@ -1,11 +1,11 @@
 //
-// 4.3.cpp
+// 4.3.tuples.cpp
+// chapter 04 containers
 // modern c++ tutorial
 //
 // created by changkun at changkun.de
 // https://github.com/changkun/modern-cpp-tutorial
 //
-// std::tuple 及其操作


 #include <tuple>
@@ -15,19 +15,19 @@
 auto get_student(int id)
 {
    if (id == 0)
-        return std::make_tuple(3.8, 'A', "张三");
+        return std::make_tuple(3.8, 'A', "John");
    if (id == 1)
-        return std::make_tuple(2.9, 'C', "李四");
+        return std::make_tuple(2.9, 'C', "Jack");
    if (id == 2)
-        return std::make_tuple(1.7, 'D', "王五");
-    // 返回类型被推断为 std::tuple<double, char, std::string>
+        return std::make_tuple(1.7, 'D', "Ive");
+    // return type is std::tuple<double, char, std::string>
    return std::make_tuple(0.0, 'D', "null");
 }

 template <size_t n, typename... T>
 constexpr std::variant<T...> _tuple_index(const std::tuple<T...>& tpl, size_t i) {
    if constexpr (n >= sizeof...(T))
-        throw std::out_of_range("越界.");
+        throw std::out_of_range("out of range.");
    if (i == n)
        return std::variant<T...>{ std::in_place_index<n>, std::get<n>(tpl) };
    return _tuple_index<(n < sizeof...(T)-1 ? n+1 : 0)>(tpl, i);
@@ -52,32 +52,32 @@ int main()
 {
    auto student = get_student(0);
    std::cout << "ID: 0, "
-    << "GPA: " << std::get<0>(student) << ", "
-    << "成绩: " << std::get<1>(student) << ", "
-    << "姓名: " << std::get<2>(student) << '\n';
+              << "GPA: "   << std::get<0>(student) << ", "
+              << "Grade: " << std::get<1>(student) << ", "
+              << "Name: "  << std::get<2>(student) << '\n';
    
    double gpa;
    char grade;
    std::string name;
    
-    // 元组进行拆包
+    // tuple unpack
    std::tie(gpa, grade, name) = get_student(1);
    std::cout << "ID: 1, "
-    << "GPA: " << gpa << ", "
-    << "成绩: " << grade << ", "
-    << "姓名: " << name << '\n';
+              << "GPA: "   << gpa   << ", "
+              << "Grade: " << grade << ", "
+              << "Name: "  << name  << '\n';
    
    
    std::tuple<std::string, double, double, int> t("123", 4.5, 6.7, 8);
    std::cout << std::get<std::string>(t) << std::endl;
-    // std::cout << std::get<double>(t) << std::endl;   // 非法, 引发编译期错误
+    // std::cout << std::get<double>(t) << std::endl;   // illegal, runtime error
    std::cout << std::get<3>(t) << std::endl;
    
-    // 拼接元组
+    // concat
    auto new_tuple = std::tuple_cat(get_student(1), std::move(t));
    
-    // 迭代
+    // iteration
    for(int i = 0; i != tuple_len(new_tuple); ++i) {
-        std::cout << tuple_index(new_tuple, i) << std::endl; // 运行期索引
+        std::cout << tuple_index(new_tuple, i) << std::endl; // runtime indexing
    }
 }
--- a/code/4/Makefile
+++ b/code/4/Makefile
@@ -0,0 +1,14 @@
+#
+# modern cpp tutorial
+#
+# created by changkun at changkun.de
+# https://github.com/changkun/modern-cpp-tutorial
+#
+
+all: $(patsubst %.cpp, %.out, $(wildcard *.cpp))
+
+%.out: %.cpp Makefile
+	clang++ $< -o $@ -std=c++2a -pedantic
+
+clean:
+	rm *.out