clarify doc

ginkgo-project · Jan 22, 2024 · d18de70 · d18de70
1 parent f882f02
commit d18de70
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/include/ginkgo/core/matrix/batch_csr.hpp b/include/ginkgo/core/matrix/batch_csr.hpp
@@ -281,6 +281,8 @@ class Csr final
      * @param beta  the scalar to multiply this matrix
      *
      * @note Performs the operation in-place for this batch matrix
+     * @note This operation fails in case this matrix does not have all its
+     *       diagonal entries.
      */
     void add_scaled_identity(ptr_param<const MultiVector<value_type>> alpha,
                              ptr_param<const MultiVector<value_type>> beta);

diff --git a/include/ginkgo/core/matrix/batch_ell.hpp b/include/ginkgo/core/matrix/batch_ell.hpp
@@ -299,7 +299,9 @@ class Ell final
      * @param alpha the scalar for identity
      * @param beta  the scalar to multiply this matrix
      *
-     * @note Performs the operation in-place for this batch matrix
+     * @note Performs the operation in-place for this batch matrix.
+     * @note This operation fails in case this matrix does not have all its
+     *       diagonal entries.
      */
     void add_scaled_identity(ptr_param<const MultiVector<value_type>> alpha,
                              ptr_param<const MultiVector<value_type>> beta);