diff --git a/include/ginkgo/core/matrix/dense.hpp b/include/ginkgo/core/matrix/dense.hpp index 9c33a24ab70..0e6b92424fe 100644 --- a/include/ginkgo/core/matrix/dense.hpp +++ b/include/ginkgo/core/matrix/dense.hpp @@ -543,15 +543,43 @@ class Dense ptr_param beta, ptr_param row_collection) const; + /** + * Copies this matrix into the given rows of the target matrix. + * + * @param scatter_indices row indices of the target matrix. It must + * have the same number of indices as rows in + * this matrix. + * @param target matrix where the scattered rows are stored, i.e. + * `target(scatter_indices[i], j) = this(i, j)` + * + * @warning scatter_indices may not contain duplicates, unless if + * for indices `i, j` with `scatter_indices[i] == + * scatter_indices[j]` the rows `i, j` of this matrix are identical. + */ void row_scatter(const array* scatter_indices, ptr_param target) const; + /** + * @copydoc row_scatter(const array*, ptr_param) const + */ void row_scatter(const array* scatter_indices, ptr_param target) const; + /** + * Copies this matrix into the given rows of the target matrix. + * + * @param scatter_indices row indices of the target matrix. It must + * have the same number of indices as rows in + * this matrix. + * @param target matrix where the scattered rows are stored, i.e. + * `target(scatter_indices[i], j) = this(i, j)` + */ void row_scatter(const index_set* scatter_indices, ptr_param target) const; + /** + * @copydoc row_scatter(const index_set*, ptr_param) const + */ void row_scatter(const index_set* scatter_indices, ptr_param target) const;