ソート済み構造に対する集合演算の説明を追加 #919

tetsurom · tetsurom · commit da057c719dbd · 2022-03-21T02:35:15.000+09:00
diff --git a/reference/algorithm.md b/reference/algorithm.md
@@ -329,11 +329,11 @@ ranges::sort(pv, {}, &Parson::name);
 | [`set_difference`](algorithm/set_difference.md)     | 2つのソート済み範囲の差集合を得る | |
 | [`set_symmetric_difference`](algorithm/set_symmetric_difference.md) | 2つのソート済み範囲の対称差集合を得る | |
 | [`includes`](algorithm/includes.md) | 2つのソート済み範囲において、一方の範囲の要素がもう一方の範囲に全て含まれているかを判定する | |
-| [`ranges::set_union`](algorithm/ranges_set_union.md.nolink)                               | 2つのソート済み範囲の和集合を得る                                                           | C++20 |
-| [`ranges::set_intersection`](algorithm/ranges_set_intersection.md.nolink)                 | 2つのソート済み範囲の積集合を得る                                                           | C++20 |
-| [`ranges::set_difference`](algorithm/ranges_set_difference.md.nolink)                     | 2つのソート済み範囲の差集合を得る                                                           | C++20 |
-| [`ranges::set_symmetric_difference`](algorithm/ranges_set_symmetric_difference.md.nolink) | 2つのソート済み範囲の対称差集合を得る                                                       | C++20 |
-| [`ranges::includes`](algorithm/ranges_includes.md.nolink)                                 | 2つのソート済み範囲において、一方の範囲の要素がもう一方の範囲に全て含まれているかを判定する | C++20 |
+| [`ranges::set_union`](algorithm/ranges_set_union.md)                               | 2つのソート済み範囲の和集合を得る                                                           | C++20 |
+| [`ranges::set_intersection`](algorithm/ranges_set_intersection.md)                 | 2つのソート済み範囲の積集合を得る                                                           | C++20 |
+| [`ranges::set_difference`](algorithm/ranges_set_difference.md)                     | 2つのソート済み範囲の差集合を得る                                                           | C++20 |
+| [`ranges::set_symmetric_difference`](algorithm/ranges_set_symmetric_difference.md) | 2つのソート済み範囲の対称差集合を得る                                                       | C++20 |
+| [`ranges::includes`](algorithm/ranges_includes.md)                                 | 2つのソート済み範囲において、一方の範囲の要素がもう一方の範囲に全て含まれているかを判定する | C++20 |
 
 ### ヒープ
 
diff --git a/reference/algorithm/ranges_includes.md b/reference/algorithm/ranges_includes.md
@@ -0,0 +1,78 @@
+# includes
+* algorithm[meta header]
+* std::ranges[meta namespace]
+* function template[meta id-type]
+* cpp20[meta cpp]
+
+```cpp
+namespace std::ranges {
+  template<input_iterator I1, sentinel_for<I1> S1, input_iterator I2, sentinel_for<I2> S2, class Proj1 = identity, class Proj2 = identity,
+           indirect_strict_weak_order<projected<I1, Proj1>, projected<I2, Proj2>> Comp = ranges::less>
+  constexpr bool includes(I1 first1, S1 last1, I2 first2, S2 last2, Comp comp = {}, Proj1 proj1 = {}, Proj2 proj2 = {}); // (1)
+
+  template<input_range R1, input_range R2, class Proj1 = identity, class Proj2 = identity,
+           indirect_strict_weak_order<projected<iterator_t<R1>, Proj1>, projected<iterator_t<R2>, Proj2>> Comp = ranges::less>
+  constexpr bool ranges::includes(R1&& r1, R2&& r2, Comp comp = {}, Proj1 proj1 = {}, Proj2 proj2 = {});                 // (2)
+}
+```
+* input_iterator[link /reference/iterator/input_iterator.md]
+* sentinel_for[link /reference/iterator/sentinel_for.md]
+* indirect_strict_weak_order[link /reference/iterator/indirect_strict_weak_order.md]
+* projected[link /reference/iterator/projected.md]
+* ranges::less[link /reference/functional/ranges_less.md]
+* identity[link /reference/functional/identity.md]
+* input_range[link /reference/ranges/input_range.md]
+* iterator_t[link /reference/ranges/iterator_t.md]
+
+## 概要
+2つのソート済み範囲において、一方の範囲の要素がもう一方の範囲に全て含まれているかを判定する。
+
+* (1): イテレーターペアで範囲を指定する
+* (2): 範囲を直接指定する
+
+## 戻り値
+`[first2,last2)` が `empty` であるか、`[first2,last2)` の全ての要素が `[first1,last1)` に含まれている場合は `true`、そうでない場合は `false` を返す。
+
+
+## 計算量
+最大で `2 * ((last1 - first1) + (last2 - first2)) - 1` 回比較する
+
+
+## 例
+```cpp example
+#include <iostream>
+#include <set>
+#include <algorithm>
+
+int main()
+{
+  std::set<int> a = {1, 2, 3, 4, 5, 6};
+  std::set<int> b = {2, 4, 6};
+  std::set<int> c = {2, 4, 7};
+
+  std::cout << std::boolalpha;
+
+  std::cout << std::ranges::includes(a, b) << std::endl;
+  std::cout << std::ranges::includes(a, c) << std::endl;
+}
+```
+* std::ranges::includes[color ff0000]
+
+### 出力
+```
+true
+false
+```
+
+## バージョン
+### 言語
+- C++20
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): 10.1.0
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): 2019 Update 10
+
+## 参照
+- [N4861 25 Algorithms library](https://timsong-cpp.github.io/cppwp/n4861/algorithms)
diff --git a/reference/algorithm/ranges_set_difference.md b/reference/algorithm/ranges_set_difference.md
@@ -0,0 +1,117 @@
+# set_difference
+* algorithm[meta header]
+* std::ranges[meta namespace]
+* function template[meta id-type]
+* cpp20[meta cpp]
+
+```cpp
+namespace std::ranges {
+  template<class I, class O>
+  using set_union_result = in_out_result<I, O>;
+
+  template<input_iterator I1, sentinel_for<I1> S1, input_iterator I2, sentinel_for<I2> S2, weakly_incrementable O,
+           class Comp = ranges::less, class Proj1 = identity, class Proj2 = identity>
+    requires mergeable<I1, I2, O, Comp, Proj1, Proj2>
+  constexpr set_difference_result<I1, O>
+    set_difference(I1 first1, S1 last1, I2 first2, S2 last2, O result, Comp comp = {}, Proj1 proj1 = {}, Proj2 proj2 = {}); // (1)
+
+  template<input_range R1, input_range R2, weakly_incrementable O,
+           class Comp = ranges::less, class Proj1 = identity, class Proj2 = identity>
+    requires mergeable<iterator_t<R1>, iterator_t<R2>, O, Comp, Proj1, Proj2>
+  constexpr set_difference_result<borrowed_iterator_t<R1>, O>
+    set_difference(R1&& r1, R2&& r2, O result, Comp comp = {}, Proj1 proj1 = {}, Proj2 proj2 = {});                         // (2)
+}
+```
+* in_out_result[link in_out_result.md.nolink]
+* input_iterator[link /reference/iterator/input_iterator.md]
+* sentinel_for[link /reference/iterator/sentinel_for.md]
+* weakly_incrementable[link /reference/iterator/weakly_incrementable.md]
+* ranges::less[link /reference/functional/ranges_less.md]
+* identity[link /reference/functional/identity.md]
+* mergeable[link /reference/iterator/mergeable.md]
+* input_range[link /reference/ranges/input_range.md]
+* iterator_t[link /reference/ranges/iterator_t.md]
+* borrowed_iterator_t[link /reference/ranges/borrowed_iterator_t.md]
+
+
+## 概要
+2つのソート済み範囲の差集合を得る
+
+* (1): イテレーターペアで範囲を指定する
+* (2): 範囲を直接指定する
+
+## 事前条件
+結果の範囲は両方の入力の範囲と重なっていてはならない。
+
+
+## 効果
+`[first1,last1)` から、`[first2,last2)` に存在していない要素を `result` へコピーする。構築された範囲はソートされている。
+
+
+## 戻り値
+次のメンバをもつtuple-likeオブジェクト。
+
+```cpp
+set_union_result {
+  .in  = last1,
+  .out = result_last,
+}
+```
+
+ただし、`result_last` は構築された範囲の終端。 
+
+
+## 計算量
+最大で `2 * ((last1 - first1) + (last2 - first2)) - 1` 回の比較を行う
+
+
+## 備考
+`[first1,last1)` が `m` 個、`[first2,last2)` が `n` 個の等価な要素を含んでいる場合、`[first1,last1)` から最後の [`max`](max.md)`(m-n, 0)` 要素が出力の範囲へコピーされる。
+
+
+## 例
+```cpp example
+#include <iostream>
+#include <set>
+#include <algorithm>
+#include <iterator>
+
+int main()
+{
+  std::multiset<int> a = {1, 2, 3, 4, 5, 6};
+  std::multiset<int> b = {2, 3, 4};
+  std::multiset<int> result;
+
+  // a - bの差集合を作る
+  std::ranges::set_difference(a, b, std::inserter(result, result.end()));
+
+  for (int x : result) {
+    std::cout << x << std::endl;
+  }
+}
+```
+* std::ranges::set_difference[color ff0000]
+* std::multiset[link /reference/set/multiset.md]
+* begin()[link /reference/set/set/begin.md]
+* end()[link /reference/set/set/end.md]
+* std::inserter[link /reference/iterator/inserter.md]
+
+### 出力
+```
+1
+5
+6
+```
+
+## バージョン
+### 言語
+- C++20
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): 10.1.0
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): 2019 Update 10
+
+## 参照
+- [N4861 25 Algorithms library](https://timsong-cpp.github.io/cppwp/n4861/algorithms)
diff --git a/reference/algorithm/ranges_set_intersection.md b/reference/algorithm/ranges_set_intersection.md
@@ -0,0 +1,115 @@
+# set_intersection
+* algorithm[meta header]
+* std::ranges[meta namespace]
+* function template[meta id-type]
+* cpp20[meta cpp]
+
+```cpp
+namespace std::ranges {
+  template<class I1, class I2, class O>
+  using set_intersection_result = in_in_out_result<I1, I2, O>;
+
+  template<input_iterator I1, sentinel_for<I1> S1, input_iterator I2, sentinel_for<I2> S2, weakly_incrementable O,
+           class Comp = ranges::less, class Proj1 = identity, class Proj2 = identity>
+    requires mergeable<I1, I2, O, Comp, Proj1, Proj2>
+  constexpr set_intersection_result<I1, I2, O>
+    set_intersection(I1 first1, S1 last1, I2 first2, S2 last2, O result, Comp comp = {}, Proj1 proj1 = {}, Proj2 proj2 = {});  // (1)
+
+  template<input_range R1, input_range R2, weakly_incrementable O,
+           class Comp = ranges::less, class Proj1 = identity, class Proj2 = identity>
+    requires mergeable<iterator_t<R1>, iterator_t<R2>, O, Comp, Proj1, Proj2>
+  constexpr set_intersection_result<borrowed_iterator_t<R1>, borrowed_iterator_t<R2>, O>
+    set_intersection(R1&& r1, R2&& r2, O result, Comp comp = {}, Proj1 proj1 = {}, Proj2 proj2 = {});                          // (2)
+}
+```
+* in_in_out_result[link in_in_out_result.md.nolink]
+* input_iterator[link /reference/iterator/input_iterator.md]
+* sentinel_for[link /reference/iterator/sentinel_for.md]
+* weakly_incrementable[link /reference/iterator/weakly_incrementable.md]
+* ranges::less[link /reference/functional/ranges_less.md]
+* identity[link /reference/functional/identity.md]
+* mergeable[link /reference/iterator/mergeable.md]
+* input_range[link /reference/ranges/input_range.md]
+* iterator_t[link /reference/ranges/iterator_t.md]
+* borrowed_iterator_t[link /reference/ranges/borrowed_iterator_t.md]
+
+## 概要
+2つのソート済み範囲の積集合を得る
+
+* (1): イテレーターペアで範囲を指定する
+* (2): 範囲を直接指定する
+
+
+## 事前条件
+結果の範囲は両方の入力の範囲と重なっていてはならない。
+
+
+## 効果
+２つの範囲からソート済みの intersection を構築する。つまり、両方の範囲のみにある要素の集合を構築する。
+
+
+## 戻り値
+次のメンバをもつtuple-likeオブジェクト。
+
+```cpp
+set_union_result {
+  .in1 = last1,
+  .in2 = last2,
+  .out = result_last,
+}
+```
+
+ただし、`result_last` は構築された範囲の終端。 
+
+## 計算量
+最大で `2 * ((last1 - first1) + (last2 - first2)) - 1` 回の比較を行う
+
+
+## 備考
+`[first1,last1)` が `m` 個、`[first2,last2)` が `n` 個の等価な要素を含んでいる場合、`[first1,last1)` から最初の [`min`](min.md)`(m, n)` 要素が出力の範囲へ順番にコピーされる。
+
+
+## 例
+```cpp example
+#include <iostream>
+#include <set>
+#include <algorithm>
+#include <iterator>
+
+int main()
+{
+  std::multiset<int> a = {1, 2, 3, 4};
+  std::multiset<int> b = {4, 5, 6, 2};
+  std::multiset<int> result;
+
+  // aとbの積集合を作る
+  std::set_intersection(a, b, std::inserter(result, result.end()));
+
+  for (int x : result) {
+    std::cout << x << std::endl;
+  }
+}
+```
+* std::ranges::set_intersection[color ff0000]
+* std::multiset[link /reference/set/multiset.md]
+* end()[link /reference/set/set/end.md]
+* std::inserter[link /reference/iterator/inserter.md]
+
+### 出力
+```
+2
+4
+```
+
+## バージョン
+### 言語
+- C++20
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): 10.1.0
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): 2019 Update 10
+
+## 参照
+- [N4861 25 Algorithms library](https://timsong-cpp.github.io/cppwp/n4861/algorithms)
diff --git a/reference/algorithm/ranges_set_symmetric_difference.md b/reference/algorithm/ranges_set_symmetric_difference.md
diff --git a/reference/algorithm/ranges_set_union.md b/reference/algorithm/ranges_set_union.md
