Implement the triangular solver

core/CMakeLists.txt

@@ -28,6 +28,7 @@ target_sources(ginkgo
         solver/fcg.cpp
         solver/gmres.cpp
         solver/ir.cpp
+        solver/lower_trs.cpp
         stop/combined.cpp
         stop/criterion.cpp
         stop/iteration.cpp

core/device_hooks/common_kernels.inc.cpp

@@ -47,6 +47,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include "core/solver/fcg_kernels.hpp"
 #include "core/solver/gmres_kernels.hpp"
 #include "core/solver/ir_kernels.hpp"
+#include "core/solver/lower_trs_kernels.hpp"
 #include "core/stop/criterion_kernels.hpp"
 #include "core/stop/residual_norm_reduction_kernels.hpp"
 
@@ -181,6 +182,25 @@ GKO_INSTANTIATE_FOR_EACH_VALUE_TYPE(GKO_DECLARE_CG_STEP_2_KERNEL);
 }  // namespace cg
 
 
+namespace lower_trs {
+
+
+template <typename ValueType, typename IndexType>
+GKO_DECLARE_LOWER_TRS_GENERATE_KERNEL(ValueType, IndexType)
+GKO_NOT_COMPILED(GKO_HOOK_MODULE);
+GKO_INSTANTIATE_FOR_EACH_VALUE_AND_INDEX_TYPE(
+    GKO_DECLARE_LOWER_TRS_GENERATE_KERNEL);
+
+template <typename ValueType, typename IndexType>
+GKO_DECLARE_LOWER_TRS_SOLVE_KERNEL(ValueType, IndexType)
+GKO_NOT_COMPILED(GKO_HOOK_MODULE);
+GKO_INSTANTIATE_FOR_EACH_VALUE_AND_INDEX_TYPE(
+    GKO_DECLARE_LOWER_TRS_SOLVE_KERNEL);
+
+
+}  // namespace lower_trs
+
+
 namespace fcg {
 
 

core/solver/lower_trs.cpp

@@ -0,0 +1,105 @@
+/*******************************<GINKGO LICENSE>******************************
+Copyright (c) 2017-2019, the Ginkgo authors
+All rights reserved.
+
+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 copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT
+HOLDER OR 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.
+******************************<GINKGO LICENSE>*******************************/
+
+#include <ginkgo/core/solver/lower_trs.hpp>
+
+
+#include <ginkgo/core/base/array.hpp>
+#include <ginkgo/core/base/exception_helpers.hpp>
+#include <ginkgo/core/base/executor.hpp>
+#include <ginkgo/core/base/polymorphic_object.hpp>
+#include <ginkgo/core/base/types.hpp>
+#include <ginkgo/core/base/utils.hpp>
+#include <ginkgo/core/matrix/csr.hpp>
+#include <ginkgo/core/matrix/dense.hpp>
+
+
+#include "core/solver/lower_trs_kernels.hpp"
+
+
+namespace gko {
+namespace solver {
+
+
+namespace lower_trs {
+
+
+GKO_REGISTER_OPERATION(generate, lower_trs::generate);
+GKO_REGISTER_OPERATION(solve, lower_trs::solve);
+
+
+}  // namespace lower_trs
+
+
+template <typename ValueType, typename IndexType>
+void LowerTrs<ValueType, IndexType>::generate()
+{
+    this->get_executor()->run(
+        lower_trs::make_generate(gko::lend(system_matrix_), gko::lend(b_)));
+}
+
+
+template <typename ValueType, typename IndexType>
+void LowerTrs<ValueType, IndexType>::apply_impl(const LinOp *b, LinOp *x) const
+{
+    using Vector = matrix::Dense<ValueType>;
+    const auto exec = this->get_executor();
+
+    auto dense_b = as<const Vector>(b);
+    auto dense_x = as<Vector>(x);
+
+    exec->run(
+        lower_trs::make_solve(gko::lend(system_matrix_), dense_b, dense_x));
+}
+
+
+template <typename ValueType, typename IndexType>
+void LowerTrs<ValueType, IndexType>::apply_impl(const LinOp *alpha,
+                                                const LinOp *b,
+                                                const LinOp *beta,
+                                                LinOp *x) const
+{
+    auto dense_x = as<matrix::Dense<ValueType>>(x);
+
+    auto x_clone = dense_x->clone();
+    this->apply(b, x_clone.get());
+    dense_x->scale(beta);
+    dense_x->add_scaled(alpha, gko::lend(x_clone));
+}
+
+
+#define GKO_DECLARE_LOWER_TRS(_vtype, _itype) class LowerTrs<_vtype, _itype>
+GKO_INSTANTIATE_FOR_EACH_VALUE_AND_INDEX_TYPE(GKO_DECLARE_LOWER_TRS);
+
+
+}  // namespace solver
+}  // namespace gko

core/solver/lower_trs_kernels.hpp

@@ -0,0 +1,106 @@
+/*******************************<GINKGO LICENSE>******************************
+Copyright (c) 2017-2019, the Ginkgo authors
+All rights reserved.
+
+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 copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT
+HOLDER OR 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.
+******************************<GINKGO LICENSE>*******************************/
+
+#ifndef GKO_CORE_SOLVER_LOWER_TRS_KERNELS_HPP_
+#define GKO_CORE_SOLVER_LOWER_TRS_KERNELS_HPP_
+
+
+#include <memory>
+
+
+#include <ginkgo/core/base/executor.hpp>
+#include <ginkgo/core/matrix/csr.hpp>
+#include <ginkgo/core/matrix/dense.hpp>
+
+
+namespace gko {
+namespace kernels {
+namespace lower_trs {
+
+
+#define GKO_DECLARE_LOWER_TRS_GENERATE_KERNEL(_vtype, _itype)  \
+    void generate(std::shared_ptr<const DefaultExecutor> exec, \
+                  const matrix::Csr<_vtype, _itype> *matrix,   \
+                  const matrix::Dense<_vtype> *b)
+
+
+#define GKO_DECLARE_LOWER_TRS_SOLVE_KERNEL(_vtype, _itype)  \
+    void solve(std::shared_ptr<const DefaultExecutor> exec, \
+               const matrix::Csr<_vtype, _itype> *matrix,   \
+               const matrix::Dense<_vtype> *b, matrix::Dense<_vtype> *x)
+
+
+#define GKO_DECLARE_ALL_AS_TEMPLATES                          \
+    template <typename ValueType, typename IndexType>         \
+    GKO_DECLARE_LOWER_TRS_SOLVE_KERNEL(ValueType, IndexType); \
+    template <typename ValueType, typename IndexType>         \
+    GKO_DECLARE_LOWER_TRS_GENERATE_KERNEL(ValueType, IndexType)
+
+
+}  // namespace lower_trs
+
+
+namespace omp {
+namespace lower_trs {
+
+GKO_DECLARE_ALL_AS_TEMPLATES;
+
+}  // namespace lower_trs
+}  // namespace omp
+
+
+namespace cuda {
+namespace lower_trs {
+
+GKO_DECLARE_ALL_AS_TEMPLATES;
+
+}  // namespace lower_trs
+}  // namespace cuda
+
+
+namespace reference {
+namespace lower_trs {
+
+GKO_DECLARE_ALL_AS_TEMPLATES;
+
+}  // namespace lower_trs
+}  // namespace reference
+
+
+#undef GKO_DECLARE_ALL_AS_TEMPLATES
+
+
+}  // namespace kernels
+}  // namespace gko
+
+
+#endif  // GKO_CORE_SOLVER_LOWER_TRS_KERNELS_HPP

core/test/base/exception_helpers.cpp

@@ -100,6 +100,23 @@ TEST(AssertIsSquareMatrix, ThrowsWhenIsNotSquareMatrix)
 }
 
 
+TEST(AssertIsNonEmptymatrix, DoesNotThrowWhenIsNonEmptyMatrix)
+{
+    ASSERT_NO_THROW(GKO_ASSERT_IS_NON_EMPTY_MATRIX(gko::dim<2>(1, 1)));
+}
+
+
+TEST(AssertIsNonEmptyMatrix, ThrowsWhenIsEmptyMatrix)
+{
+    ASSERT_THROW(GKO_ASSERT_IS_NON_EMPTY_MATRIX(gko::dim<2>(0, 0)),
+                 gko::BadDimension);
+    ASSERT_THROW(GKO_ASSERT_IS_NON_EMPTY_MATRIX(gko::dim<2>(1, 0)),
+                 gko::BadDimension);
+    ASSERT_THROW(GKO_ASSERT_IS_NON_EMPTY_MATRIX(gko::dim<2>(0, 1)),
+                 gko::BadDimension);
+}
+
+
 TEST(AssertConformant, DoesNotThrowWhenConformant)
 {
     ASSERT_NO_THROW(

core/test/solver/CMakeLists.txt

@@ -4,3 +4,4 @@ ginkgo_create_test(cgs)
 ginkgo_create_test(fcg)
 ginkgo_create_test(gmres)
 ginkgo_create_test(ir)
+ginkgo_create_test(lower_trs)

core/test/solver/lower_trs.cpp

@@ -0,0 +1,81 @@
+/*******************************<GINKGO LICENSE>******************************
+Copyright (c) 2017-2019, the Ginkgo authors
+All rights reserved.
+
+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 copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT
+HOLDER OR 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.
+******************************<GINKGO LICENSE>*******************************/
+
+#include <ginkgo/core/solver/lower_trs.hpp>
+
+
+#include <memory>
+
+
+#include <gtest/gtest.h>
+
+
+#include <ginkgo/core/base/executor.hpp>
+#include <ginkgo/core/solver/cg.hpp>
+
+
+namespace {
+
+
+class LowerTrs : public ::testing::Test {
+protected:
+    using Solver = gko::solver::LowerTrs<>;
+    using CgSolver = gko::solver::Cg<>;
+
+    LowerTrs()
+        : exec(gko::ReferenceExecutor::create()),
+          prec_fac(CgSolver::build().on(exec)),
+          lower_trs_factory(
+              Solver::build().with_preconditioner(prec_fac).on(exec))
+    {}
+
+    std::shared_ptr<const gko::Executor> exec;
+    std::shared_ptr<CgSolver::Factory> prec_fac;
+    std::unique_ptr<Solver::Factory> lower_trs_factory;
+};
+
+
+TEST_F(LowerTrs, LowerTrsFactoryKnowsItsExecutor)
+{
+    ASSERT_EQ(lower_trs_factory->get_executor(), exec);
+}
+
+
+TEST_F(LowerTrs, LowerTrsFactoryKnowsItsPrecond)
+{
+    ASSERT_EQ(static_cast<const CgSolver::Factory *>(
+                  lower_trs_factory->get_parameters().preconditioner.get()),
+              prec_fac.get());
+}
+
+
+}  // namespace