[Code] Add vector eWiseAdd op && support setElement (in sq backend)

EgorOrachyov · EgorOrachyov · commit c1c49e9ba4bc · 2021-04-28T14:45:27.000+03:00
diff --git a/cubool/CMakeLists.txt b/cubool/CMakeLists.txt
@@ -85,8 +85,9 @@ set(CUBOOL_C_API_SOURCES
     sources/cuBool_Vector_Duplicate.cpp
     sources/cuBool_Vector_Nvals.cpp
     sources/cuBool_Vector_Nrows.cpp
-    sources/cuBool_Vector_Reduce.cpp
     sources/cuBool_Vector_Free.cpp
+    sources/cuBool_Vector_Reduce.cpp
+    sources/cuBool_Vector_EWiseAdd.cpp
     sources/cuBool_MxM.cpp
     sources/cuBool_Kronecker.cpp)
 
diff --git a/cubool/include/cubool/cubool.h b/cubool/include/cubool/cubool.h
@@ -555,6 +555,13 @@ CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Reduce(
     cuBool_Hints hints
 );
 
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_EWiseAdd(
+        cuBool_Vector result,
+        cuBool_Vector left,
+        cuBool_Vector right,
+        cuBool_Hints hints
+);
+
 /**
  * Performs result (accum)= left x right evaluation, where source '+' and 'x' are boolean semiring operations.
  * If accum hint passed, the the result of the multiplication is added to the result matrix.
diff --git a/cubool/sources/backend/vector_base.hpp b/cubool/sources/backend/vector_base.hpp
@@ -45,6 +45,8 @@ namespace cubool {
         virtual void reduce(index &result, bool checkTime) = 0;
         virtual void reduceMatrix(const class MatrixBase& matrix, bool transpose, bool checkTime) = 0;
 
+        virtual void eWiseAdd(const VectorBase &aBase, const VectorBase &bBase, bool checkTime) = 0;
+
         virtual index getNrows() const = 0;
         virtual index getNvals() const = 0;
 
diff --git a/cubool/sources/core/vector.cpp b/cubool/sources/core/vector.cpp
@@ -25,8 +25,15 @@
 #include <core/vector.hpp>
 #include <core/error.hpp>
 #include <core/library.hpp>
+#include <utils/timer.hpp>
 #include <io/logger.hpp>
 
+#define TIMER_ACTION(timer, action)              \
+    Timer timer;                                 \
+    timer.start();                               \
+    action;                                      \
+    timer.end()
+
 namespace cubool {
 
     Vector::Vector(size_t nrows, BackendBase &backend) {
@@ -48,7 +55,10 @@ namespace cubool {
     }
 
     void Vector::setElement(index i) {
-        RAISE_ERROR(NotImplemented, "This function is not implemented");
+        CHECK_RAISE_ERROR(i < getNrows(), InvalidArgument, "Value out of vector bounds");
+
+        // This values will be committed later
+        mCachedI.push_back(i);
     }
 
     void Vector::build(const index *rows, size_t nvals, bool isSorted, bool noDuplicates) {
@@ -103,6 +113,39 @@ namespace cubool {
         RAISE_ERROR(NotImplemented, "This function is not implemented");
     }
 
+    void Vector::eWiseAdd(const VectorBase &aBase, const VectorBase &bBase, bool checkTime) {
+        const auto* a = dynamic_cast<const Vector*>(&aBase);
+        const auto* b = dynamic_cast<const Vector*>(&bBase);
+
+        CHECK_RAISE_ERROR(a != nullptr, InvalidArgument, "Passed vector does not belong to core vector class");
+        CHECK_RAISE_ERROR(b != nullptr, InvalidArgument, "Passed vector does not belong to core vector class");
+
+        index M = a->getNrows();
+
+        CHECK_RAISE_ERROR(M == b->getNrows(), InvalidArgument, "Passed vectors have incompatible size");
+        CHECK_RAISE_ERROR(M == this->getNrows(), InvalidArgument, "Vector has incompatible size for operation result");
+
+        a->commitCache();
+        b->commitCache();
+        this->releaseCache();
+
+        if (checkTime) {
+            TIMER_ACTION(timer, mHnd->eWiseAdd(*a->mHnd, *b->mHnd, false));
+
+            LogStream stream(*Library::getLogger());
+            stream << Logger::Level::Info
+                   << "Time: " << timer.getElapsedTimeMs() << " ms "
+                   << "Vector::eWiseAdd: "
+                   << this->getDebugMarker() << " = "
+                   << a->getDebugMarker() << " + "
+                   << b->getDebugMarker() << LogStream::cmt;
+
+            return;
+        }
+
+        mHnd->eWiseAdd(*a->mHnd, *b->mHnd, false);
+    }
+
     index Vector::getNrows() const {
         return mHnd->getNrows();
     }
@@ -117,7 +160,31 @@ namespace cubool {
     }
 
     void Vector::commitCache() const {
-        // todo
+        size_t cachedNvals = mCachedI.size();
+
+        // Nothing to do if no value was cached on CPU side
+        if (cachedNvals == 0)
+            return;
+
+        bool isSorted = false;
+        bool noDuplicates = false;
+
+        if (mHnd->getNvals() > 0) {
+            // We will have to join old and new values
+            // Create tmp vector and merge values
+
+            VectorBase* tmp = mProvider->createVector(getNrows());
+            tmp->build(mCachedI.data(), cachedNvals, isSorted, noDuplicates);
+            mHnd->eWiseAdd(*mHnd, *tmp, false);
+            mProvider->releaseVector(tmp);
+        }
+        else {
+            // Otherwise, new values are used to build vector content
+            mHnd->build(mCachedI.data(), cachedNvals, isSorted, noDuplicates);
+        }
+
+        // Clear arrays
+        releaseCache();
     }
 
 }
diff --git a/cubool/sources/core/vector.hpp b/cubool/sources/core/vector.hpp
@@ -48,6 +48,8 @@ namespace cubool {
         void reduce(index &result, bool checkTime) override;
         void reduceMatrix(const MatrixBase &matrix, bool transpose, bool checkTime) override;
 
+        void eWiseAdd(const VectorBase &aBase, const VectorBase &bBase, bool checkTime) override;
+
         index getNrows() const override;
         index getNvals() const override;
 
diff --git a/cubool/sources/cuBool_Vector_EWiseAdd.cpp b/cubool/sources/cuBool_Vector_EWiseAdd.cpp
@@ -0,0 +1,43 @@
+/**********************************************************************************/
+/* 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 <cuBool_Common.hpp>
+
+cuBool_Status cuBool_Vector_EWiseAdd(
+        cuBool_Vector result,
+        cuBool_Vector left,
+        cuBool_Vector right,
+        cuBool_Hints hints
+) {
+    CUBOOL_BEGIN_BODY
+        CUBOOL_VALIDATE_LIBRARY
+        CUBOOL_ARG_NOT_NULL(result)
+        CUBOOL_ARG_NOT_NULL(left)
+        CUBOOL_ARG_NOT_NULL(right)
+        auto resultM = (cubool::Vector *) result;
+        auto leftM = (cubool::Vector *) left;
+        auto rightM = (cubool::Vector *) right;
+        resultM->eWiseAdd(*leftM, *rightM, hints & CUBOOL_HINT_TIME_CHECK);
+    CUBOOL_END_BODY
+}
diff --git a/cubool/sources/sequential/sq_ewiseadd.cpp b/cubool/sources/sequential/sq_ewiseadd.cpp
@@ -117,4 +117,75 @@ namespace cubool {
         }
     }
 
+    void sq_ewiseadd(const VecData& a, const VecData& b, VecData& out) {
+        size_t nnz = 0;
+
+        const index* ar = a.indices.data();
+        const index* br = b.indices.data();
+
+        const index* arend = a.indices.data() + a.nvals;
+        const index* brend = b.indices.data() + b.nvals;
+
+        // Count nnz
+        while (ar != arend && br != brend) {
+            if (*ar == *br) {
+                ar++;
+                br++;
+            }
+            else if (*ar < *br) {
+                ar++;
+            }
+            else {
+                br++;
+            }
+
+            nnz++;
+        }
+
+        while (ar != arend) {
+            nnz++;
+            ar++;
+        }
+
+        while (br != brend) {
+            nnz++;
+            br++;
+        }
+
+        // Allocate data
+        out.indices.clear();
+        out.indices.reserve(nnz);
+        out.nvals = nnz;
+
+        // Fill data
+        ar = a.indices.data();
+        br = b.indices.data();
+
+        while (ar != arend && br != brend) {
+            if (*ar == *br) {
+                out.indices.push_back(*ar);
+                ar++;
+                br++;
+            }
+            else if (*ar < *br) {
+                out.indices.push_back(*ar);
+                ar++;
+            }
+            else {
+                out.indices.push_back(*br);
+                br++;
+            }
+        }
+
+        while (ar != arend) {
+            out.indices.push_back(*ar);
+            ar++;
+        }
+
+        while (br != brend) {
+            out.indices.push_back(*br);
+            br++;
+        }
+    }
+
 }
diff --git a/cubool/sources/sequential/sq_ewiseadd.hpp b/cubool/sources/sequential/sq_ewiseadd.hpp
@@ -38,6 +38,15 @@ namespace cubool {
      */
     void sq_ewiseadd(const CsrData& a, const CsrData& b, CsrData& out);
 
+    /**
+     * Element-wise addition of the vectors `a` and `b`.
+     *
+     * @param a Input vector
+     * @param b Input vector
+     * @param[out] out Where to store the result
+     */
+    void sq_ewiseadd(const VecData& a, const VecData& b, VecData& out);
+
 }
 
 #endif //CUBOOL_SQ_EWISEADD_HPP
diff --git a/cubool/sources/sequential/sq_vector.cpp b/cubool/sources/sequential/sq_vector.cpp
@@ -25,6 +25,7 @@
 #include <sequential/sq_vector.hpp>
 #include <sequential/sq_matrix.hpp>
 #include <sequential/sq_reduce.hpp>
+#include <sequential/sq_ewiseadd.hpp>
 #include <sequential/sq_subvector.hpp>
 #include <utils/data_utils.hpp>
 #include <core/error.hpp>
@@ -106,6 +107,24 @@ namespace cubool {
         this->mData = std::move(out);
     }
 
+    void SqVector::eWiseAdd(const VectorBase &aBase, const VectorBase &bBase, bool checkTime) {
+        auto a = dynamic_cast<const SqVector*>(&aBase);
+        auto b = dynamic_cast<const SqVector*>(&bBase);
+
+        CHECK_RAISE_ERROR(a != nullptr, InvalidArgument, "Provided vector does not belongs to sequential vector class");
+        CHECK_RAISE_ERROR(b != nullptr, InvalidArgument, "Provided vector does not belongs to sequential vector class");
+
+        assert(a->getNrows() == this->getNrows());
+        assert(a->getNrows() == b->getNrows());
+
+        VecData out;
+        out.nrows = this->getNrows();
+
+        sq_ewiseadd(a->mData, b->mData, out);
+
+        this->mData = std::move(out);
+    }
+
     index SqVector::getNrows() const {
         return mData.nrows;
     }
diff --git a/cubool/sources/sequential/sq_vector.hpp b/cubool/sources/sequential/sq_vector.hpp
@@ -32,7 +32,7 @@ namespace cubool {
 
     class SqVector final: public VectorBase {
     public:
-        SqVector(size_t nrows);
+        explicit SqVector(size_t nrows);
         ~SqVector() override = default;
 
         void setElement(index i) override;
@@ -44,6 +44,8 @@ namespace cubool {
         void reduce(index &result, bool checkTime) override;
         void reduceMatrix(const class MatrixBase &matrix, bool transpose, bool checkTime) override;
 
+        void eWiseAdd(const VectorBase &aBase, const VectorBase &bBase, bool checkTime) override;
+
         index getNrows() const override;
         index getNvals() const override;
 
diff --git a/cubool/sources/utils/data_utils.cpp b/cubool/sources/utils/data_utils.cpp
@@ -139,9 +139,14 @@ namespace cubool {
 
     void DataUtils::buildVectorFromData(size_t nrows, const index *rows, size_t nvals, std::vector<index> &values,
                                         bool isSorted, bool noDuplicates) {
+        values.resize(nvals);
+        std::copy(rows, rows + nvals, values.begin());
+
+        if (nvals == 0)
+            return;
+
         assert(rows);
 
-        values.resize(nvals);
         std::copy(rows, rows + nvals, values.begin());
 
         auto checkBounds = [&]() {
diff --git a/cubool/tests/CMakeLists.txt b/cubool/tests/CMakeLists.txt
@@ -29,4 +29,10 @@ add_executable(test_matrix_ewiseadd test_matrix_ewiseadd.cpp)
 target_link_libraries(test_matrix_ewiseadd PUBLIC testing)
 
 add_executable(test_vector_misc test_vector_misc.cpp)
-target_link_libraries(test_vector_misc PUBLIC testing)
+target_link_libraries(test_vector_misc PUBLIC testing)
+
+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)
diff --git a/cubool/tests/test_vector_element.cpp b/cubool/tests/test_vector_element.cpp
diff --git a/cubool/tests/test_vector_ewiseadd.cpp b/cubool/tests/test_vector_ewiseadd.cpp
diff --git a/cubool/utils/testing/testing.hpp b/cubool/utils/testing/testing.hpp
diff --git a/cubool/utils/testing/vector_functors.hpp b/cubool/utils/testing/vector_functors.hpp
