Skip to content

Commit

Permalink
Merge pull request #1704 from e10harvey/doc_typos
Browse files Browse the repository at this point in the history
blas/blas1: Fix a couple documentation typos.

(cherry picked from commit 3a20643)
  • Loading branch information
e10harvey authored and ndellingwood committed Apr 20, 2023
1 parent 1f266de commit 6cfc547
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
14 changes: 14 additions & 0 deletions blas/src/KokkosBlas1_mult.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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 <class YMV, class AV, class XMV>
void mult(typename YMV::const_value_type& gamma, const YMV& Y,
typename AV::const_value_type& alpha, const AV& A, const XMV& X) {
Expand Down
2 changes: 1 addition & 1 deletion blas/src/KokkosBlas1_nrm2w.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions blas/src/KokkosBlas1_reciprocal.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6cfc547

Please sign in to comment.