review updates

- Add comments for stride = 0 default value - Require square size for batch identity matrix Co-authored-by: Marcel Koch <[email protected]>
ginkgo-project · Feb 19, 2024 · 68e0022 · 68e0022
1 parent 7ecfbce
commit 68e0022
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/include/ginkgo/core/matrix/dense.hpp b/include/ginkgo/core/matrix/dense.hpp
@@ -1135,7 +1135,8 @@ class Dense
      * @param size  size of the matrix
      * @param stride  stride of the rows (i.e. offset between the first
      *                  elements of two consecutive rows, expressed as the
-     *                  number of matrix elements)
+     *                  number of matrix elements).
+     *                  If it is set to 0, size[1] will be used instead.
      *
      * @return A smart pointer to the newly created matrix.
      */

diff --git a/include/ginkgo/core/matrix/ell.hpp b/include/ginkgo/core/matrix/ell.hpp
@@ -226,9 +226,9 @@ class Ell : public EnableLinOp<Ell<ValueType, IndexType>>,
      *
      * @param exec  Executor associated to the matrix
      * @param size  size of the matrix
-     * @param num_stored_elements_per_row   the number of stored elements per
-     *                                      row
-     * @param stride                stride of the rows
+     * @param num_stored_elements_per_row  the number of stored elements per row
+     * @param stride  stride of the columns. If it is set to 0, size[0] will be
+     *                used instead.
      *
      * @return A smart pointer to the newly created matrix.
      */