iter_const_reference_t追加 #1084

cpprefjp · Jul 20, 2023 · cde8479 · cde8479
1 parent 79605e8
commit cde8479
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 1 deletion.
diff --git a/reference/iterator.md b/reference/iterator.md
@@ -78,7 +78,7 @@ C++20以降の標準ライブラリでは、任意のイテレータに対して
 | [`iter_reference_t`](iterator/iter_reference_t.md) | イテレータの`reference_type`を取得する (alias template)           | C++20          |
 | [`iter_rvalue_reference_t`](iterator/iter_rvalue_reference_t.md) | イテレータの指す要素の右辺値参照型を取得する (alias template)           | C++20          |
 | [`iter_common_reference_t`](iterator/iter_common_reference_t.md) | イテレータの`value_type`と`reference_type`の[`common_reference`](/reference/type_traits/common_reference.md)を取得する (alias template)           | C++20          |
-| [`iter_const_reference_t`](iterator/iter_const_reference_t.md.nolink) | イテレータの参照型（`iter_reference_t`）を`const`化したものを取得する (alias template)           | C++23          |
+| [`iter_const_reference_t`](iterator/iter_const_reference_t.md) | イテレータの参照型（`iter_reference_t`）を`const`化したものを取得する (alias template)           | C++23          |
 | [`indirect_result_t`](iterator/indirect_result_t.md) | 関数呼び出し可能な型`F`を複数のイテレータ`Is...`によって呼び出した時の戻り値型を取得する (alias template)           | C++20          |
 | [`projected`](iterator/projected.md) | イテレータ`I`の`Proj`による射影操作の結果を表すことのできる[`indirectly_readable`](/reference/iterator/indirectly_readable.md)なクラス (class template)           | C++20          |
 | [`incrementable_traits`](iterator/incrementable_traits.md)   | `iter_difference_t`にアダプトするためのカスタマイゼーションポイント (class template)               | C++20          |

diff --git a/reference/iterator/iter_const_reference_t.md b/reference/iterator/iter_const_reference_t.md
@@ -0,0 +1,91 @@
+# iter_const_reference_t
+* iterator[meta header]
+* std[meta namespace]
+* type-alias[meta id-type]
+* cpp20[meta cpp]
+
+```cpp
+namespace std {
+  template<indirectly_readable It>
+  using iter_const_reference_t = common_reference_t<const iter_value_t<It>&&, iter_reference_t<It>>;
+}
+```
+* indirectly_readable[link ./indirectly_readable.md]
+* common_reference_t[link /reference/type_traits/common_reference.md]
+* iter_value_t[link ./iter_value_t.md]
+* iter_reference_t[link ./iter_reference_t.md]
+
+## 概要
+
+任意のイテレータ型`It`から、そのイテレータの要素への`const`参照型を取得する。
+
+## 型の決定
+
+`iter_value_t<It>`が非参照型であり`iter_reference_t<It>`から修飾を除いた型であるとすると、`iter_reference_t<It>`に対して`iter_const_reference_t<It>`は基本的には次のようになる
+
+|`iter_reference_t`|`iter_const_reference_t<It>`|
+|---|---|
+|`T&`|`const T&`|
+|`T&&`|`const T&&`|
+|`const T&`|`const T&`|
+|`const T&&`|`const T&&`|
+|`T`|`T`|
+|`const T`|`T`|
+
+`It`に対して`iterator_traits`の特殊化が存在する場合や、`const iter_value_t<It>&&`と`iter_reference_t<It>`について`common_reference`が特殊化されている場合はこれと異なる結果となりうる。標準ライブラリにあるそのようなイテレータ型を持つものについて一部例を示すと、次のようになる
+
+|`It`の取得元の範囲|`iter_value_t<It>`|`iter_reference_t<It>`|`iter_const_reference_t<It>`|
+|---|---|---|---|
+|[`std::vector<bool>`](/reference/vector/vector.md)|`bool`|`std::vector<bool>::reference`|`bool`|
+|`const std::vector<bool>`|`bool`|`bool`|`bool`|
+|[`views::zip`](/reference/ranges/zip_view.md.nolink)|`std::tuple<T, U>`|`std::tuple<T&, U&>`|`std::tuple<const T&, const D&>`|
+|[`views::enumrate`](/reference/ranges/enumrate_view.md.nolink)|`std::tuple<D, T>`|`std::tuple<D, T&>`|`std::tuple<D, const T&>`|
+
+表中の`T, U`はそれそれの`view`に入力された範囲の値型、`D`は`views::enumrate`の入力範囲の`iter_difference_t`とする。
+
+## 例
+```cpp example
+#include <iterator>
+#include <tuple>
+
+// indirectly_readableとなる最低限の型
+// Rが参照型、Vが値型となる
+template<typename R, typename V>
+struct test_indirectly_readable {
+  using value_type = V;
+  using difference = std::ptrdiff_t;
+
+  auto operator*() const -> R;
+};
+
+int main() {
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<int&       , int>>, const int&>);
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<int&&      , int>>, const int&&>);
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<const int& , int>>, const int&>);
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<const int&&, int>>, const int&&>);
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<int        , int>>, int>);
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<const int  , int>>, int>);
+
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<std::tuple<int, double>  , std::tuple<int, double>>>, std::tuple<int, double>>);
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<std::tuple<int&, double&>, std::tuple<int, double>>>, std::tuple<const int&, const double&>>);
+  static_assert(std::same_as<std::iter_const_reference_t<test_indirectly_readable<std::tuple<int, double>& , std::tuple<int, double>>>, const std::tuple<int, double>&>);
+}
+```
+* std::iter_const_reference_t[color ff0000]
+
+### 出力
+```
+```
+
+## バージョン
+### 言語
+- C++23
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): 13.1
+- [Visual C++](/implementation.md#visual_cpp): 2022 Update 6
+
+## 参照
+
+- [P2278R4 `cbegin` should always return a constant iterator](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p2278r4.html)