[Code] Add mxv, vxm seq ops iml && add respective tests

EgorOrachyov · EgorOrachyov · commit 79194cb21c92 · 2021-04-30T19:08:38.000+03:00
diff --git a/cubool/CMakeLists.txt b/cubool/CMakeLists.txt
@@ -147,6 +147,8 @@ if (CUBOOL_WITH_SEQUENTIAL)
         sources/sequential/sq_ewiseadd.hpp
         sources/sequential/sq_spgemm.cpp
         sources/sequential/sq_spgemm.hpp
+        sources/sequential/sq_spgemv.cpp
+        sources/sequential/sq_spgemv.hpp
         sources/sequential/sq_reduce.cpp
         sources/sequential/sq_reduce.hpp
         sources/sequential/sq_submatrix.cpp
diff --git a/cubool/sources/core/vector.cpp b/cubool/sources/core/vector.cpp
@@ -198,7 +198,7 @@ namespace cubool {
         CHECK_RAISE_ERROR(m != nullptr, InvalidArgument, "Passed matrix does not belong to core matrix class");
 
         CHECK_RAISE_ERROR(v->getNrows() == m->getNrows(), InvalidArgument, "Provided vector and matrix have incompatible size for operation");
-        CHECK_RAISE_ERROR(this->getNrows() == v->getNrows(), InvalidArgument, "This vector has incompatible size for operation result");
+        CHECK_RAISE_ERROR(this->getNrows() == m->getNcols(), InvalidArgument, "This vector has incompatible size for operation result");
 
         v->commitCache();
         m->commitCache();
@@ -229,7 +229,7 @@ namespace cubool {
         CHECK_RAISE_ERROR(m != nullptr, InvalidArgument, "Passed matrix does not belong to core matrix class");
 
         CHECK_RAISE_ERROR(v->getNrows() == m->getNcols(), InvalidArgument, "Provided vector and matrix have incompatible size for operation");
-        CHECK_RAISE_ERROR(this->getNrows() == v->getNrows(), InvalidArgument, "This vector has incompatible size for operation result");
+        CHECK_RAISE_ERROR(this->getNrows() == m->getNrows(), InvalidArgument, "This vector has incompatible size for operation result");
 
         v->commitCache();
         m->commitCache();
diff --git a/cubool/sources/sequential/sq_backend.cpp b/cubool/sources/sequential/sq_backend.cpp
@@ -37,12 +37,19 @@ namespace cubool {
 
     void SqBackend::finalize() {
         assert(mMatCount == 0);
+        assert(mVecCount == 0);
 
         if (mMatCount > 0) {
             LogStream stream(*Library::getLogger());
             stream << Logger::Level::Error
                    << "Lost some (" << mMatCount << ") matrix objects" << LogStream::cmt;
         }
+
+        if (mVecCount > 0) {
+            LogStream stream(*Library::getLogger());
+            stream << Logger::Level::Error
+                   << "Lost some (" << mVecCount << ") vector objects" << LogStream::cmt;
+        }
     }
 
     bool SqBackend::isInitialized() const {
diff --git a/cubool/sources/sequential/sq_spgemv.cpp b/cubool/sources/sequential/sq_spgemv.cpp
@@ -0,0 +1,83 @@
+/**********************************************************************************/
+/* MIT License                                                                    */
+/*                                                                                */
+/* Copyright (c) 2020, 2021 JetBrains-Research                                    */
+/*                                                                                */
+/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
+/* of this software and associated documentation files (the "Software"), to deal  */
+/* in the Software without restriction, including without limitation the rights   */
+/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
+/* copies of the Software, and to permit persons to whom the Software is          */
+/* furnished to do so, subject to the following conditions:                       */
+/*                                                                                */
+/* The above copyright notice and this permission notice shall be included in all */
+/* copies or substantial portions of the Software.                                */
+/*                                                                                */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
+/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
+/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
+/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
+/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
+/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
+/* SOFTWARE.                                                                      */
+/**********************************************************************************/
+
+#include <sequential/sq_spgemm.hpp>
+
+namespace cubool {
+
+    void sq_spgemv(const CsrData& a, const VecData& b, VecData& out) {
+        std::vector<index> result;
+
+        for (index i = 0; i < a.nrows; i++) {
+            const index* ar = a.colIndices.data() + a.rowOffsets[i];
+            const index* vr = b.indices.data();
+
+            const index* arend = ar + (a.rowOffsets[i + 1] - a.rowOffsets[i]);
+            const index* vrend = vr + b.nvals;
+
+            bool nonZero = false;
+
+            while (ar != arend && vr != vrend) {
+                if (*ar == *vr) {
+                    nonZero = true;
+                    break;
+                }
+                else if (*ar < *vr) {
+                    ar++;
+                }
+                else {
+                    vr++;
+                }
+            }
+
+            if (nonZero) {
+                result.push_back(i);
+            }
+        }
+
+        out.nvals = result.size();
+        out.indices = std::move(result);
+    }
+
+    void sq_spgemv_transposed(const CsrData& a, const VecData& b, VecData& out) {
+        std::vector<bool> mask(a.ncols, false);
+
+        for (index i: b.indices) {
+            for (index k = a.rowOffsets[i]; k < a.rowOffsets[i + 1]; k++) {
+                mask[a.colIndices[k]] = true;
+            }
+        }
+
+        std::vector<index> result;
+
+        for (index i = 0; i < mask.size(); i++) {
+            if (mask[i])
+                result.push_back(i);
+        }
+
+        out.nvals = result.size();
+        out.indices = std::move(result);
+    }
+
+}
diff --git a/cubool/sources/sequential/sq_spgemv.hpp b/cubool/sources/sequential/sq_spgemv.hpp
@@ -0,0 +1,52 @@
+/**********************************************************************************/
+/* MIT License                                                                    */
+/*                                                                                */
+/* Copyright (c) 2020, 2021 JetBrains-Research                                    */
+/*                                                                                */
+/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
+/* of this software and associated documentation files (the "Software"), to deal  */
+/* in the Software without restriction, including without limitation the rights   */
+/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
+/* copies of the Software, and to permit persons to whom the Software is          */
+/* furnished to do so, subject to the following conditions:                       */
+/*                                                                                */
+/* The above copyright notice and this permission notice shall be included in all */
+/* copies or substantial portions of the Software.                                */
+/*                                                                                */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
+/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
+/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
+/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
+/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
+/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
+/* SOFTWARE.                                                                      */
+/**********************************************************************************/
+
+#ifndef CUBOOL_SQ_SPGEMV_HPP
+#define CUBOOL_SQ_SPGEMV_HPP
+
+#include <sequential/sq_data.hpp>
+
+namespace cubool {
+
+    /**
+     * Matrix-vector multiplication of `a` and `b`.
+     *
+     * @param a Input matrix
+     * @param b Input vector
+     * @param[out] out Where to store result
+     */
+    void sq_spgemv(const CsrData& a, const VecData& b, VecData& out);
+
+    /**
+     * Matrix(^T)-vector multiplication of `a` and `b`.
+     *
+     * @param a Input matrix
+     * @param b Input vector
+     * @param[out] out Where to store result
+     */
+    void sq_spgemv_transposed(const CsrData& a, const VecData& b, VecData& out);
+
+}
+
+#endif //CUBOOL_SQ_SPGEMV_HPP
diff --git a/cubool/sources/sequential/sq_vector.cpp b/cubool/sources/sequential/sq_vector.cpp
@@ -27,6 +27,7 @@
 #include <sequential/sq_reduce.hpp>
 #include <sequential/sq_ewiseadd.hpp>
 #include <sequential/sq_subvector.hpp>
+#include <sequential/sq_spgemv.hpp>
 #include <utils/data_utils.hpp>
 #include <core/error.hpp>
 #include <cassert>
@@ -77,7 +78,7 @@ namespace cubool {
 
         assert(other->getNrows() == this->getNrows());
 
-        this->mData = other->mData;
+        mData = other->mData;
     }
 
     void SqVector::reduce(index &result, bool checkTime) {
@@ -104,7 +105,7 @@ namespace cubool {
         else
             sq_reduce(other->mData, out);
 
-        this->mData = std::move(out);
+        mData = std::move(out);
     }
 
     void SqVector::eWiseAdd(const VectorBase &aBase, const VectorBase &bBase, bool checkTime) {
@@ -122,7 +123,7 @@ namespace cubool {
 
         sq_ewiseadd(a->mData, b->mData, out);
 
-        this->mData = std::move(out);
+        mData = std::move(out);
     }
 
     void SqVector::multiplyVxM(const VectorBase &vBase, const class MatrixBase &mBase, bool checkTime) {
@@ -132,7 +133,15 @@ namespace cubool {
         CHECK_RAISE_ERROR(v != nullptr, InvalidArgument, "Provided vector does not belongs to sequential vector class");
         CHECK_RAISE_ERROR(m != nullptr, InvalidArgument, "Provided matrix does not belongs to sequential matrix class");
 
-        // todo
+        assert(v->getNrows() == m->getNrows());
+        assert(this->getNrows() == m->getNcols());
+
+        VecData out;
+        out.nrows = this->getNrows();
+
+        sq_spgemv_transposed(m->mData, v->mData, out);
+
+        mData = std::move(out);
     }
 
     void SqVector::multiplyMxV(const class MatrixBase &mBase, const VectorBase &vBase, bool checkTime) {
@@ -142,7 +151,15 @@ namespace cubool {
         CHECK_RAISE_ERROR(v != nullptr, InvalidArgument, "Provided vector does not belongs to sequential vector class");
         CHECK_RAISE_ERROR(m != nullptr, InvalidArgument, "Provided matrix does not belongs to sequential matrix class");
 
-        // todo
+        assert(v->getNrows() == m->getNcols());
+        assert(this->getNrows() == m->getNrows());
+
+        VecData out;
+        out.nrows = this->getNrows();
+
+        sq_spgemv(m->mData, v->mData, out);
+
+        mData = std::move(out);
     }
 
     index SqVector::getNrows() const {
diff --git a/cubool/tests/CMakeLists.txt b/cubool/tests/CMakeLists.txt
@@ -35,4 +35,10 @@ add_executable(test_vector_element test_vector_element.cpp)
 target_link_libraries(test_vector_element PUBLIC testing)
 
 add_executable(test_vector_ewiseadd test_vector_ewiseadd.cpp)
-target_link_libraries(test_vector_ewiseadd PUBLIC testing)
+target_link_libraries(test_vector_ewiseadd PUBLIC testing)
+
+add_executable(test_vector_mxv test_vector_mxv.cpp)
+target_link_libraries(test_vector_mxv PUBLIC testing)
+
+add_executable(test_vector_vxm test_vector_vxm.cpp)
+target_link_libraries(test_vector_vxm PUBLIC testing)
diff --git a/cubool/tests/test_vector_mxv.cpp b/cubool/tests/test_vector_mxv.cpp
@@ -0,0 +1,102 @@
+/**********************************************************************************/
+/* MIT License                                                                    */
+/*                                                                                */
+/* Copyright (c) 2020, 2021 JetBrains-Research                                    */
+/*                                                                                */
+/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
+/* of this software and associated documentation files (the "Software"), to deal  */
+/* in the Software without restriction, including without limitation the rights   */
+/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
+/* copies of the Software, and to permit persons to whom the Software is          */
+/* furnished to do so, subject to the following conditions:                       */
+/*                                                                                */
+/* The above copyright notice and this permission notice shall be included in all */
+/* copies or substantial portions of the Software.                                */
+/*                                                                                */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
+/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
+/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
+/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
+/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
+/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
+/* SOFTWARE.                                                                      */
+/**********************************************************************************/
+
+#include <testing/testing.hpp>
+
+void testMatrixVectorMultiplyAdd(cuBool_Index m, cuBool_Index n, float density) {
+    cuBool_Matrix a;
+    cuBool_Vector v, r;
+
+    // Generate test data with specified density
+    testing::Matrix ta = std::move(testing::Matrix::generateSparse(m, n, density));
+    testing::Vector tv = std::move(testing::Vector::generateSparse(n, density));
+
+    // Allocate input matrices and resize to fill with input data
+    ASSERT_EQ(cuBool_Matrix_New(&a, m, n), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Vector_New(&v, n), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Vector_New(&r, m), CUBOOL_STATUS_SUCCESS);
+
+    // Transfer input data into input matrices
+    ASSERT_EQ(cuBool_Matrix_Build(a, ta.rowsIndex.data(), ta.colsIndex.data(), ta.nvals, CUBOOL_HINT_VALUES_SORTED & CUBOOL_HINT_NO_DUPLICATES), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Vector_Build(v, tv.index.data(), tv.nvals, CUBOOL_HINT_VALUES_SORTED & CUBOOL_HINT_NO_DUPLICATES), CUBOOL_STATUS_SUCCESS);
+
+    // Evaluate naive r += a x b on the cpu to compare results
+    testing::MatrixVectorMultiplyFunctor functor;
+    testing::Vector tr = functor(ta, tv);
+
+    // Evaluate r += a x b
+    ASSERT_EQ(cuBool_MxV(r, a, v, CUBOOL_HINT_NO), CUBOOL_STATUS_SUCCESS);
+
+    // Compare results
+    ASSERT_EQ(tr.areEqual(r), true);
+
+    // Deallocate matrices
+    ASSERT_EQ(cuBool_Matrix_Free(a), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Vector_Free(v), CUBOOL_STATUS_SUCCESS);
+    ASSERT_EQ(cuBool_Vector_Free(r), CUBOOL_STATUS_SUCCESS);
+}
+
+void testRun(cuBool_Index m, cuBool_Index n, cuBool_Hints setup) {
+    // Setup library
+    ASSERT_EQ(cuBool_Initialize(setup), CUBOOL_STATUS_SUCCESS);
+
+    for (size_t i = 0; i < 5; i++) {
+        testMatrixVectorMultiplyAdd(m, n, 0.1f + (0.05f) * ((float) i));
+    }
+
+    // Finalize library
+    ASSERT_EQ(cuBool_Finalize(), CUBOOL_STATUS_SUCCESS);
+}
+
+TEST(cuBool_Matrix, MultiplyMatrixVectorSmall) {
+    cuBool_Index m = 60, n = 80;
+    testRun(m, n, CUBOOL_HINT_NO);
+}
+
+TEST(cuBool_Matrix, MultiplyMatrixVectorMedium) {
+    cuBool_Index m = 500, n = 800;
+    testRun(m, n, CUBOOL_HINT_NO);
+}
+
+TEST(cuBool_Matrix, MultiplyMatrixVectorLarge) {
+    cuBool_Index m = 1000, n = 500;
+    testRun(m, n, CUBOOL_HINT_NO);
+}
+
+TEST(cuBool_Matrix, MultiplyMatrixVectorSmallFallback) {
+    cuBool_Index m = 60, n = 80;
+    testRun(m, n, CUBOOL_HINT_CPU_BACKEND);
+}
+
+TEST(cuBool_Matrix, MultiplyMatrixVectorMediumFallback) {
+    cuBool_Index m = 500, n = 800;
+    testRun(m, n, CUBOOL_HINT_CPU_BACKEND);
+}
+
+TEST(cuBool_Matrix, MultiplyMatrixVectorLargeFallback) {
+    cuBool_Index m = 1000, n = 500;
+    testRun(m, n, CUBOOL_HINT_CPU_BACKEND);
+}
+
+CUBOOL_GTEST_MAIN
diff --git a/cubool/tests/test_vector_vxm.cpp b/cubool/tests/test_vector_vxm.cpp
diff --git a/cubool/utils/testing/vector_functors.hpp b/cubool/utils/testing/vector_functors.hpp
