[Code] Setup basic vector interface && expose basic C API

Author: EgorOrachyov

cubool/CMakeLists.txt

@@ -38,8 +38,12 @@ set(CUBOOL_SOURCES
     sources/core/error.hpp
     sources/core/library.cpp
     sources/core/library.hpp
+    sources/core/object.cpp
+    sources/core/object.hpp
     sources/core/matrix.cpp
     sources/core/matrix.hpp
+    sources/core/vector.cpp
+    sources/core/vector.hpp
     sources/io/logger.cpp
     sources/io/logger.hpp
     sources/utils/exclusive_scan.hpp
@@ -71,12 +75,25 @@ set(CUBOOL_C_API_SOURCES
     sources/cuBool_Matrix_Free.cpp
     sources/cuBool_Matrix_Reduce.cpp
     sources/cuBool_Matrix_EWiseAdd.cpp
+    sources/cuBool_Vector_New.cpp
+    sources/cuBool_Vector_Build.cpp
+    sources/cuBool_Vector_SetElement.cpp
+    sources/cuBool_Vector_SetMarker.cpp
+    sources/cuBool_Vector_Marker.cpp
+    sources/cuBool_Vector_ExtractValues.cpp
+    sources/cuBool_Vector_ExtractSubVector.cpp
+    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_MxM.cpp
     sources/cuBool_Kronecker.cpp)
 
 set(CUBOOL_BACKEND_SOURCES
     sources/backend/backend_base.hpp
-    sources/backend/matrix_base.hpp)
+    sources/backend/matrix_base.hpp
+    sources/backend/vector_base.hpp)
 
 set(CUBOOL_CUDA_SOURCES)
 set(CUBOOL_SEQUENTIAL_SOURCES)
@@ -116,7 +133,9 @@ if (CUBOOL_WITH_SEQUENTIAL)
         sources/sequential/sq_backend.hpp
         sources/sequential/sq_matrix.cpp
         sources/sequential/sq_matrix.hpp
-        sources/sequential/sq_csr_data.hpp
+        sources/sequential/sq_vector.cpp
+        sources/sequential/sq_vector.hpp
+        sources/sequential/sq_data.hpp
         sources/sequential/sq_transpose.cpp
         sources/sequential/sq_transpose.hpp
         sources/sequential/sq_kronecker.cpp

cubool/include/cubool/cubool.h

@@ -106,9 +106,12 @@ typedef uint32_t cuBool_Hints;
 /** Alias integer type for indexing operations */
 typedef uint32_t cuBool_Index;
 
-/** Cubool sparse boolean matrix handle */
+/** cuBool sparse boolean matrix handle */
 typedef struct cuBool_Matrix_t* cuBool_Matrix;
 
+/** cuBool sparse boolean vector handle */
+typedef struct cuBool_Vector_t* cuBool_Vector;
+
 /** Cuda device capabilities */
 typedef struct cuBool_DeviceCaps {
     char name[256];
@@ -407,7 +410,7 @@ CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Matrix_Nvals(
  *
  * @param matrix Matrix handle to perform operation on
  * @param nrows[out] Pointer to the place where to store number of matrix rows
- * 
+ *
  * @return Error code on this operation
  */
 CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Matrix_Nrows(
@@ -485,6 +488,73 @@ CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Matrix_EWiseAdd(
     cuBool_Hints hints
 );
 
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_New(
+    cuBool_Vector* vector,
+    cuBool_Index nrows
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Build(
+    cuBool_Vector vector,
+    const cuBool_Index* rows,
+    cuBool_Index nvals,
+    cuBool_Hints hints
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_SetElement(
+    cuBool_Vector vector,
+    cuBool_Index i
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_SetMarker(
+    cuBool_Vector vector,
+    const char* marker
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Marker(
+    cuBool_Vector vector,
+    char* marker,
+    cuBool_Index* size
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_ExtractValues(
+    cuBool_Vector vector,
+    cuBool_Index* rows,
+    cuBool_Index* nvals
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_ExtractSubVector(
+    cuBool_Vector result,
+    cuBool_Vector vector,
+    cuBool_Index i,
+    cuBool_Index nrows,
+    cuBool_Hints hints
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Duplicate(
+    cuBool_Vector vector,
+    cuBool_Vector* duplicated
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Nvals(
+    cuBool_Vector vector,
+    cuBool_Index* nvals
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Nrows(
+    cuBool_Vector vector,
+    cuBool_Index* nrows
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Free(
+    cuBool_Vector vector
+);
+
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Vector_Reduce(
+    cuBool_Index* result,
+    cuBool_Vector vector,
+    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.

cubool/sources/backend/backend_base.hpp

@@ -26,6 +26,7 @@
 #define CUBOOL_BACKEND_BASE_HPP
 
 #include <backend/matrix_base.hpp>
+#include <backend/vector_base.hpp>
 #include <core/config.hpp>
 
 namespace cubool {
@@ -37,7 +38,9 @@ namespace cubool {
         virtual void finalize() = 0;
         virtual bool isInitialized() const = 0;
         virtual MatrixBase* createMatrix(size_t nrows, size_t ncols) = 0;
+        virtual VectorBase* createVector(size_t nrows) = 0;
         virtual void releaseMatrix(MatrixBase* matrixBase) = 0;
+        virtual void releaseVector(VectorBase* vectorBase) = 0;
         virtual void queryCapabilities(cuBool_DeviceCaps& caps) = 0;
     };
 

cubool/sources/backend/matrix_base.hpp

@@ -26,7 +26,6 @@
 #define CUBOOL_MATRIX_BASE_HPP
 
 #include <core/config.hpp>
-#include <string>
 
 namespace cubool {
 
@@ -40,8 +39,7 @@ namespace cubool {
         virtual void setElement(index i, index j) = 0;
         virtual void build(const index *rows, const index *cols, size_t nvals, bool isSorted, bool noDuplicates) = 0;
         virtual void extract(index* rows, index* cols, size_t &nvals) = 0;
-        virtual void
-        extractSubMatrix(const MatrixBase &otherBase, index i, index j, index nrows, index ncols, bool checkTime) = 0;
+        virtual void extractSubMatrix(const MatrixBase &otherBase, index i, index j, index nrows, index ncols, bool checkTime) = 0;
 
         virtual void clone(const MatrixBase& otherBase) = 0;
         virtual void transpose(const MatrixBase &otherBase, bool checkTime) = 0;

cubool/sources/backend/vector_base.hpp

@@ -0,0 +1,56 @@
+/**********************************************************************************/
+/* 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_VECTOR_BASE_HPP
+#define CUBOOL_VECTOR_BASE_HPP
+
+#include <core/config.hpp>
+
+namespace cubool {
+
+    /**
+     * Base class for any boolean vector type
+     */
+    class VectorBase {
+    public:
+        virtual ~VectorBase() = default;
+
+        virtual void setElement(index i) = 0;
+        virtual void build(const index *rows, size_t nvals, bool isSorted, bool noDuplicates) = 0;
+        virtual void extract(index* rows, size_t &nvals) = 0;
+        virtual void extractSubVector(const VectorBase &otherBase, index i, index nrows, bool checkTime) = 0;
+
+        virtual void clone(const VectorBase& otherBase) = 0;
+        virtual void reduce(index &result, bool checkTime) = 0;
+        virtual void reduceMatrix(const class MatrixBase& matrix, bool transpose, bool checkTime) = 0;
+
+        virtual index getNrows() const = 0;
+        virtual index getNvals() const = 0;
+
+        bool isZeroDim() const { return getNrows() == 0; }
+    };
+
+}
+
+#endif //CUBOOL_VECTOR_BASE_HPP

cubool/sources/core/config.hpp

@@ -26,6 +26,8 @@
 #define CUBOOL_CONFIG_HPP
 
 #include <cubool/cubool.h>
+#include <cinttypes>
+#include <cstddef>
 
 namespace cubool {
     using index = cuBool_Index;

cubool/sources/core/library.cpp

@@ -25,6 +25,7 @@
 #include <core/library.hpp>
 #include <core/error.hpp>
 #include <core/matrix.hpp>
+#include <core/vector.hpp>
 #include <backend/backend_base.hpp>
 #include <backend/matrix_base.hpp>
 #include <io/logger.hpp>
@@ -44,7 +45,7 @@
 
 namespace cubool {
 
-    std::unordered_set<class Matrix*> Library::mAllocated;
+    std::unordered_set<class Matrix*> Library::mAllocMatrices;
     std::shared_ptr<class BackendBase> Library::mBackend = nullptr;
     std::shared_ptr<class Logger>  Library::mLogger = std::make_shared<DummyLogger>();
     bool Library::mRelaxedRelease = false;
@@ -95,16 +96,22 @@ namespace cubool {
                 LogStream stream(*getLogger());
                 stream << Logger::Level::Info << "Enabled relaxed library finalize" << LogStream::cmt;
 
-                for (auto m: mAllocated) {
+                for (auto m: mAllocMatrices) {
                     stream << Logger::Level::Warning << "Implicitly release matrix " << m->getDebugMarker() << LogStream::cmt;
                     delete m;
                 }
 
-                mAllocated.clear();
+                for (auto v: mAllocVectors) {
+                    stream << Logger::Level::Warning << "Implicitly release vector " << v->getDebugMarker() << LogStream::cmt;
+                    delete v;
+                }
+
+                mAllocMatrices.clear();
+                mAllocVectors.clear();
             }
 
             // Some final message
-            mLogger->logInfo("** cuBool:Finalize backend **");
+            mLogger->logInfo("*** cuBool:Finalize backend ***");
 
             // Remember to finalize backend
             mBackend->finalize();
@@ -184,7 +191,7 @@ namespace cubool {
         CHECK_RAISE_ERROR(ncols > 0, InvalidArgument, "Cannot create matrix with zero dimension");
 
         auto m = new Matrix(nrows, ncols, *mBackend);
-        mAllocated.emplace(m);
+        mAllocMatrices.emplace(m);
 
         LogStream stream(*getLogger());
         stream << Logger::Level::Info << "Create Matrix " << m->getDebugMarker()
@@ -193,18 +200,43 @@ namespace cubool {
         return m;
     }
 
+    class Vector * Library::createVector(size_t nrows) {
+        CHECK_RAISE_ERROR(nrows > 0, InvalidArgument, "Cannot create vector with zero dimension");
+
+        auto v = new Vector(nrows, *mBackend);
+        mAllocVectors.emplace(v);
+
+        LogStream stream(*getLogger());
+        stream << Logger::Level::Info << "Create Vector " << v->getDebugMarker()
+               << " (" << nrows << ")" << LogStream::cmt;
+
+        return v;
+    }
+
     void Library::releaseMatrix(Matrix *matrix) {
         if (mRelaxedRelease && !mBackend) return;
 
-        CHECK_RAISE_ERROR(mAllocated.find(matrix) != mAllocated.end(), InvalidArgument, "No such matrix was allocated");
+        CHECK_RAISE_ERROR(mAllocMatrices.find(matrix) != mAllocMatrices.end(), InvalidArgument, "No such matrix was allocated");
 
         LogStream stream(*getLogger());
         stream << Logger::Level::Info << "Release Matrix " << matrix->getDebugMarker() << LogStream::cmt;
 
-        mAllocated.erase(matrix);
+        mAllocMatrices.erase(matrix);
         delete matrix;
     }
 
+    void Library::releaseVector(class Vector *vector) {
+        if (mRelaxedRelease && !mBackend) return;
+
+        CHECK_RAISE_ERROR(mAllocVectors.find(vector) != mAllocVectors.end(), InvalidArgument, "No such vector was allocated");
+
+        LogStream stream(*getLogger());
+        stream << Logger::Level::Info << "Release Vector " << vector->getDebugMarker() << LogStream::cmt;
+
+        mAllocVectors.erase(vector);
+        delete vector;
+    }
+
     void Library::handleError(const std::exception& error) {
         mLogger->log(Logger::Level::Error, error.what());
     }

cubool/sources/core/library.hpp

@@ -39,15 +39,18 @@ namespace cubool {
         static void validate();
         static void setupLogging(const char* logFileName, cuBool_Hints hints);
         static class Matrix *createMatrix(size_t nrows, size_t ncols);
+        static class Vector *createVector(size_t nrows);
         static void releaseMatrix(class Matrix *matrix);
+        static void releaseVector(class Vector *vector);
         static void handleError(const std::exception& error);
         static void queryCapabilities(cuBool_DeviceCaps& caps);
         static void logDeviceInfo();
         static bool isBackedInitialized();
         static class Logger* getLogger();
 
     private:
-        static std::unordered_set<class Matrix*> mAllocated;
+        static std::unordered_set<class Matrix*> mAllocMatrices;
+        static std::unordered_set<class Vector*> mAllocVectors;
         static std::shared_ptr<class BackendBase> mBackend;
         static std::shared_ptr<class Logger> mLogger;
         static bool mRelaxedRelease;

cubool/sources/core/matrix.cpp

@@ -330,23 +330,6 @@ namespace cubool {
         return mHnd->getNvals();
     }
 
-    void Matrix::setDebugMarker(const char *marker) {
-        CHECK_RAISE_ERROR(marker, InvalidArgument, "Null pointer marker string");
-
-        // Marker = "$marker (address)"
-        std::stringstream s;
-        s << marker << " (" << this << ")";
-        mMarker = s.str();
-    }
-
-    const char * Matrix::getDebugMarker() const {
-        return mMarker.c_str();
-    }
-
-    index Matrix::getDebugMarkerSizeWithNullT() const {
-        return mMarker.length() + 1;
-    }
-
     void Matrix::releaseCache() const {
         mCachedI.clear();
         mCachedJ.clear();