Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

blas/blas1: Fix a couple documentation typos. #1704

Merged
merged 2 commits into from
Mar 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -66,7 +66,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