Add code examples from docs to examples folder

Author: Thoemi09

c++/itertools/enumerate.hpp

@@ -143,13 +143,7 @@ namespace itertools {
    * iterable lazy object (a itertools::enumerated range), which iterates over tuples consisting of the index and the 
    * value of the dereferenced iterator of the original range:
    *
-   * @code{.cpp}
-   * std::vector<char> vec { 'a', 'b', 'c' };
-   *
-   * for (auto [idx, val] : enumerate(vec)) {
-   *   std::cout << "(" << idx << ", " << val << ")\n";
-   * }
-   * @endcode
+   * @include doc_enumerate.cpp
    *
    * Output:
    *

c++/itertools/product.hpp

@@ -214,14 +214,7 @@ namespace itertools {
    * 
    * This function returns an iterable lazy object, which can be used in range-based for loops:
    *
-   * @code{.cpp}
-   * std::vector<int> v1 { 1, 2, 3 };
-   * std::vector<char> v2 { 'a', 'b' };
-   *
-   * for (auto [i, c] : product(v1, v2)) {
-   *   std::cout << "(" << i << ", " << c << ")\n";
-   * }
-   * @endcode
+   * @include doc_product.cpp
    *
    * Output:
    *

c++/itertools/range.hpp

@@ -49,26 +49,7 @@ namespace itertools {
    *
    * This function returns an iterable lazy object, which can be used in range-based for loops:
    *
-   * @code{.cpp}
-   * for (auto i : range(5)) {
-   *   std::cout << i << " ";
-   * }
-   * std::cout << "\n";
-   *
-   * for (auto i : range(-2, 1)) {
-   *   std::cout << i << " ";
-   * }
-   * std::cout << "\n";
-   *
-   * for (auto i : range(10, 3, -2)) {
-   *   std::cout << i << " ";
-   * }
-   * std::cout << "\n";
-   *
-   * for (auto i : range(0, 10, -1)) {
-   *   std::cout << i << " "; // empty
-   * }
-   * @endcode
+   * @include doc_range.cpp
    *
    * Output:
    *
@@ -106,7 +87,8 @@ namespace itertools {
 
     /**
      * @brief Default constructor.
-     * @deprecated Use range::range(long, long) or range::range(long, long, long) instead.
+     * @deprecated Use range::range(std::integral auto, std::integral auto) or range::range(std::integral auto, 
+     * std::integral auto, std::integral auto) instead.
      */
     [[deprecated("range default construction deprecated. Use range::all for full range in slicing operation")]] range() = default;
 
@@ -370,11 +352,7 @@ namespace itertools {
    * @details The given integers specify the excluded last values of the individual itertools::range objects. Each range
    * starts at 0 and has a step size of 1.
    *
-   * @code{.cpp}
-   * for (auto [i1, i2] : product_range(2, 3)) {
-   *   std::cout << "(" << i1 << ", " << i2 << ")\n";
-   * }
-   * @endcode
+   * @include doc_product_range.cpp
    *
    * Output:
    *
@@ -407,25 +385,7 @@ namespace itertools {
   /**
    * @brief Create a cartesian product range of integer ranges from a tuple of integers.
    *
-   * @details The integers in the given tuple specify the excluded last values of the individual itertools::range
-   * objects. Each range starts at 0 and has a step size of 1.
-   *
-   * @code{.cpp}
-   * for (auto [i1, i2] : product_range(std::make_tuple(2, 3))) {
-   *   std::cout << "(" << i1 << ", " << i2 << ")\n";
-   * }
-   * @endcode
-   *
-   * Output:
-   *
-   * ```
-   * (0, 0)
-   * (0, 1)
-   * (0, 2)
-   * (1, 0)
-   * (1, 1)
-   * (1, 2)
-   * ```
+   * @details It simply forwards the integers in the given tuple to itertools::product_range.
    *
    * @tparam Is Integer types.
    * @param idx_tpl Tuple containing the excluded last values of the integer ranges.
@@ -439,25 +399,7 @@ namespace itertools {
   /**
    * @brief Create a cartesian product range of integer ranges from an array of integers.
    *
-   * @details The integers in the given array specify the excluded last values of the individual itertools::range
-   * objects. Each range starts at 0 and has a step size of 1.
-   *
-   * @code{.cpp}
-   * for (auto [i1, i2] : product_range(std::array{2, 3})) {
-   *   std::cout << "(" << i1 << ", " << i2 << ")\n";
-   * }
-   * @endcode
-   *
-   * Output:
-   *
-   * ```
-   * (0, 0)
-   * (0, 1)
-   * (0, 2)
-   * (1, 0)
-   * (1, 1)
-   * (1, 2)
-   * ```
+   * @details It simply forwards the integers in the given array to itertools::product_range.
    *
    * @tparam I Integer type.
    * @tparam N Number of elements in the array.
@@ -472,12 +414,7 @@ namespace itertools {
   /**
    * @brief Apply a function to every element of an integer itertools::range.
    *
-   * @code{.cpp}
-   * // print out the first 10 squares
-   * itertools::foreach(itertools::range(1, 11), [](int i) {
-   *   std::cout << i * i << " ";
-   * });
-   * @endcode
+   * @include doc_for_each.cpp
    *
    * Output:
    *

c++/itertools/slice.hpp

@@ -105,23 +105,7 @@ namespace itertools {
    *
    * This function returns an iterable lazy object, which can be used in range-based for loops:
    *
-   * @code{.cpp}
-   * std::array<int, 5> arr { 1, 2, 3, 4, 5 };
-   *
-   * for (auto i : slice(arr, 1, 3)) {
-   *     std::cout << i << " ";
-   * }
-   * std::cout << "\n";
-   *
-   * for (auto i : slice(arr, 3, 7)) {
-   *     std::cout << i << " ";
-   * }
-   * std::cout << "\n";
-   *
-   * for (auto i : slice(arr, 4, 3)) {
-   *     std::cout << i << " "; // empty slice
-   * }
-   * @endcode
+   * @include doc_slice.cpp
    *
    * Output:
    *

c++/itertools/stride.hpp

@@ -148,18 +148,7 @@ namespace itertools {
    *
    * This function returns an iterable lazy object, which can be used in range-based for loops:
    *
-   * @code{.cpp}
-   * std::vector<int> vec { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
-   *
-   * for (auto i : stride(vec, 3)) {
-   *   std::cout << i << " ";
-   * }
-   * std::cout << "\n";
-   *
-   * for (auto i : stride(vec, 10)) {
-   *   std::cout << i << " ";
-   * }
-   * @endcode
+   * @include doc_stride.cpp
    *
    * Output:
    *

c++/itertools/transform.hpp

@@ -164,13 +164,7 @@ namespace itertools {
    * This function returns an iterable lazy object (a itertools::transformed range), which can be used in range-based 
    * for loops:
    *
-   * @code{.cpp}
-   * std::list<int> list { 1, 2, 3, 4, 5 };
-   *
-   * for (auto i : itertools::transform(list, [](int i) { return i * i; })) {
-   *   std::cout << i << " ";
-   * }
-   * @endcode
+   * @include doc_transform.cpp
    *
    * Output:
    *

c++/itertools/zip.hpp

@@ -189,18 +189,7 @@ namespace itertools {
    *
    * This function returns an iterable lazy object, which can be used in range-based for loops:
    *
-   * @code{.cpp}
-   * std::vector<int> v1 { 1, 2, 3 };
-   * std::vector<char> v2 { 'a', 'b', 'c', 'd', 'e' };
-   *
-   * for (auto [i1, i2] : zip(v1, v1)) {
-   *   std::cout << "(" << i1 << ", " << i2 << ") ";
-   * }
-   *
-   * for (auto [i1, i2, c3] : zip(v1, v1, v2)) {
-   *   std::cout << "(" << i1 << ", " << i2 << ", " << c3 << ") ";
-   * }
-   * @endcode
+   * @include doc_zip.cpp
    *
    * Output:
    *

doc/examples/CMakeLists.txt

@@ -1,6 +1,16 @@
-# We need GNU and c++23 for some std::ranges
+# we need GNU and c++23 for some std::ranges in the example ex1.cpp
 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     add_executable(ex1 ex1.cpp)
     target_link_libraries(ex1 itertools::itertools_c)
     target_compile_features(ex1 PRIVATE cxx_std_23)
-endif()
+endif()
+
+# all other example codes
+file(GLOB_RECURSE all_examples RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.cpp)
+list(FILTER all_examples EXCLUDE REGEX "ex1.cpp")
+
+foreach(ex_src ${all_examples})
+    get_filename_component(ex_name ${ex_src} NAME_WE)
+    add_executable(${ex_name} ${ex_src})
+    target_link_libraries(${ex_name} itertools::itertools_c)
+endforeach()

doc/examples/doc_enumerate.cpp

@@ -0,0 +1,8 @@
+#include <itertools/itertools.hpp>
+#include <iostream>
+#include <vector>
+
+int main() {
+  std::vector<char> vec{'a', 'b', 'c'};
+  for (auto [idx, val] : itertools::enumerate(vec)) std::cout << "(" << idx << ", " << val << ")\n";
+}

doc/examples/doc_for_each.cpp

@@ -0,0 +1,8 @@
+#include <itertools/itertools.hpp>
+#include <iostream>
+
+int main() {
+  // print out the first 10 squares
+  itertools::foreach(itertools::range(1, 11), [](int i) { std::cout << i * i << " "; });
+  std::cout << "\n";
+}