linlg: 入出力引数コンセプトの説明追加 (#1233)

Author: yohhoy

reference/linalg/add.md

@@ -1,12 +1,10 @@
 # add
-
 * [mathjax enable]
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<in-object InObj1,
@@ -26,7 +24,8 @@ namespace std::linalg {
            OutObj z);               // (2)
 }
 ```
-
+* in-object[link inout-object.md]
+* out-object[link inout-object.md]
 
 ## 概要
 同じサイズの行列またはベクトルの`x`と`y`、`z`に対して、$x + y$ を`z`に代入する:

reference/linalg/addable.md

@@ -1,13 +1,9 @@
 # addable
-
 * linalg[meta header]
 * function template[meta id-type]
-* std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
-namespace std::linalg {
 constexpr bool addable(
   const in-vector auto& in1,
   const in-vector auto& in2,
@@ -27,9 +23,9 @@ constexpr bool addable(
          out.extent(0) == in2.extent(0) &&
          out.extent(1) == in2.extent(1);
 } // (2)
-}
 ```
-
+* in-vector[link inout-vector.md]
+* in-matrix[link inout-matrix.md]
 
 ## 概要
 テンプレートパラメータに指定されたベクトルまたは行列の次元が同じかどうかを判定する、説明専用の関数である。

reference/linalg/apply_givens_rotation.md

@@ -1,27 +1,25 @@
 # apply_givens_rotation
-
 * [mathjax enable]
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<inout-vector InOutVec1,
-          inout-vector InOutVec2,
-          class Real>
+           inout-vector InOutVec2,
+           class Real>
   void apply_givens_rotation(
     InOutVec1 x,
     InOutVec2 y,
     Real c,
     Real s);          // (1)
 
   template<class ExecutionPolicy,
-          inout-vector InOutVec1,
-          inout-vector InOutVec2,
-          class Real>
+           inout-vector InOutVec1,
+           inout-vector InOutVec2,
+           class Real>
   void apply_givens_rotation(
     ExecutionPolicy&& exec,
     InOutVec1 x,
@@ -30,18 +28,18 @@ namespace std::linalg {
     Real s);          // (2)
 
   template<inout-vector InOutVec1,
-          inout-vector InOutVec2,
-          class Real>
+           inout-vector InOutVec2,
+           class Real>
   void apply_givens_rotation(
     InOutVec1 x,
     InOutVec2 y,
     Real c,
     complex<Real> s); // (3)
 
   template<class ExecutionPolicy,
-          inout-vector InOutVec1,
-          inout-vector InOutVec2,
-          class Real>
+           inout-vector InOutVec1,
+           inout-vector InOutVec2,
+           class Real>
   void apply_givens_rotation(
     ExecutionPolicy&& exec,
     InOutVec1 x,
@@ -51,7 +49,7 @@ namespace std::linalg {
 }
 ```
 * complex[link /reference/complex/complex.md]
-
+* inout-vector[link inout-vector.md]
 
 ## 概要
 `c`と`s`で指定された回転行列を2つの**行**ベクトル`x`と`y`に対して、次のように掛けて代入する。

reference/linalg/compatible-static-extents.md

@@ -1,15 +1,13 @@
 # compatible-static-extents
-
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<class MDS1, class MDS2>
-  requires(is-mdspan<MDS1> && is-mdspan<MDS2>) 
+    requires(is-mdspan<MDS1> && is-mdspan<MDS2>) 
   constexpr bool compatible-static-extents(size_t r1, size_t r2)
   {
     return MDS1::static_extent(r1) == dynamic_extent ||
@@ -18,8 +16,9 @@ namespace std::linalg {
   }
 }
 ```
-* is-mdspan[link /reference/linalg/is_mdspan.md]
-
+* is-mdspan[link is-mdspan.md]
+* static_extent[link /reference/mdspan/mdspan/static_extent.md]
+* dynamic_extent[link /reference/span/dynamic_extent.md]
 
 ## 概要
 左の`mdspan`の`r1`番目の静的要素数と右の`mdspan`の`r2`番目の静的要素数に互換性があるかどうかを返す、説明専用の関数である。

reference/linalg/copy.md

@@ -1,18 +1,16 @@
 # copy
-
 * [mathjax enable]
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<in-object InObj,
-          out-object OutObj>
+           out-object OutObj>
   void copy(InObj x,
-           OutObj y);                 // (1)
+            OutObj y);                 // (1)
 
   template<class ExecutionPolicy,
            in-object InObj,
@@ -22,7 +20,8 @@ namespace std::linalg {
             OutObj y);                // (2)
 }
 ```
-
+* in-object[link inout-object.md]
+* out-object[link inout-object.md]
 
 ## 概要
 同じサイズの行列またはベクトルの`x`と`y`に対して、`x`を`y`にコピーする。

reference/linalg/dot.md

@@ -1,12 +1,10 @@
 # dot
-
 * [mathjax enable]
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<in-vector InVec1,
@@ -38,6 +36,7 @@ namespace std::linalg {
            InVec2 v2); // (4)
 }
 ```
+* in-vector[link inout-vector.md]
 
 ## 概要
 2つのベクトル`v1`、`v2`の内積を計算する。

reference/linalg/dotc.md

@@ -1,43 +1,42 @@
 # dotc
-
 * [mathjax enable]
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<in-vector InVec1,
            in-vector InVec2,
            class Scalar>
   Scalar dotc(InVec1 v1,
-             InVec2 v2,
-             Scalar init); // (1)
+              InVec2 v2,
+              Scalar init); // (1)
 
   template<class ExecutionPolicy,
            in-vector InVec1,
            in-vector InVec2,
            class Scalar>
   Scalar dotc(ExecutionPolicy&& exec,
-             InVec1 v1,
-             InVec2 v2,
-             Scalar init); // (2)
+              InVec1 v1,
+              InVec2 v2,
+              Scalar init); // (2)
 
   template<in-vector InVec1,
            in-vector InVec2>
   auto dotc(InVec1 v1,
-           InVec2 v2); // (3)
+            InVec2 v2); // (3)
 
   template<class ExecutionPolicy,
            in-vector InVec1,
            in-vector InVec2>
   auto dotc(ExecutionPolicy&& exec,
-           InVec1 v1,
-           InVec2 v2); // (4)
+            InVec1 v1,
+            InVec2 v2); // (4)
 }
 ```
+* in-vector[link inout-vector.md]
 
 ## 概要
 2つのベクトル`v1`、`v2`のエルミート内積を計算する。

reference/linalg/hermitian_matrix_product.md

@@ -1,13 +1,10 @@
 # hermitian_matrix_product
-
-
 * [mathjax enable]
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<in-matrix InMat1,
@@ -107,7 +104,8 @@ namespace std::linalg {
     OutMat C); // (8)
 }
 ```
-
+* in-matrix[link inout-matrix.md]
+* out-matrix[link inout-matrix.md]
 
 ## 概要
 エルミート行列と行列の積を計算する。

reference/linalg/hermitian_matrix_rank_1_update.md

@@ -51,7 +51,8 @@ namespace std::linalg {
     Triangle t); // (4)
 }
 ```
-
+* in-vector[link inout-vector.md]
+* possibly-packed-inout-matrix[link possibly-packed-inout-matrix.md]
 
 ## 概要
 エルミートな(対称かつ共役を取る)rank-1 updateをエルミート行列に行う。

reference/linalg/hermitian_matrix_rank_2_update.md

@@ -1,13 +1,10 @@
 # hermitian_matrix_rank_2_update
-
-
 * [mathjax enable]
 * linalg[meta header]
 * function template[meta id-type]
 * std::linalg[meta namespace]
 * cpp26[meta cpp]
 
-
 ```cpp
 namespace std::linalg {
   template<in-vector InVec1,
@@ -33,7 +30,8 @@ namespace std::linalg {
     Triangle t); // (2)
 }
 ```
-
+* in-vector[link inout-vector.md]
+* possibly-packed-inout-matrix[link possibly-packed-inout-matrix.md]
 
 ## 概要
 エルミートな(対称かつ共役を取る)rank-2 updateをエルミート行列に行う。