121 cluster (#122)

* Implement C library for clusterization of match table
* Add tests

Author: vladtcvs

.vscode/settings.json

@@ -10,7 +10,39 @@
         "image_deform_gc.h": "c",
         "stdlib.h": "c",
         "structmember.h": "c",
-        "imagedeform_gc.h": "c"
+        "imagedeform_gc.h": "c",
+        "vector": "cpp",
+        "cmath": "cpp",
+        "cstdarg": "cpp",
+        "cstddef": "cpp",
+        "cstdio": "cpp",
+        "cstdlib": "cpp",
+        "cstring": "cpp",
+        "array": "cpp",
+        "bit": "cpp",
+        "*.tcc": "cpp",
+        "compare": "cpp",
+        "concepts": "cpp",
+        "cstdint": "cpp",
+        "string": "cpp",
+        "unordered_map": "cpp",
+        "exception": "cpp",
+        "algorithm": "cpp",
+        "functional": "cpp",
+        "iterator": "cpp",
+        "memory": "cpp",
+        "memory_resource": "cpp",
+        "optional": "cpp",
+        "tuple": "cpp",
+        "type_traits": "cpp",
+        "utility": "cpp",
+        "initializer_list": "cpp",
+        "iosfwd": "cpp",
+        "limits": "cpp",
+        "new": "cpp",
+        "span": "cpp",
+        "stdexcept": "cpp",
+        "typeinfo": "cpp"
     },
     "editor.tabSize": 4,
     "editor.insertSpaces": true,

setup.py

@@ -16,6 +16,15 @@
 import numpy as np
 from setuptools import setup, Extension
 
+clusterization = Extension(name="vstarstack.library.clusters.clusterization",
+                           sources=[
+                               "src/vstarstack/library/clusters/clusterization/module.cc",
+                               "src/vstarstack/library/clusters/clusterization/lib/src/clusters.cc"
+                           ],
+                           include_dirs=[
+                               "src/vstarstack/library/clusters/clusterization/lib/include"
+                           ])
+
 projection = Extension( name="vstarstack.library.projection.projections",
                         sources=[
                             "src/vstarstack/library/projection/projections/module.c",
@@ -75,6 +84,7 @@
        ext_modules = [projection,
                       movements,
                       image_deform,
+                      clusterization,
                     ],
        entry_points = {
            'console_scripts': [

src/vstarstack/library/cluster.py

@@ -0,0 +1,55 @@
+cmake_minimum_required(VERSION 3.14)
+
+project(clusters)
+
+# Library sources
+add_library(clusters STATIC src/clusters.cc)
+
+set(HEADERS "include/clusters.hpp;")
+
+target_include_directories(clusters PUBLIC include)
+set_target_properties(clusters PROPERTIES PUBLIC_HEADER "${HEADERS}")
+
+# Fail on warnings
+if(MSVC)
+  target_compile_options(clusters PRIVATE /W4 /WX)
+else()
+  target_compile_options(clusters PRIVATE -Wall -Wextra -Wpedantic -Werror)
+endif()
+
+install(TARGETS clusters
+        PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/libclusters)
+
+# Tests
+if (BUILD_TESTS)
+    set(INSTALL_GTEST OFF)
+    include(FetchContent)
+    FetchContent_Declare(
+        googletest
+        URL https://github.com/google/googletest/archive/03597a01ee50ed33e9dfd640b249b4be3799d395.zip
+    )
+
+    # For Windows: Prevent overriding the parent project's compiler/linker settings
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    FetchContent_MakeAvailable(googletest)
+
+    enable_testing()
+    add_executable(
+        clusters_test
+        tests/clusters_test.cc
+    )
+
+    target_link_libraries(
+        clusters_test
+        GTest::gtest_main
+        clusters
+    )
+
+    include(GoogleTest)
+    gtest_discover_tests(clusters_test)
+
+    if (UNIX)
+        add_custom_target(memory_leak_test sh ${CMAKE_SOURCE_DIR}/run_valgrind_tests.sh ${CMAKE_BINARY_DIR}/clusters_test
+                          DEPENDS clusters_test)
+    endif()
+endif()

src/vstarstack/library/clusters/clusterization/lib/CMakeLists.txt

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2024 Vladislav Tsendrovskii
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, version 3 of the License.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <vector>
+
+struct item_s {
+    int frame_id;
+    int keypoint_id;
+};
+
+struct match_s {
+    item_s item1;
+    item_s item2;
+};
+
+struct cluster_s {
+    std::vector<item_s> items;
+};
+
+std::vector<cluster_s> build_clusters(const std::vector<match_s> &matches);

src/vstarstack/library/clusters/clusterization/lib/include/clusters.hpp

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+valgrind --error-exitcode 1 -s $1
+exit $?