ql:contains-word now can show the score of the word match in the respective text

.github/workflows/native-build.yml

@@ -40,6 +40,10 @@ jobs:
           - compiler: clang
             compiler-version: 13
         include:
+          - compiler: gcc
+            compiler-version: 11
+            additional-cmake-options: "-DUSE_CPP_17_BACKPORTS=ON"
+            build-type: Release
           - compiler: clang
             compiler-version: 16
             asan-flags: "-fsanitize=address -fno-omit-frame-pointer"

CMakeLists.txt

@@ -96,6 +96,17 @@ FetchContent_Declare(
         SOURCE_SUBDIR runtime/Cpp
 )
 
+#################################
+# Range v3 (for C++-17 backwards compatibility)
+################################
+FetchContent_Declare(
+        range-v3
+        GIT_REPOSITORY https://github.com/joka921/range-v3
+        GIT_TAG 1dc0b09abab1bdc7d085a78754abd5c6e37a5d0c # 0.12.0
+)
+
+
+
 ################################
 # Threading
 ################################
@@ -184,6 +195,14 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}  -Wall -Wextra")
 # Enable the specification of additional compiler flags manually from the commandline
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${ADDITIONAL_COMPILER_FLAGS}")
 
+# Enable the manual usage of the C++ 17 backports (currently `range-v3` instead
+# of `std::ranges` and the `std::enable_if_t` based expansion of the concept
+# macros from `range-v3`.
+set(USE_CPP_17_BACKPORTS OFF CACHE BOOL "Use the C++17 backports (range-v3 and enable_if_t instead of std::ranges and concepts)")
+if (${USE_CPP_17_BACKPORTS})
+    add_definitions("-DQLEVER_CPP_17 -DCPP_CXX_CONCEPTS=0")
+endif()
+
 # Enable the specification of additional linker flags manually from the commandline
 set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${ADDITIONAL_LINKER_FLAGS}")
 set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${ADDITIONAL_LINKER_FLAGS}")
@@ -321,7 +340,7 @@ FetchContent_Declare(
 ################################
 # Apply FetchContent
 ################################
-FetchContent_MakeAvailable(googletest ctre abseil re2 stxxl fsst s2 nlohmann-json antlr)
+FetchContent_MakeAvailable(googletest ctre abseil re2 stxxl fsst s2 nlohmann-json antlr range-v3)
 # Disable some warnings in RE2, STXXL, and GTEST
 target_compile_options(s2 PRIVATE -Wno-sign-compare -Wno-unused-parameter -Wno-class-memaccess -Wno-comment -Wno-redundant-move -Wno-unknown-warning-option -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-unused-but-set-variable -Wno-unused-function)
 target_compile_options(re2 PRIVATE -Wno-unused-parameter)
@@ -333,6 +352,7 @@ include_directories(${ctre_SOURCE_DIR}/single-header)
 target_compile_options(fsst PRIVATE -Wno-extra -Wno-all -Wno-error)
 target_compile_options(fsst12 PRIVATE -Wno-extra -Wno-all -Wno-error)
 include_directories(${fsst_SOURCE_DIR})
+include_directories(${range-v3_SOURCE_DIR}/include)
 target_compile_options(antlr4_static PRIVATE -Wno-all -Wno-extra -Wno-error -Wno-deprecated-declarations)
 # Only required because a lot of classes that do not explicitly link against antlr4_static use the headers.
 include_directories(SYSTEM "${antlr_SOURCE_DIR}/runtime/Cpp/runtime/src")

e2e/scientists_queries.yaml

@@ -55,31 +55,43 @@ queries:
           ?t ql:contains-word "RElaT* phySIKalische rela*"
       }
     checks:
-      - num_cols: 5
-      - selected: [ "?x", "?ql_score_t_var_x", "?t", "?ql_matchingword_t_relat", "?ql_matchingword_t_rela" ]
+      - num_cols: 8
+      - selected: [ "?x", "?ql_score_t_var_x", "?t", "?ql_score_prefix_t_RElaT", "?ql_matchingword_t_relat", "?ql_score_word_t_phySIKalische", "?ql_score_prefix_t_rela", "?ql_matchingword_t_rela" ]
       - contains_row:
           - "<Albert_Einstein>"
           - null
           - null
+          - null
           - "relationship"
+          - null
+          - null
           - "relationship"
       - contains_row:
           - "<Albert_Einstein>"
           - null
           - null
+          - null
           - "relationship"
+          - null
+          - null
           - "relativity"
       - contains_row:
           - "<Albert_Einstein>"
           - null
           - null
+          - null
           - "relativity"
+          - null
+          - null
           - "relationship"
       - contains_row:
           - "<Albert_Einstein>"
           - null
           - null
+          - null
           - "relativity"
+          - null
+          - null
           - "relativity"
 
   - query: algo-star-female-scientists
@@ -151,7 +163,7 @@ queries:
       }
       TEXTLIMIT 2
     checks:
-      - num_cols: 7
+      - num_cols: 9
       - num_rows: 18
 
   - query: algor-star-female-born-before-1940
@@ -192,7 +204,7 @@ queries:
       }
       ORDER BY DESC(?ql_score_text_fixedEntity__60_Ada_95_Lovelace_62_)
     checks:
-      - num_cols: 5
+      - num_cols: 6
       - num_rows: 7
       - contains_row:
         - "<Ada_Lovelace>"
@@ -202,6 +214,7 @@ queries:
         Charles Babbage, also known as' the father of computers', and in
         particular, Babbage's work on the Analytical Engine."
         - null
+        - null
         - "relationship"
       - order_numeric: {"dir": "DESC", 
       "var" : "?ql_score_text_fixedEntity__60_Ada_95_Lovelace_62_"}
@@ -219,7 +232,7 @@ queries:
       ORDER BY DESC(?ql_score_text_fixedEntity__60_Ada_95_Lovelace_62_)
       TEXTLIMIT 2
     checks:
-      - num_cols: 5
+      - num_cols: 6
       - num_rows: 3
       - contains_row:
         - "<Ada_Lovelace>"
@@ -229,6 +242,7 @@ queries:
         Charles Babbage, also known as' the father of computers', and in
         particular, Babbage's work on the Analytical Engine."
         - null
+        - null
         - "relationship"
       - order_numeric: {"dir": "DESC", 
       "var" : "?ql_score_text_fixedEntity__60_Ada_95_Lovelace_62_"}
@@ -246,7 +260,7 @@ queries:
       }
       TEXTLIMIT 1
     checks:
-      - num_cols: 6
+      - num_cols: 7
       - num_rows: 2
       - contains_row:
         - "<Ada_Lovelace>"
@@ -255,6 +269,7 @@ queries:
         with Somerville to visit Babbage as often as she could."
         - null
         - null
+        - null
         - "relationship"
 
 
@@ -1391,10 +1406,10 @@ queries:
           ?t ql:contains-word "algo* herm* primary"
       }
     checks:
-      - num_cols: 5
+      - num_cols: 8
       - num_rows: 1
-      - selected: [ "?x", "?ql_score_t_var_x", "?t", "?ql_matchingword_t_algo", "?ql_matchingword_t_herm" ]
-      - contains_row: [ "<Grete_Hermann>",null,"Hermann's algorithm for primary decomposition is still in use now.","algorithm","hermann" ]
+      - selected: [ "?x", "?ql_score_t_var_x", "?t", "?ql_score_prefix_t_algo", "?ql_matchingword_t_algo", "?ql_score_prefix_t_herm", "?ql_matchingword_t_herm", "?ql_score_word_t_primary" ]
+      - contains_row: [ "<Grete_Hermann>",null,"Hermann's algorithm for primary decomposition is still in use now.",null,"algorithm",null,"hermann",null ]
 
 
   - query : select_asterisk_regex-lastname-stein

src/backports/algorithm.h

@@ -0,0 +1,59 @@
+//  Copyright 2024, University of Freiburg,
+//                  Chair of Algorithms and Data Structures.
+//  Author: Johannes Kalmbach <[email protected]>
+
+#pragma once
+
+#include <algorithm>
+#include <functional>
+#include <range/v3/all.hpp>
+#include <utility>
+
+// The following defines namespaces `ql::ranges` and `ql::views` that are almost
+// drop-in replacements for `std::ranges` and `std::views`. In C++20 mode (when
+// the `QLEVER_CPP_17` macro is not used), these namespaces are simply aliases
+// for `std::ranges` and `std::views`. In C++17 mode they contain the ranges and
+// views from Erice Niebler's `range-v3` library. NOTE: `ql::ranges::unique`
+// currently doesn't work, because the interface to this function is different
+// in both implementations. NOTE: There might be other caveats which we are
+// currently not aware of, because they only affect functions that we currently
+// don't use. For those, the following header can be expanded in the future.
+#ifndef QLEVER_CPP_17
+#include <concepts>
+#include <ranges>
+#endif
+
+namespace ql {
+
+namespace ranges {
+#ifdef QLEVER_CPP_17
+using namespace ::ranges;
+
+// The `view` concept (which is rather important when implementing custom views)
+// is in a different namespace in range-v3, so we make it manually accessible.
+template <typename T>
+CPP_concept view = ::ranges::cpp20::view<T>;
+#else
+using namespace std::ranges;
+#endif
+}  // namespace ranges
+
+namespace views {
+#ifdef QLEVER_CPP_17
+using namespace ::ranges::views;
+#else
+using namespace std::views;
+#endif
+}  // namespace views
+
+// The namespace `ql::concepts` includes concepts that are contained in the
+// C++20 standard as well as in `range-v3`.
+namespace concepts {
+#ifdef QLEVER_CPP_17
+using namespace ::concepts;
+#else
+using namespace std;
+#endif
+}  // namespace concepts
+
+}  // namespace ql

src/backports/concepts.h

@@ -0,0 +1,17 @@
+//  Copyright 2024, University of Freiburg,
+//                  Chair of Algorithms and Data Structures.
+//  Author: Johannes Kalmbach <[email protected]>
+
+#pragma once
+
+// Define the following macros:
+// `QL_OPT_CONCEPT(arg)` which expands to `arg` in C++20 mode, and to nothing in
+// C++17 mode. It can be used to easily opt out of concepts that are only used
+// for documentation and increased safety and not for overload resolution.
+// Example usage:
+// `(QL_OPT_CONCEPT(std::view) auto x = someFunction();`
+#ifdef QLEVER_CPP_17
+#define QL_OPT_CONCEPT(arg)
+#else
+#define QL_OPT_CONCEPT(arg) arg
+#endif

src/engine/AddCombinedRowToTable.h

@@ -349,8 +349,8 @@ class AddCombinedRowToIdTable {
       // Make sure to reset `mergedVocab_` so it is in a valid state again.
       mergedVocab_ = LocalVocab{};
       // Only merge non-null vocabs.
-      auto range = currentVocabs_ | std::views::filter(toBool) |
-                   std::views::transform(dereference);
+      auto range = currentVocabs_ | ql::views::filter(toBool) |
+                   ql::views::transform(dereference);
       mergedVocab_.mergeWith(std::ranges::ref_view{range});
     }
   }

src/engine/Bind.cpp

@@ -86,8 +86,8 @@ IdTable Bind::cloneSubView(const IdTable& idTable,
                            const std::pair<size_t, size_t>& subrange) {
   IdTable result(idTable.numColumns(), idTable.getAllocator());
   result.resize(subrange.second - subrange.first);
-  std::ranges::copy(idTable.begin() + subrange.first,
-                    idTable.begin() + subrange.second, result.begin());
+  ql::ranges::copy(idTable.begin() + subrange.first,
+                   idTable.begin() + subrange.second, result.begin());
   return result;
 }
 

src/engine/CallFixedSize.h

@@ -56,7 +56,7 @@ template <int maxValue, size_t NumValues, std::integral Int>
 auto callLambdaForIntArray(std::array<Int, NumValues> array, auto&& lambda,
                            auto&&... args) {
   AD_CONTRACT_CHECK(
-      std::ranges::all_of(array, [](auto el) { return el <= maxValue; }));
+      ql::ranges::all_of(array, [](auto el) { return el <= maxValue; }));
   using ArrayType = std::array<Int, NumValues>;
 
   // Call the `lambda` when the correct compile-time `Int`s are given as a
@@ -131,7 +131,7 @@ decltype(auto) callFixedSize(std::array<Int, NumIntegers> ints, auto&& functor,
   static_assert(NumIntegers > 0);
   // TODO<joka921, C++23> Use `std::bind_back`
   auto p = [](int i) { return detail::mapToZeroIfTooLarge(i, MaxValue); };
-  std::ranges::transform(ints, ints.begin(), p);
+  ql::ranges::transform(ints, ints.begin(), p);
 
   // The only step that remains is to lift our single runtime `value` which
   // is in the range `[0, (MaxValue +1)^ NumIntegers]` to a compile-time