Skip to content

Commit

Permalink
📝 small fix.
Browse files Browse the repository at this point in the history
  • Loading branch information
Drewniok committed Mar 25, 2024
1 parent f01e49d commit 9b6bfd9
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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<cartesian_layout<>>;
using path = layout_coordinate_path<cartesian_layout<>>;
clk_lyt layout = ...;
auto shortest_path = a_star<path>(static_cast<cartesian_layout<>>(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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 =
Expand Down Expand Up @@ -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<cartesian_layout<>>;
using path = layout_coordinate_path<cartesian_layout<>>;
clk_lyt layout = ...;
auto all_paths = enumerate_all_paths<path>(static_cast<cartesian_layout<>>(layout), {source, target});
```
``

Template parameter ``Path``:
Type of the returned individual paths.
Expand Down Expand Up @@ -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<cartesian_layout<>>;
using path = layout_coordinate_path<cartesian_layout<>>;
clk_lyt layout = ...;
auto shortest_path = jump_point_search<path>(static_cast<cartesian_layout<>>(layout), {source, target});
```
``

JPS was introduced in \"Online Graph Pruning for Pathfinding on Grid
Maps\" by Daniel Harabor and Alban Grastien in AAAI 2011.
Expand Down Expand Up @@ -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<cartesian_layout<>>;
using path = layout_coordinate_path<cartesian_layout<>>;
clk_lyt layout = ...;
auto k_paths = yen_k_shortest_paths<path>(static_cast<cartesian_layout<>>(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
Expand Down

0 comments on commit 9b6bfd9

Please sign in to comment.