BLAS and cuBLAS TPL interface for TRSM

src/blas/KokkosBlas3_trsm.hpp

@@ -0,0 +1,184 @@
+/*
+//@HEADER
+// ************************************************************************
+//
+//               KokkosKernels 0.9: Linear Algebra and Graph Kernels
+//                 Copyright 2017 Sandia Corporation
+//
+// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
+// the U.S. Government retains certain rights in this software.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// 1. Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright
+// notice, this list of conditions and the following disclaimer in the
+// documentation and/or other materials provided with the distribution.
+//
+// 3. Neither the name of the Corporation nor the names of the
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
+// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+// Questions? Contact Siva Rajamanickam (srajama@sandia.gov)
+//
+// ************************************************************************
+//@HEADER
+*/
+#ifndef KOKKOSBLAS3_TRSM_HPP_
+#define KOKKOSBLAS3_TRSM_HPP_
+
+/// \file KokkosBlas3_trsm.hpp
+
+#include <KokkosKernels_Macros.hpp>
+#include <KokkosBlas3_trsm_spec.hpp>
+#include <KokkosKernels_helpers.hpp>
+#include <sstream>
+#include <type_traits>
+
+namespace KokkosBlas {
+
+/// \brief Solve triangular linear system with multiple RHSs: 
+///        op(A)*X = alpha*B if side == "L" or "l"
+///        X*op(A) = alpha*B if side == "R" or "r"
+///
+/// \tparam AViewType Input matrix, as a 2-D Kokkos::View
+/// \tparam BViewType Input(RHS)/Output(solution) M-by-N matrix, as a 2-D Kokkos::View
+///
+/// \param side  [in] "L" or "l" indicates matrix A is on the left of X
+///                   "R" or "r" indicates matrix A is on the right of X
+/// \param uplo  [in] "U" or "u" indicates matrix A upper part is stored, the other part is not referenced
+///                   "L" or "l" indicates matrix A lower part is stored, the other part is not referenced
+/// \param trans [in] "N" or "n" for non-transpose, "T" or "t" for transpose, "C" or "c" for conjugate transpose.  
+/// \param diag  [in] "U" or "u" indicates the diagonal of A is assumed to be unit
+//                    "N" or "n" indicated the diagonal of A is assumed to be non-unit
+/// \param alpha [in] Input coefficient used for multiplication with B
+/// \param A [in]     Input matrix, as a 2-D Kokkos::View 
+///                   If side == "L" or "l", matrix A is a M-by-M triangular matrix;
+///                   otherwise, matrix A is a N-by-N triangular matrix 
+/// \param B [in,out] Input/Output matrix, as a 2-D Kokkos::View 
+///                   On entry, M-by-N matrix of multile RHS
+///                   On exit, overwritten with the solution X
+template<class AViewType,
+         class BViewType>
+void
+trsm (const char side[],
+      const char uplo[],
+      const char trans[],
+      const char diag[],
+      typename BViewType::const_value_type& alpha,
+      const AViewType& A,
+      const BViewType& B)
+{
+
+  static_assert (Kokkos::Impl::is_view<AViewType>::value,
+                 "AViewType must be a Kokkos::View.");
+  static_assert (Kokkos::Impl::is_view<BViewType>::value,
+                 "BViewType must be a Kokkos::View.");
+  static_assert (static_cast<int> (AViewType::rank) == 2,
+                 "AViewType must have rank 2.");
+  static_assert (static_cast<int> (BViewType::rank) == 1 || static_cast<int> (BViewType::rank) == 2,
+                 "BViewType must have either rank 1 or rank 2.");
+
+  // Check validity of indicator argument
+  bool valid_side  = (side[0] == 'L' ) || (side[0] == 'l' )||
+                     (side[0] == 'R' ) || (side[0] == 'r' );
+  bool valid_uplo  = (uplo[0] == 'U' ) || (uplo[0] == 'u' )||
+                     (uplo[0] == 'L' ) || (uplo[0] == 'l' );
+  bool valid_trans = (trans[0] == 'N') || (trans[0] == 'n')||
+                     (trans[0] == 'T') || (trans[0] == 't')||
+                     (trans[0] == 'C') || (trans[0] == 'c');
+  bool valid_diag  = (diag[0] == 'U' ) || (diag[0] == 'u' )||
+                     (diag[0] == 'N' ) || (diag[0] == 'n' );
+  if(!valid_side) {
+    std::ostringstream os;
+    os << "KokkosBlas::trsm: side = '" << side[0] << "'. " <<
+      "Valid values include 'L' or 'l' (A is on the left of X), "
+      "'R' or 'r' (A is on the right of X).";
+    Kokkos::Impl::throw_runtime_exception (os.str ());
+  }
+  if(!valid_uplo) {
+    std::ostringstream os;
+    os << "KokkosBlas::trsm: uplo = '" << uplo[0] << "'. " <<
+      "Valid values include 'U' or 'u' (A is upper triangular), "
+      "'L' or 'l' (A is lower triangular).";
+    Kokkos::Impl::throw_runtime_exception (os.str ());
+  }
+  if(!valid_trans) {
+    std::ostringstream os;
+    os << "KokkosBlas::trsm: trans = '" << trans[0] << "'. " <<
+      "Valid values include 'N' or 'n' (No transpose), 'T' or 't' (Transpose), "
+      "and 'C' or 'c' (Conjugate transpose).";
+    Kokkos::Impl::throw_runtime_exception (os.str ());
+  }
+  if(!valid_diag) {
+    std::ostringstream os;
+    os << "KokkosBlas::trsm: diag = '" << diag[0] << "'. " <<
+      "Valid values include 'U' or 'u' (the diagonal of A is assumed to be unit), "
+     "'N' or 'n' (the diagonal of A is assumed to be non-unit).";
+    Kokkos::Impl::throw_runtime_exception (os.str ());
+  }
+
+  // Check compatibility of dimensions at run time.
+  bool A_s =  (side[0] == 'L' || side[0] == 'l');
+
+  int64_t A0 = A.extent(0);
+  int64_t A1 = A.extent(1);
+  int64_t B0 = B.extent(0);
+  int64_t B1 = B.extent(1);
+
+  if ((A0 != A1) || ((A_s?B0:B1) != A1)) {
+    std::ostringstream os;
+    os << "KokkosBlas::trsm: Dimensions of A and B do not match: "
+       << "side: " << side[0]
+       << " A: " << A.extent(0) << " x " << A.extent(1)
+       << " B: " << B.extent(0) << " x " << B.extent(1);
+    Kokkos::Impl::throw_runtime_exception (os.str ());
+  }
+
+  // Return if degenerated matrices are provided
+  if((A.extent(0) == 0) || (A.extent(1) == 0) || (B.extent(0) == 0) || (B.extent(1) == 0))
+    return;
+
+  // Minimize the number of Impl::TRSM instantiations, by
+  // standardizing on particular View specializations for its template
+  // parameters.
+  using AVT = Kokkos::View<typename AViewType::const_value_type**,
+                           typename AViewType::array_layout,
+                           typename AViewType::device_type,
+                           Kokkos::MemoryTraits<Kokkos::Unmanaged> >;
+  using BVT = Kokkos::View<typename BViewType::non_const_value_type**,
+                           typename BViewType::array_layout,
+                           typename BViewType::device_type,
+                           Kokkos::MemoryTraits<Kokkos::Unmanaged> >;
+
+  AVT A_i = A;
+
+  if (BViewType::rank == 1) {
+    auto B_i = BVT(B.data(), B.extent(0), 1);
+    KokkosBlas::Impl::TRSM<AVT, BVT>::trsm (side, uplo, trans, diag, alpha, A_i, B_i);
+  }
+  else { //BViewType::rank == 2
+    auto B_i = BVT(B.data(), B.extent(0), B.extent(1));
+    KokkosBlas::Impl::TRSM<AVT, BVT>::trsm (side, uplo, trans, diag, alpha, A_i, B_i);
+  }
+}
+
+} // namespace KokkosBlas
+
+#endif // KOKKOS_BLAS3_TRSM_HPP_

src/blas/impl/KokkosBlas3_trsm_impl.hpp

@@ -0,0 +1,60 @@
+/*
+//@HEADER
+// ************************************************************************
+//
+//               KokkosKernels 0.9: Linear Algebra and Graph Kernels
+//                 Copyright 2017 Sandia Corporation
+//
+// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
+// the U.S. Government retains certain rights in this software.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// 1. Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright
+// notice, this list of conditions and the following disclaimer in the
+// documentation and/or other materials provided with the distribution.
+//
+// 3. Neither the name of the Corporation nor the names of the
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
+// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+// Questions? Contact Siva Rajamanickam (srajama@sandia.gov)
+//
+// ************************************************************************
+//@HEADER
+*/
+
+#ifndef KOKKOSBLAS3_TRSM_IMPL_HPP_
+#define KOKKOSBLAS3_TRSM_IMPL_HPP_
+
+/// \file KokkosBlas3_trsm_impl.hpp
+/// \brief Implementation(s) of triangular linear system solve (with multiple RHSs) .
+
+#include "KokkosKernels_config.h"
+#include "Kokkos_Core.hpp"
+#include "Kokkos_ArithTraits.hpp"
+
+
+namespace KokkosBlas {
+namespace Impl {
+  //TODO: Add the implementation of KokkosBlas::trsm later
+}
+}
+#endif // KOKKOSBLAS3_TRSM_IMPL_HPP_