From 6cfc547ce84d611311a593b57bb9512f51d86ef7 Mon Sep 17 00:00:00 2001 From: Evan Harvey <57234914+e10harvey@users.noreply.github.com> Date: Thu, 2 Mar 2023 12:50:43 -0700 Subject: [PATCH] Merge pull request #1704 from e10harvey/doc_typos blas/blas1: Fix a couple documentation typos. (cherry picked from commit 3a206435045f44cbb7ca22c47d7083c27e79a3ff) --- blas/src/KokkosBlas1_mult.hpp | 14 ++++++++++++++ blas/src/KokkosBlas1_nrm2w.hpp | 2 +- blas/src/KokkosBlas1_reciprocal.hpp | 4 ++-- 3 files changed, 17 insertions(+), 3 deletions(-) diff --git a/blas/src/KokkosBlas1_mult.hpp b/blas/src/KokkosBlas1_mult.hpp index 39ccbbeebd..e08409e9aa 100644 --- a/blas/src/KokkosBlas1_mult.hpp +++ b/blas/src/KokkosBlas1_mult.hpp @@ -23,6 +23,20 @@ namespace KokkosBlas { +/// \brief Element wise multiplication of two vectors: +/// Y[i] = gamma * Y[i] + alpha * A[i] * X[i] +/// +/// \tparam YMV Type of the first vector Y; a 1-D or 2-D Kokkos::View. +/// \tparam AV Type of the second vector A; a 1-D Kokkos::View. +/// \tparam XMV Type of the third vector X; a 1-D or 2-D Kokkos::View. +/// +/// \param gamma [in] The scalar to apply to Y. +/// \param Y [in/out] The Y vector. +/// \param alpha [in] The scalar to apply to A. +/// \param A [in] The vector to apply to X. +/// \param X [in] The X vector. +/// +/// \return Y = gamma * Y + alpha * A * X. template void mult(typename YMV::const_value_type& gamma, const YMV& Y, typename AV::const_value_type& alpha, const AV& A, const XMV& X) { diff --git a/blas/src/KokkosBlas1_nrm2w.hpp b/blas/src/KokkosBlas1_nrm2w.hpp index 5a7a07001c..403d8ba685 100644 --- a/blas/src/KokkosBlas1_nrm2w.hpp +++ b/blas/src/KokkosBlas1_nrm2w.hpp @@ -65,7 +65,7 @@ nrm2w(const XVector& x, const XVector& w) { /// \brief R(i,j) = nrm2w(X(i,j)) /// -/// Replace each entry in R with the nrm2wolute value (magnitude) of the +/// Replace each entry in R with the nrm2w, absolute value (magnitude), of the /// corresponding entry in X. /// /// \tparam RMV 1-D or 2-D Kokkos::View specialization. diff --git a/blas/src/KokkosBlas1_reciprocal.hpp b/blas/src/KokkosBlas1_reciprocal.hpp index 7e171cb6df..19624d11c9 100644 --- a/blas/src/KokkosBlas1_reciprocal.hpp +++ b/blas/src/KokkosBlas1_reciprocal.hpp @@ -25,8 +25,8 @@ namespace KokkosBlas { /// \brief R(i,j) = reciprocal(X(i,j)) /// -/// Replace each entry in R with the reciprocalolute value (magnitude) of the -/// corresponding entry in X. +/// Replace each entry in R with the absolute value (magnitude), of the +/// reciprocal of the corresponding entry in X. /// /// \tparam RMV 1-D or 2-D Kokkos::View specialization. /// \tparam XMV 1-D or 2-D Kokkos::View specialization. It must have