From 9b6bfd937cb6adac9d0145928463a5e89320c7ac Mon Sep 17 00:00:00 2001 From: Drewniok Date: Mon, 25 Mar 2024 11:21:19 +0100 Subject: [PATCH] :memo: small fix. --- .../pyfiction/pybind11_mkdoc_docstrings.hpp | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp b/bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp index 9816657f4..ee3b5f3e0 100644 --- a/bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp +++ b/bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp @@ -54,13 +54,13 @@ paths even if the layout implements a clocking interface. This can be achieved by static-casting the layout to a coordinate layout when calling this function: -``` +`` {.cpp} using clk_lyt = clocked_layout>; using path = layout_coordinate_path>; clk_lyt layout = ...; auto shortest_path = a_star(static_cast>(layout), {source, target}); -``` +`` A* was introduced in \"A Formal Basis for the Heuristic Determination of Minimum Cost Paths\" by Peter E. Hart, Nils J. Nilsson, and Bertram @@ -2828,13 +2828,13 @@ performed. Example usage: -``` +`` {.cpp} std::ofstream file("output.csv"); csv_writer writer(file); writer.write_line("Name", "Age", "City"); writer.write_line("Alice", 20, "New York"); -```)doc"; +``)doc"; static const char* __doc_fiction_csv_writer_csv_writer = R"doc(Standard constructor. @@ -2875,7 +2875,7 @@ static const char* __doc_fiction_cube_coord_t = R"doc(Signed cube coordinates. This implementation allows for negative coordinate values and offers a balance between memory consumption and range -of values. Coordinates span from \f$(-2^{31}, -2^{31}, -2^{31})\f$ to \f$(2^{31} - 1, 2^{31} - 1, 2^{31} - 1)\f$. +of values. Coordinates span from :math:`(-2^{31}, -2^{31}, -2^{31})` to :math:`(2^{31} - 1, 2^{31} - 1, 2^{31} - 1)`. Each coordinate has a dead indicator ``d`` that can be used to represent that it is not in use.)doc"; static const char* __doc_fiction_cube_coord_t_coord_t = @@ -6802,13 +6802,13 @@ paths even if the layout implements a clocking interface. This can be achieved by static-casting the layout to a coordinate layout when calling this function: -``` +`` {.cpp} using clk_lyt = clocked_layout>; using path = layout_coordinate_path>; clk_lyt layout = ...; auto all_paths = enumerate_all_paths(static_cast>(layout), {source, target}); -``` +`` Template parameter ``Path``: Type of the returned individual paths. @@ -10542,13 +10542,13 @@ paths even if the layout implements a clocking interface. This can be achieved by static-casting the layout to a coordinate layout when calling this function: -``` +`` {.cpp} using clk_lyt = clocked_layout>; using path = layout_coordinate_path>; clk_lyt layout = ...; auto shortest_path = jump_point_search(static_cast>(layout), {source, target}); -``` +`` JPS was introduced in \"Online Graph Pruning for Pathfinding on Grid Maps\" by Daniel Harabor and Alban Grastien in AAAI 2011. @@ -14921,13 +14921,13 @@ paths even if the layout implements a clocking interface. This can be achieved by static-casting the layout to a coordinate layout when calling this function: -``` +`` {.cpp} using clk_lyt = clocked_layout>; using path = layout_coordinate_path>; clk_lyt layout = ...; auto k_paths = yen_k_shortest_paths(static_cast>(layout), {source, target}, k); -``` +`` The algorithm was originally described in \"An algorithm for finding shortest routes from all source nodes to a given destination in