linalg: layout_* 個別メンバ(#1233)

Author: yohhoy

reference/linalg.md

@@ -103,14 +103,14 @@ BLAS互換アルゴリズムは、演算対象データの次元数や計算オ
 
 | 名前 | 説明 | 対応バージョン |
 |------|------|----------------|
-| [`column_major_t`](column_major_t.md.nolink) | 列優先(colmun-major)順序を表現するためのタグ型 (class) | C++26 |
-| [`column_major`](column_major_t.md.nolink)   | 列優先(colmun-major)順序を表現するためのタグ値 (variable) | C++26 |
-| [`row_major_t`](row_major_t.md.nolink) | 行優先(row-major)順序を表現するためのタグ型 (class) | C++26 |
-| [`row_major`](row_major_t.md.nolink)   | 行優先(row-major)順序を表現するためのタグ値 (variable) | C++26 |
-| [`upper_triangle_t`](upper_triangle_t.md.nolink) | 上三角行列を表現するためのタグ型 (class) | C++26 |
-| [`upper_triangle`](upper_triangle_t.md.nolink)   | 上三角行列を表現するためのタグ値 (variable) | C++26 |
-| [`lower_triangle_t`](lower_triangle_t.md.nolink) | 下三角行列を表現するためのタグ型 (class) | C++26 |
-| [`lower_triangle`](lower_triangle_t.md.nolink)   | 下三角行列を表現するためのタグ値 (variable) | C++26 |
+| [`column_major_t`](linalg/column_major_t.md) | 列優先(column-major)順序を表現するためのタグ型 (class) | C++26 |
+| [`column_major`](linalg/column_major_t.md)   | 列優先(column-major)順序を表現するためのタグ値 (variable) | C++26 |
+| [`row_major_t`](linalg/row_major_t.md) | 行優先(row-major)順序を表現するためのタグ型 (class) | C++26 |
+| [`row_major`](linalg/row_major_t.md)   | 行優先(row-major)順序を表現するためのタグ値 (variable) | C++26 |
+| [`upper_triangle_t`](linalg/upper_triangle_t.md.nolink) | 上三角行列を表現するためのタグ型 (class) | C++26 |
+| [`upper_triangle`](linalg/upper_triangle_t.md.nolink)   | 上三角行列を表現するためのタグ値 (variable) | C++26 |
+| [`lower_triangle_t`](linalg/lower_triangle_t.md.nolink) | 下三角行列を表現するためのタグ型 (class) | C++26 |
+| [`lower_triangle`](linalg/lower_triangle_t.md.nolink)   | 下三角行列を表現するためのタグ値 (variable) | C++26 |
 | `implicit_unit_diagonal_t` | implicit unit diagonalを表現するためのタグ型 (class) | C++26 |
 | `implicit_unit_diagonal`   | implicit unit diagonalを表現するためのタグ値 (variable) | C++26 |
 | `explicit_diagonal_t` | explicit diagonalを表現するためのタグ型 (class) | C++26 |

reference/linalg/column_major_t.md

@@ -0,0 +1,38 @@
+# column_major_t
+* linalg[meta header]
+* class[meta id-type]
+* std::linalg[meta namespace]
+* cpp26[meta cpp]
+
+```cpp
+namespace std::linalg {
+  struct column_major_t { explicit column_major_t() = default; };
+
+  inline constexpr column_major_t column_major{};
+}
+```
+
+## 概要
+`column_major_t`は、[`layout_blas_packed`](layout_blas_packed.md)を指定した多次元配列ビュー[`mdspan`](/reference/mdspan/mdspan.md)において、要素の格納順が列優先(column-major)であることを指示するためのタグ型である。
+
+`column_major_t`型の定数`column_major`が提供される。
+
+
+## バージョン
+### 言語
+- C++26
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+
+## 関連項目
+- [`mdspan`](/reference/mdspan/mdspan.md)
+- [`layout_blas_packed`](layout_blas_packed.md)
+
+
+## 参照
+- [P1673R13 A free function linear algebra interface based on the BLAS](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p1673r13.html)

reference/linalg/layout_blas_packed.md

@@ -15,14 +15,14 @@ namespace std::linalg {
 `layout_blas_packed`は、多次元配列ビュー[`mdspan`](/reference/mdspan/mdspan.md)を用いた正方行列(square matrix)に対して、BLASにおけるパックレイアウトと互換性のある行列要素メモリ配置を表現する[レイアウトマッピングポリシー](/reference/mdspan/LayoutMappingPolicy.md)クラスである。
 
 - `Triangle` : 指定する行列要素の種別を、上三角[`upper_triangle_t`](upper_triangle_t.md.nolink)または下三角[`lower_triangle_t`](lower_triangle_t.md.nolink)から指定する。
-- `StorageOrder` : 行列要素の格納順を、列優先[`column_major_t`](column_major_t.md.nolink)または行優先[`row_major_t`](row_major_t.md.nolink)から指定する。
+- `StorageOrder` : 行列要素の格納順を、列優先[`column_major_t`](column_major_t.md)または行優先[`row_major_t`](row_major_t.md)から指定する。
 
-`layout_blas_packed`を用いて、BLASの Symmetric Packed (SP), Hermitian Packed (HP), Triangular Packed (TP) 行列レイアウトを表現できる。
+`layout_blas_packed`を用いて、BLASの Symmetric Packed (SP), Hermitian Packed (HP), Triangular Packed (TP) で利用される行列レイアウトを表現できる。
 
 
 ## 適格要件
 - `Triangle`は[`upper_triangle_t`](upper_triangle_t.md.nolink)または[`lower_triangle_t`](lower_triangle_t.md.nolink)のいずれか
-- `StorageOrder`は[`column_major_t`](column_major_t.md.nolink)または[`row_major_t`](row_major_t.md.nolink)のいずれか
+- `StorageOrder`は[`column_major_t`](column_major_t.md)または[`row_major_t`](row_major_t.md)のいずれか
 
 
 ## メンバ型
@@ -31,7 +31,7 @@ namespace std::linalg {
 |------|------|----------------|
 | `triangle_type` | `Triangle` | C++26 |
 | `storage_order_type` | `StorageOrder` | C++26 |
-| [`mapping`](layout_blas_packed/mapping.md) | レイアウトマッピング | C++26 |
+| [`mapping`](layout_blas_packed/mapping.md) | レイアウトマッピング (class template) | C++26 |
 
 
 ## 例
@@ -87,8 +87,8 @@ int main()
 ```
 * linalg::layout_blas_packed[color ff0000]
 * linalg::lower_triangle_t[link lower_triangle_t.md.nolink]
-* linalg::column_major_t[link column_major_t.md.nolink]
-* linalg::row_major_t[link row_major_t.md.nolink]
+* linalg::column_major_t[link column_major_t.md]
+* linalg::row_major_t[link row_major_t.md]
 * mat.extent[link /reference/mdspan/mdspan/extent.md]
 * std::print[link /reference/print/print.md]
 * std::println[link /reference/print/println.md]

reference/linalg/layout_blas_packed/mapping.md

@@ -44,7 +44,7 @@ namespace std::linalg {
 
 | 名前 | 説明 | 対応バージョン |
 |------|------|----------------|
-| [`(constructor)`](mapping/op_constructor.md.nolink) | コンストラクタ | C++26 |
+| [`(constructor)`](mapping/op_constructor.md) | コンストラクタ | C++26 |
 | `(destructor)` | デストラクタ | C++26 |
 | `operator=`    | コピー代入演算子 | C++26 |
 
@@ -53,8 +53,8 @@ namespace std::linalg {
 | 名前 | 説明 | 対応バージョン |
 |------|------|----------------|
 | `extents` | 多次元配列のサイズ`extents_`を取得する | C++26 |
-| [`required_span_size`](mapping/required_span_size.md.nolink) | 要素アクセス範囲を取得する | C++26 |
-| [`operator()`](mapping/op_call.md.nolink) | 多次元配列インデクスから要素位置へ変換する | C++26 |
+| [`required_span_size`](mapping/required_span_size.md) | 要素アクセス範囲を取得する | C++26 |
+| [`operator()`](mapping/op_call.md) | 多次元配列インデクスから要素位置へ変換する | C++26 |
 | `stride` | 行列サイズ1x1ならば`1` | C++26 |
 | `is_unique`     | 行列サイズ1x1ならば`true` | C++26 |
 | `is_exhaustive` | `true`を返す | C++26 |
@@ -67,7 +67,7 @@ namespace std::linalg {
 |------|------|----------------|
 | `is_always_unique` | 行または列の静的要素数が1ならば`true` | C++26 |
 | `is_always_exhaustive` | `true`を返す | C++26 |
-| `is_always_strided` | `is_always_unique();` | C++26 |
+| `is_always_strided` | `is_always_unique()` | C++26 |
 
 
 ## メンバ型
@@ -86,8 +86,8 @@ namespace std::linalg {
 
 | 名前 | 説明 | 対応バージョン |
 |------|------|----------------|
-| [`operator==`](mapping/op_equal.md.nolink) | 等値比較 | C++26 |
-| [`operator!=`](mapping/op_equal.md.nolink) | 非等値比較 (`==`により使用可能) | C++26 |
+| [`operator==`](mapping/op_equal.md) | 等値比較 | C++26 |
+| [`operator!=`](mapping/op_equal.md) | 非等値比較 (`==`により使用可能) | C++26 |
 
 
 ## 例
@@ -120,8 +120,6 @@ int main()
 ```
 * linalg::layout_blas_packed[color ff0000]
 * LayoutPacked::mapping[color ff0000]
-* linalg::upper_triangle_t[link upper_triangle_t.md.nolink]
-* linalg::row_major_t[link row_major_t.md.nolink]
 * mat.extent[link /reference/mdspan/mdspan/extent.md]
 * std::print[link /reference/print/print.md]
 * std::println[link /reference/print/println.md]
@@ -151,4 +149,3 @@ int main()
 
 ## 参照
 - [P1673R13 A free function linear algebra interface based on the BLAS](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p1673r13.html)
-- [P1674R2: Evolving a Standard C++ Linear Algebra Library from the BLAS](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p1674r2.html)

reference/linalg/layout_blas_packed/mapping/op_call.md

@@ -0,0 +1,81 @@
+# operator()
+* linalg[meta header]
+* function template[meta id-type]
+* std::linalg[meta namespace]
+* layout_blas_packed::mapping[meta class]
+* cpp26[meta cpp]
+
+```cpp
+template<class Index0, class Index1>
+constexpr index_type operator() (Index0 ind0, Index1 ind1) const noexcept;
+```
+
+## 概要
+2次元インデクス値`ind0, ind1`に対応する要素位置を求める。
+
+
+## テンプレートパラメータ制約
+- [`is_convertible_v`](/reference/type_traits/is_convertible.md)`<Index0, index_type> == true`
+- [`is_convertible_v`](/reference/type_traits/is_convertible.md)`<Index1, index_type> == true`
+- [`is_nothrow_convertible_v`](/reference/type_traits/is_nothrow_convertible.md)`<index_type, Index0> == true`
+- [`is_nothrow_convertible_v`](/reference/type_traits/is_nothrow_convertible.md)`<index_type, Index1> == true`
+
+
+## 事前条件
+`i`を[`extents_type::index-cast`](/reference/mdspan/extents/index-cast.md)`(ind0)`、`j`を[`extents_type::index-cast`](/reference/mdspan/extents/index-cast.md)`(ind1)`としたとき、2次元インデクス値`i, j`は多次元配列サイズ`extents_`における有効なインデクスであること。
+
+
+## 戻り値
+`N`を[`extetns_.extent`](/reference/mdspan/extents/extent.md)`(0)`としたとき
+- `i > j`ならば`(*this)(j, i)`、そうでなければ
+- 下記いずれの条件を満たすならば`i + j * (j + 1)/2`、そうでなければ
+    - [`is_same_v`](/reference/type_traits/is_same.md)`<StorageOrder, column_major_t> &&` [`is_same_v`](/reference/type_traits/is_same.md)`<Triangle, upper_triangle_t>`が`true`または
+    - [`is_same_v`](/reference/type_traits/is_same.md)`<StorageOrder, row_major_t> &&` [`is_same_v`](/reference/type_traits/is_same.md)`<Triangle, lower_triangle_t>`が`true`
+- `j + N * i - i * (i + 1)/2`
+
+
+## 例外
+投げない
+
+
+## 例
+```cpp example
+#include <cassert>
+#include <mdspan>
+#include <linalg>
+namespace linalg = std::linalg;
+
+int main()
+{
+  using Ext3x3 = std::extents<size_t, 3, 3>;
+  linalg::layout_blas_packed<linalg::lower_triangle_t, linalg::column_major_t>::mapping<Ext3x3> map;
+  // 0 1 2
+  // 1 3 4
+  // 2 4 5
+  assert(map(0, 0) == 0);
+  assert(map(0, 1) == 1);
+  assert(map(2, 1) == 4);
+}
+```
+* mapping[color ff0000]
+* linalg::layout_blas_packed[link ../../layout_blas_packed.md]
+
+
+### 出力
+```
+```
+
+
+## バージョン
+### 言語
+- C++26
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+
+## 参照
+- [P1673R13 A free function linear algebra interface based on the BLAS](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p1673r13.html)

reference/linalg/layout_blas_packed/mapping/op_constructor.md

@@ -0,0 +1,111 @@
+# コンストラクタ
+* linalg[meta header]
+* function[meta id-type]
+* std::linalg[meta namespace]
+* layout_blas_packed::mapping[meta class]
+* cpp26[meta cpp]
+
+```cpp
+constexpr mapping() noexcept = default; // (1)
+
+constexpr mapping(const mapping&) noexcept = default; // (2)
+
+constexpr mapping(const extents_type&) noexcept; // (3)
+
+template<class OtherExtents>
+constexpr explicit(!is_convertible_v<OtherExtents, extents_type>)
+  mapping(const mapping<OtherExtents>& other) noexcept; // (4)
+```
+
+## 概要
+- (1) : デフォルトコンストラクタ
+- (2) : コピーコンストラクタ
+- (3) : [`extents`](/reference/mdspan/extents.md)からの変換コンストラクタ
+- (4) : 他`mapping`からの変換コンストラクタ
+
+
+## テンプレートパラメータ制約
+- (4) : [`is_convertible_v`](/reference/type_traits/is_convertible.md)`<extents_type, OtherExtents>`
+
+
+## 事前条件
+- (3) :
+    - Nを`e.extent(0)`としたとき、N * (N + 1)を`index_type`型で表現できること。
+    - `e.extent(0) == e.extent(1)`
+- (4) :
+    - Nを`other.extents().extent(0)`としたとき、N * (N + 1)を`index_type`型で表現できること。
+
+
+## 効果
+- (3) : `e`を用いて`extents_`を直接非リスト初期化する。
+- (4) : `other.extetns()`を用いて`extents_`を直接非リスト初期化する。
+
+
+## 例外
+投げない
+
+
+## explicitになる条件
+- (4) : `!`[`is_convertible_v`](/reference/type_traits/is_convertible.md)`<OtherExtents, extents_type>`
+
+
+## 例
+```cpp example
+#include <cassert>
+#include <mdspan>
+#include <linalg>
+namespace linalg = std::linalg;
+
+using LayoutPacked = linalg::layout_blas_packed<linalg::lower_triangle_t, linalg::column_major_t>
+using Ext3x3 = std::extents<size_t, 3, 3>;
+using ExtNxN = std::dextents<size_t, 2>;
+
+int main()
+{
+  // (1) : デフォルトコンストラクタ
+  {
+    LayoutPacked::mapping<Ext3x3> map1;
+    assert(map1.required_span_size() == 6);
+  }
+  // (2) : コピーコンストラクタ
+  {
+    LayoutPacked::mapping<Ext3x3> map2_a;
+    LayoutPacked::mapping<Ext3x3> map2_b = map2_a;
+    assert(map2_a == map2_b);
+  }
+  // (3) : extentsからの変換コンストラクタ
+  {
+    ExtNxN ext{3, 3};
+    LayoutPacked::mapping<ExtNxN> map3 = ext;
+    assert(map3.extents() == ext);
+  }
+  // (4) : 他mappingからの変換コンストラクタ
+  {
+    LayoutPacked::mapping<Ext3x3> map4_a;
+    LayoutPacked::mapping<ExtNxN> map4_b = map4_a;
+    assert(map4_a == map4_b);
+  }
+}
+```
+* mapping[color ff0000]
+* linalg::layout_blas_packed[link ../../layout_blas_packed.md]
+
+
+### 出力
+```
+```
+
+
+## バージョン
+### 言語
+- C++26
+
+### 処理系
+- [Clang](/implementation.md#clang): ??
+- [GCC](/implementation.md#gcc): ??
+- [ICC](/implementation.md#icc): ??
+- [Visual C++](/implementation.md#visual_cpp): ??
+
+
+## 参照
+- [P1673R13 A free function linear algebra interface based on the BLAS](https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2023/p1673r13.html)