Added readme example to CI build.

Author: 5cript

.github/workflows/build_and_test.yml

@@ -48,7 +48,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: CMake Configure
-        run: cmake -B ${{github.workspace}}/build -G"Ninja" -DINT_TREE_ENABLE_TESTS=on -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_COMPILER=${{ matrix.compiler.cxx }} -DCMAKE_CXX_STANDARD=${{ matrix.cxx_standard }}
+        run: cmake -B ${{github.workspace}}/build -G"Ninja" -DINT_TREE_BUILD_EXAMPLES=on -DINT_TREE_ENABLE_TESTS=on -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_COMPILER=${{ matrix.compiler.cxx }} -DCMAKE_CXX_STANDARD=${{ matrix.cxx_standard }}
 
       - name: Build
         run: cmake --build ${{github.workspace}}/build

CMakeLists.txt

@@ -14,4 +14,7 @@ if(INT_TREE_DRAW_EXAMPLES)
 endif()
 if (INT_TREE_ENABLE_TESTS)
     add_subdirectory(tests)
+endif()
+if (INT_TREE_BUILD_EXAMPLES)
+    add_subdirectory(example)
 endif()

README.md

@@ -22,8 +22,13 @@ int main()
 {
   using namespace lib_interval_tree;
 
-  // interval_tree <interval <int>>;
-  interval_tree_t <int> tree;
+  // interval_tree<interval<int>>; // closed by default
+  // interval_tree<interval<int, open>>;
+  // interval_tree<interval<int, closed>>;
+  // interval_tree<interval<int, left_open>>;
+  // interval_tree<interval<int, right_open>>;
+  // interval_tree<interval<int, closed_adjacent>>; // counts adjacent intervals as overlapping
+  interval_tree_t<int> tree;
 
   tree.insert(make_safe_interval<int>(21, 16)); // make_safe_interval swaps low and high if not in right order.
   tree.insert({8, 9});
@@ -42,6 +47,12 @@ int main()
   {
     std::cout << "[" << i.low() << ", " << i.high() << "]\n";
   }
+
+  using lib_interval_tree::open;
+  // dynamic has some logic overhead.
+  interval_tree<interval<int, dynamic>> dynamicIntervals;
+  dynamicIntervals.insert({0, 1, closed, open});
+  dynamicIntervals.insert({7, 5, open, closed_adjacent});
 }
 ```
 

example/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(from_readme)

example/from_readme/CMakeLists.txt

@@ -0,0 +1,7 @@
+add_executable(from_readme main.cpp)
+target_link_libraries(from_readme interval-tree)
+
+set_target_properties(from_readme
+    PROPERTIES
+    RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/interval_tree/examples"
+)

example/from_readme/main.cpp

@@ -0,0 +1,39 @@
+// #include <interval-tree/draw.hpp> // to draw tree. this is not header only anymore.
+#include <interval-tree/interval_tree.hpp>
+
+int main()
+{
+    using namespace lib_interval_tree;
+
+    // interval_tree<interval<int>>; // closed by default
+    // interval_tree<interval<int, open>>;
+    // interval_tree<interval<int, closed>>;
+    // interval_tree<interval<int, left_open>>;
+    // interval_tree<interval<int, right_open>>;
+    // interval_tree<interval<int, closed_adjacent>>; // counts adjacent intervals as overlapping
+    interval_tree_t<int> tree;
+
+    tree.insert(make_safe_interval<int>(21, 16)); // make_safe_interval swaps low and high if not in right order.
+    tree.insert({8, 9});
+    tree.insert({25, 30});
+    tree.insert({5, 8});
+    tree.insert({15, 23});
+    tree.insert({17, 19});
+    tree.insert({26, 26});
+    tree.insert({0, 3});
+    tree.insert({6, 10});
+    tree.insert({19, 20});
+
+    tree.deoverlap();
+
+    for (auto const& i : tree)
+    {
+        std::cout << "[" << i.low() << ", " << i.high() << "]\n";
+    }
+
+    using lib_interval_tree::open;
+    // dynamic has some logic overhead.
+    interval_tree<interval<int, dynamic>> dynamicIntervals;
+    dynamicIntervals.insert({0, 1, interval_border::closed, interval_border::open});
+    dynamicIntervals.insert({7, 5, interval_border::open, interval_border::closed_adjacent});
+}