Add examples to docs

TRIQS · Nov 19, 2024 · d091d8a · d091d8a
1 parent 18b6908
commit d091d8a
Show file tree

Hide file tree

Showing 13 changed files with 3,189 additions and 22 deletions.
diff --git a/c++/nda/lapack/getrf.hpp b/c++/nda/lapack/getrf.hpp
@@ -53,7 +53,7 @@ namespace nda::lapack {
    * @param a Input/output matrix. On entry, the m-by-n matrix to be factored. On exit, the factors \f$ \mathbf{L} \f$
    * and \f$ \mathbf{U} \f$ from the factorization \f$ \mathbf{A} = \mathbf{P L U} \f$; the unit diagonal elements of
    * \f$ \mathbf{L} \f$ are not stored.
-   * @param ipiv Output vector. The pivot indices from `getrf`, i.e. for `1 <= i <= N`, row i of the matrix was
+   * @param ipiv Output vector. The pivot indices from `getrf`, i.e. for `1 <= i <= n`, row i of the matrix was
    * interchanged with row `ipiv(i)`.
    * @return Integer return code from the LAPACK call.
    */

diff --git a/c++/nda/lapack/getrs.hpp b/c++/nda/lapack/getrs.hpp
@@ -50,12 +50,12 @@ namespace nda::lapack {
    *
    * @tparam A nda::MemoryMatrix type.
    * @tparam B nda::MemoryMatrix type.
-   * @tparam B nda::MemoryVector type.
+   * @tparam IPIV nda::MemoryVector type.
    * @param a Input matrix. The factors \f$ \mathbf{L} \f$ and \f$ \mathbf{U} \f$ from the factorization \f$ \mathbf{A}
    * = \mathbf{P L U} \f$ as computed by `getrf`.
    * @param b Input/output matrix. On entry, the right hand side matrix \f$ \mathbf{B} \f$. On exit, the solution matrix
    * \f$ \mathbf{X} \f$.
-   * @param ipiv Input vector. The pivot indices from `getrf`, i.e. for `1 <= i <= N`, row i of the matrix was
+   * @param ipiv Input vector. The pivot indices from `getrf`, i.e. for `1 <= i <= n`, row i of the matrix was
    * interchanged with row `ipiv(i)`.
    * @return Integer return code from the LAPACK call.
    */

diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml
@@ -17,6 +17,14 @@
       </tab>
     </tab>
     <tab type="usergroup" url="@ref examples" title="Examples">
+      <tab type="user" url="@ref ex1" title="Example 1: A quick overview"/>
+      <tab type="user" url="@ref ex2" title="Example 2: Constructing arrays"/>
+      <tab type="user" url="@ref ex3" title="Example 3: Initializing arrays"/>
+      <tab type="user" url="@ref ex4" title="Example 4: Views and slices"/>
+      <tab type="user" url="@ref ex5" title="Example 5: HDF5 support"/>
+      <tab type="user" url="@ref ex6" title="Example 6: MPI support"/>
+      <tab type="user" url="@ref ex7" title="Example 7: Making use of symmetries"/>
+      <tab type="user" url="@ref ex8" title="Example 8: Linear algebra support"/>
     </tab>
     <tab type="usergroup" url="@ref documentation" title="API Documentation">
       <tab type="usergroup" url="@ref arrays_views" title="Arrays and views">
@@ -131,15 +139,10 @@
       <tab type="usergroup" url="@ref layout" title="Memory layout">
         <tab type="usergroup" url="@ref layout_pols" title="Layout policies">
           <tab type="user" url="@ref nda::basic_layout" title="basic_layout"/>
-          <tab type="user" url="@ref nda::basic_layout_str" title="basic_layout_str"/>
           <tab type="user" url="@ref nda::C_layout" title="C_layout"/>
-          <tab type="user" url="@ref nda::C_layout_str" title="C_layout_str"/>
           <tab type="user" url="@ref nda::C_stride_layout" title="C_stride_layout"/>
-          <tab type="user" url="@ref nda::C_stride_layout_str" title="C_stride_layout_str"/>
           <tab type="user" url="@ref nda::F_layout" title="F_layout"/>
-          <tab type="user" url="@ref nda::F_layout_str" title="F_layout_str"/>
           <tab type="user" url="@ref nda::F_stride_layout" title="F_stride_layout"/>
-          <tab type="user" url="@ref nda::F_stride_layout_str" title="F_stride_layout_str"/>
         </tab>
         <tab type="usergroup" url="@ref layout_utils" title="Layout utilities">
           <tab type="user" url="@ref nda::_linear_index_t" title="_linear_index_t"/>
@@ -149,7 +152,6 @@
         </tab>
         <tab type="usergroup" url="@ref layout_idx" title="Mult-dimensional indexing">
           <tab type="user" url="@ref nda::idx_map" title="idx_map"/>
-          <tab type="user" url="@ref nda::rect_str" title="rect_str"/>
         </tab>
       </tab>
       <tab type="usergroup" url="@ref memory" title="Memory management">