From b613bc05d38b5d3f6a27df81826125dee58fd641 Mon Sep 17 00:00:00 2001 From: Tobias Ribizel Date: Sat, 5 Nov 2022 12:25:51 +0100 Subject: [PATCH] fix num_rhs documentation --- include/ginkgo/core/solver/triangular.hpp | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/include/ginkgo/core/solver/triangular.hpp b/include/ginkgo/core/solver/triangular.hpp index 874331bf93f..6a4ba8d3d89 100644 --- a/include/ginkgo/core/solver/triangular.hpp +++ b/include/ginkgo/core/solver/triangular.hpp @@ -111,11 +111,8 @@ class LowerTrs : public EnableLinOp>, /** * Number of right hand sides. * - * @note This value is currently a dummy value which is not used by the - * analysis step. It is possible that future algorithms (cusparse - * csrsm2) make use of the number of right hand sides for a more - * sophisticated implementation. Hence this parameter is left - * here. But currently, there is no need to use it. + * @note This value is currently only required for the CUDA + * trisolve_algorithm::sparselib algorithm. */ gko::size_type GKO_FACTORY_PARAMETER_SCALAR(num_rhs, 1u); @@ -264,11 +261,8 @@ class UpperTrs : public EnableLinOp>, /** * Number of right hand sides. * - * @note This value is currently a dummy value which is not used by the - * analysis step. It is possible that future algorithms (cusparse - * csrsm2) make use of the number of right hand sides for a more - * sophisticated implementation. Hence this parameter is left - * here. But currently, there is no need to use it. + * @note This value is currently only required for the CUDA + * trisolve_algorithm::sparselib algorithm. */ gko::size_type GKO_FACTORY_PARAMETER_SCALAR(num_rhs, 1u);