mdspan: layout_{left,right}_padded::mapping概要

yohhoy · yohhoy · commit 01cb1074891b · 2024-07-28T22:33:33.000+09:00
P2645R5 -&gt; P2645R6
diff --git a/reference/mdspan.md b/reference/mdspan.md
@@ -64,4 +64,4 @@
 ## 参照
 - [P0009R18 MDSPAN](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p0009r18.html)
 - [P2630R4 Submdspan](https://open-std.org/jtc1/sc22/wg21/docs/papers/2023/p2630r4.html)
-- [P2642R5 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p2642r5.html)
+- [P2642R6 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2642r6.pdf)
diff --git a/reference/mdspan/LayoutMapping.md b/reference/mdspan/LayoutMapping.md
@@ -93,8 +93,8 @@ LayoutMappingを満たす型`M`は
 - [`layout_left::mapping<E>`](layout_left/mapping.md)
 - [`layout_right::mapping<E>`](layout_right/mapping.md)
 - [`layout_stride::mapping<E>`](layout_stride/mapping.md)
-- [`layout_left_padded<PV>::mapping<E>`](layout_left_padded/mapping.md.nolink)
-- [`layout_right_padded<PV>::mapping<E>`](layout_right_padded/mapping.md.nolink)
+- [`layout_left_padded<S>::mapping<E>`](layout_left_padded/mapping.md)
+- [`layout_right_padded<S>::mapping<E>`](layout_right_padded/mapping.md)
 - [`layout_blas_packed<T,SO>::mapping<E>`](/reference/linalg/layout_blas_packed/mapping.md)
 
 
diff --git a/reference/mdspan/LayoutMappingPolicy.md b/reference/mdspan/LayoutMappingPolicy.md
@@ -40,8 +40,8 @@ LayoutMappingPolicyを満たす型`MP`は
 - [`layout_left`](layout_left.md)
 - [`layout_right`](layout_right.md)
 - [`layout_stride`](layout_stride.md)
-- [`layout_left_padded<PV>`](layout_left_padded.md)
-- [`layout_right_padded<PV>`](layout_right_padded.md)
+- [`layout_left_padded<S>`](layout_left_padded.md)
+- [`layout_right_padded<S>`](layout_right_padded.md)
 - [`linalg::layout_blas_packed<T,SO>`](/reference/linalg/layout_blas_packed.md)
 
 
diff --git a/reference/mdspan/is-layout-left-padded-mapping-of.md b/reference/mdspan/is-layout-left-padded-mapping-of.md
@@ -0,0 +1,25 @@
+# is-layout-left-padded-mapping-of
+* mdspan[meta header]
+* variable[meta id-type]
+* cpp26[meta cpp]
+
+```cpp
+template<class Mapping>
+constexpr bool is-layout-left-padded-mapping-of = see below;  // exposition only
+```
+* see below[italic]
+
+
+## 概要
+`is-layout-left-padded-mapping-of`は、[`layout_left_padded<S>::mapping`](layout_left_padded/mapping.md)を判定する説明専用変数テンプレートである。
+
+`size_t`型の任意の値`S`として`Mapping`が[`layout_left_padded<S>::mapping`](layout_left_padded/mapping.md)の特殊化であるときに限り、`is-layout-left-padded-mapping-of<Mapping>`は`true`となる。
+
+
+## バージョン
+### 言語
+- C++26
+
+
+## 参照
+- [P2642R6 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2642r6.pdf)
diff --git a/reference/mdspan/is-layout-right-padded-mapping-of.md b/reference/mdspan/is-layout-right-padded-mapping-of.md
@@ -0,0 +1,25 @@
+# is-layout-right-padded-mapping-of
+* mdspan[meta header]
+* variable[meta id-type]
+* cpp26[meta cpp]
+
+```cpp
+template<class Mapping>
+constexpr bool is-layout-right-padded-mapping-of = see below;  // exposition only
+```
+* see below[italic]
+
+
+## 概要
+`is-layout-right-padded-mapping-of`は、[`layout_right_padded<S>::mapping`](layout_right_padded/mapping.md)を判定する説明専用変数テンプレートである。
+
+`size_t`型の任意の値`S`として`Mapping`が[`layout_right_padded<S>::mapping`](layout_right_padded/mapping.md)の特殊化であるときに限り、`is-layout-right-padded-mapping-of<Mapping>`は`true`となる。
+
+
+## バージョン
+### 言語
+- C++26
+
+
+## 参照
+- [P2642R6 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2642r6.pdf)
diff --git a/reference/mdspan/layout_left/mapping/op_constructor.md b/reference/mdspan/layout_left/mapping/op_constructor.md
@@ -20,13 +20,18 @@ template<class OtherExtents>
 constexpr explicit(!is_convertible_v<OtherExtents, extents_type>)
   mapping(const layout_right::mapping<OtherExtents>& other) noexcept;  // (5)
 
+template<class LayoutLeftPaddedMapping>
+constexpr explicit(!is_convertible_v<typename LayoutLeftPaddedMapping::extents_type, extents_type>)
+  mapping(const LayoutLeftPaddedMapping& other) noexcept;  // (7) C++26
+
 template<class OtherExtents>
 constexpr explicit(extents_type::rank() > 0)
   mapping(const layout_stride::mapping<OtherExtents>& other) noexcept;  // (6)
 ```
 * is_convertible_v[link /reference/type_traits/is_convertible.md]
 * rank()[link ../../extents/rank.md]
 * layout_right::mapping[link ../../layout_right/mapping.md]
+* LayoutLeftPaddedMapping[link ../../layout_left_padded/mapping.md]
 * layout_stride::mapping[link ../../layout_stride/mapping.md]
 
 ## 概要
@@ -36,6 +41,7 @@ constexpr explicit(extents_type::rank() > 0)
 - (4) : 他`layout_left::mapping`からの変換コンストラクタ
 - (5) : [`layout_right::mapping`](../../layout_right/mapping.md)からの変換コンストラクタ
 - (6) : [`layout_stride::mapping`](../../layout_stride/mapping.md)からの変換コンストラクタ
+- (7) : [`layout_left_padded<S>::mapping`](../../layout_left_padded/mapping.md)からの変換コンストラクタ
 
 
 ## テンプレートパラメータ制約
@@ -44,6 +50,17 @@ constexpr explicit(extents_type::rank() > 0)
     - `extents_type::`[`rank()`](../../extents/rank.md) `<= 1`、かつ
     - [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<extents_type, OtherExtents>`が`true`であること。
 - (6) : [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<extents_type, OtherExtents>`が`true`であること。
+- (7) :
+    - [`is-layout-left-padded-mapping-of`](../../is-layout-left-padded-mapping-of.md)`<LayoutLeftPaddedMapping>`が`true`、かつ
+    - [`is_constructible_v`](/reference/type_traits/is_constructible.md)`<extents_type, typename LayoutLeftPaddedMapping::extents_type>`が`true`であること。
+
+
+## 適格要件
+- (7) : 以下を満たすとき、`extents_type::`[`static_extent`](../../extents/static_extent.md)`(0)`が`LayoutLeftPaddedMapping::padding_stride`の倍数であること。
+    - `extents_type::`[`rank()`](../../extents/rank.md) `> 1`、かつ
+    - `extents_type::`[`static_extent`](../../extents/static_extent.md)`(0)`が[`dynamic_extent`](/reference/span/dynamic_extent.md)と等しくなく、かつ
+    - `LayoutLeftPaddedMapping::extents_type::`[`static_extent`](../../extents/static_extent.md)`(0)`が[`dynamic_extent`](/reference/span/dynamic_extent.md)と等しくなく、かつ
+    - `LayoutLeftPaddedMapping::padding_stride`が[`dynamic_extent`](/reference/span/dynamic_extent.md)と等しくないこと。
 
 
 ## 事前条件
@@ -53,11 +70,14 @@ constexpr explicit(extents_type::rank() > 0)
 - (6) :
     - `extents_type::`[`rank()`](../../extents/rank.md) `> 0`のとき、`other`における全次元のストライド幅が[`layout_left::mapping`相当の制約](stride.md)をもつこと。
     - `other.`[`required_span_size()`](../../layout_stride/mapping/required_span_size.md)を、`index_type`型で表現できること。
+- (7) :
+    - `extents_type::`[`rank()`](../../extents/rank.md) `> 1`のとき、`other.stride(1) == other.extents(0)`
+    - `other.`[`required_span_size()`](../../layout_left_padded/mapping/required_span_size.md.nolink)を、`index_type`型で表現できること。
 
 
 ## 効果
 - (3) : `e`を用いて`extents_`を直接非リスト初期化する。
-- (4), (5), (6) : `other.extents()`を用いて`extents_`を直接非リスト初期化する。
+- (4), (5), (6), (7) : `other.extents()`を用いて`extents_`を直接非リスト初期化する。
 
 
 ## 例外
@@ -67,6 +87,7 @@ constexpr explicit(extents_type::rank() > 0)
 ## explicitになる条件
 - (4), (5) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<OtherExtents, extents_type>`
 - (6) : [`extents_type::rank()`](../../extents/rank.md) `> 0`
+- (7) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<typename LayoutLeftPaddedMapping::extents_type, extents_type>`
 
 
 ## 例
@@ -143,7 +164,9 @@ int main()
 ## 関連項目
 - [`layout_right::mapping`](../../layout_right/mapping.md)
 - [`layout_stride::mapping`](../../layout_stride/mapping.md)
+- [`layout_left_padded::mapping`](../../layout_left_padded/mapping.md)
 
 
 ## 参照
 - [P0009R18 MDSPAN](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p0009r18.html)
+- [P2642R6 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2642r6.pdf)
diff --git a/reference/mdspan/layout_left_padded.md b/reference/mdspan/layout_left_padded.md
@@ -15,7 +15,7 @@ namespace std {
 ```
 * dynamic_extent[link /reference/span/dynamic_extent.md]
 * Extents[link extents.md]
-* mapping[link layout_left_padded/mapping.md.nolink]
+* mapping[link layout_left_padded/mapping.md]
 
 ## 概要
 `layout_left_padded`は、多次元配列ビュー[`mdspan`](mdspan.md)に対して、パディングあり列優先(column major)[レイアウトマッピング](LayoutMapping.md)を表現するポリシークラスである。
@@ -29,7 +29,7 @@ namespace std {
 
 | 名前 | 説明 | 対応バージョン |
 |------|------|----------------|
-| [`mapping`](layout_left_padded/mapping.md.nolink) | レイアウトマッピング | C++26 |
+| [`mapping`](layout_left_padded/mapping.md) | レイアウトマッピング | C++26 |
 
 
 ## 例
@@ -83,4 +83,4 @@ int main()
 
 
 ## 参照
-- [P2642R5 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p2642r5.html)
+- [P2642R6 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2642r6.pdf)
diff --git a/reference/mdspan/layout_left_padded/mapping.md b/reference/mdspan/layout_left_padded/mapping.md
@@ -0,0 +1,127 @@
+# mapping
+* mdspan[meta header]
+* class template[meta id-type]
+* std[meta namespace]
+* layout_left_padded[meta class]
+* cpp26[meta cpp]
+
+```cpp
+namespace std {
+  template<size_t PaddingValue>
+  template<class Extents>
+  class layout_left_padded<PaddingValue>::mapping;
+}
+```
+* layout_left_padded[link ../layout_left_padded.md]
+* Extents[link ../extents.md]
+
+## 概要
+`layout_left_padded<S>::mapping<E>`は、[`extents`](../extents.md)型の多次元配列サイズ`E`をパラメータとして、パディングあり列優先(column major)[レイアウトマッピング](../LayoutMapping.md)を表現するクラスである。
+
+`layout_left_padded<S>::mapping<E>`は[トリビアルコピー可能](/reference/type_traits/is_trivially_copyable.md)であり、[`regular`](/reference/concepts/regular.md)のモデルである。
+
+### 説明専用メンバ変数
+`layout_left_padded<S>::mapping`クラステンプレートは、下記の説明専用メンバ変数を保持する。
+
+- `stride-1` : `index_type`型の値`static-padding-stride`
+- `extents_` : `extents_type`型の[多次元配列サイズ情報](../extents.md)
+
+また下記の説明専用静的メンバ変数を保持する。
+
+- `rank_` : `size_t`型の定数`extents_type::`[`rank()`](../extents/rank.md)
+- `first-static-extent` : `size_t`型の定数`extents_type::`[`static_extent`](../extents/static_extent.md)`(0)`
+- `static-padding-stride` : `size_t`型の下記定数
+    - `rank_`が`0`または`1`のとき、値`0`
+    - `padding_value`または`first-static-extent`が[`dynamic_extent`](/reference/span/dynamic_extent.md)と等しいとき、`dynamic_extent`
+    - そうでなければ、`LEAST-MULTIPLE-AT-LEAST(padding_value, first-static-extent)`
+
+
+## 適格要件
+- `Extents`は[`extents`](../extents.md)の特殊化であること。
+- `rank_dynamic() == 0`が`true`のとき、多次元インデクス空間`Extents()`のサイズが`index_type`型で表現できること。
+- 値`padding_value`が`index_type`型で表現できること。
+- 以下を満たすとき、`LEAST-MULTIPLE-AT-LEAST(padding_value, first-static-extent)`が、`size_t`型および`index_type`型で表現できること。
+    - `rank_ > 1`、かつ
+    - `padding_value`が[`dynamic_extent`](/reference/span/dynamic_extent.md)と等しくなく、かつ
+    - `first-static-extent`が`dynamic_extent`と等しくないとき。
+- 以下を満たすとき、半開区間`[1, rank_)`の全ての値`k`に対して`LEAST-MULTIPLE-AT-LEAST(padding_value, ext.static_extent(0))`と全ての`ext.static_extent(k)`値を乗じた結果が、`size_t`型および`index_type`型で表現できること。
+    - `rank_ > 1`、かつ
+    - `padding_value`が[`dynamic_extent`](/reference/span/dynamic_extent.md)と等しくなく、かつ
+    - 半開区間`[0, extents_type::`[`rank()`](../extents/rank.md)`)`の全ての値`k`に対して`extents_type::`[`static_extent`](../extents/static_extent.md)`(k)`が`dynamic_extent`と等しくないとき。
+
+
+## メンバ関数
+### 構築・破棄
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|----------------|
+| [`(constructor)`](mapping/op_constructor.md.nolink) | コンストラクタ | C++26 |
+| `(destructor)` | デストラクタ | C++26 |
+| `operator=`    | コピー代入演算子 | C++26 |
+
+### 観測
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|----------------|
+| `extents` | 多次元配列のサイズ`extents_`を取得する | C++26 |
+| [`strides`](mapping/strides.md.nolink) | ストライド幅配列を取得する | C++26 |
+| [`required_span_size`](mapping/required_span_size.md.nolink) | 要素アクセス範囲を取得する | C++26 |
+| [`operator()`](mapping/op_call.md.nolink) | 多次元配列インデクスから要素位置へ変換する | C++26 |
+| [`is_exhaustive`](mapping/is_exhaustive.md.nolink) | [Exhaustive特性](../LayoutMapping.md)を取得する | C++26 |
+| [`stride`](mapping/stride.md.nolink) | 指定次元のストライド幅を取得する | C++26 |
+
+
+## 静的メンバ関数
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|----------------|
+| `is_always_unique`  | `true`を返す | C++26 |
+| [`is_always_exhaustive`](mapping/is_always_exhaustive.md.nolink) | 型の[Exhaustive特性](../LayoutMapping.md)を取得する | C++26 |
+| `is_always_strided` | `true`を返す | C++26 |
+| `is_unique`  | `true`を返す | C++26 |
+| `is_strided` | `true`を返す | C++26 |
+
+
+## メンバ型
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|----------------|
+| `extents_type` | [`Extents`](../extents.md) | C++26 |
+| `index_type` | [`Extents::index_type`](../extents.md) | C++26 |
+| `size_type` | [`Extents::size_type`](../extents.md) | C++26 |
+| `rank_type` | [`Extents::rank_type`](../extents.md) | C++26 |
+| `layout_type` | [`layout_left_padded`](../layout_left_padded.md)`<PaddingValue>` | C++26 |
+
+
+## 非メンバ（*Hidden friends*）関数
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|----------------|
+| [`submdspan_mapping`](mapping/submdspan_mapping.md.nolink) | [`submdspan`](../submdspan.md)サポート | C++26 |
+
+### 比較演算子
+
+| 名前 | 説明 | 対応バージョン |
+|------|------|----------------|
+| [`operator==`](mapping/op_equal.md.nolink) | 等値比較 | C++26 |
+| [`operator!=`](mapping/op_equal.md.nolink) | 非等値比較 (`==`により使用可能) | C++26 |
+
+
+## バージョン
+### 言語
+- C++26
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+
+## 関連項目
+- [`mdspan`](../mdspan.md)
+- [`submdspan`](../submdspan.md)
+
+
+## 参照
+- [P2642R6 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2642r6.pdf)
diff --git a/reference/mdspan/layout_right_padded.md b/reference/mdspan/layout_right_padded.md
@@ -15,7 +15,7 @@ namespace std {
 ```
 * dynamic_extent[link /reference/span/dynamic_extent.md]
 * Extents[link extents.md]
-* mapping[link layout_right_padded/mapping.md.nolink]
+* mapping[link layout_right_padded/mapping.md]
 
 ## 概要
 `layout_right_padded`は、多次元配列ビュー[`mdspan`](mdspan.md)に対して、パディングあり行優先(row major)[レイアウトマッピング](LayoutMapping.md)を表現するポリシークラスである。
@@ -29,7 +29,7 @@ namespace std {
 
 | 名前 | 説明 | 対応バージョン |
 |------|------|----------------|
-| [`mapping`](layout_right_padded/mapping.md.nolink) | レイアウトマッピング | C++26 |
+| [`mapping`](layout_right_padded/mapping.md) | レイアウトマッピング | C++26 |
 
 
 ## 例
@@ -81,4 +81,4 @@ int main()
 
 
 ## 参照
-- [P2642R5 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p2642r5.html)
+- [P2642R6 Padded mdspan layouts](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2024/p2642r6.pdf)
diff --git a/reference/mdspan/layout_right_padded/mapping.md b/reference/mdspan/layout_right_padded/mapping.md
diff --git a/reference/mdspan/layout_stride/mapping/op_constructor.md b/reference/mdspan/layout_stride/mapping/op_constructor.md
