Skip to content

Commit

Permalink
📝 fix small issue.
Browse files Browse the repository at this point in the history
  • Loading branch information
Drewniok committed Mar 25, 2024
1 parent 69f0afa commit 859b763
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
20 changes: 10 additions & 10 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 @@ -2827,13 +2827,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 @@ -6801,13 +6801,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 @@ -10541,13 +10541,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 @@ -14920,13 +14920,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
2 changes: 1 addition & 1 deletion docs/algorithms/one_pass_synthesis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ opportunity to generate even smaller layouts than ``exact``. Consequently, this
:members:
.. doxygenstruct:: fiction::one_pass_synthesis_stats
:members:
.. doxygenfunction:: fiction::one_pass_synthesis(const std::vector<TT>& tts, const one_pass_synthesis_params<Lyt>& ps = {}, one_pass_synthesis_stats* pst = nullptr)
.. doxygenfunction:: fiction::one_pass_synthesis(const std::vector<TT>& tts, one_pass_synthesis_params<Lyt>& ps = {}, one_pass_synthesis_stats* pst = nullptr)
.. doxygenfunction:: fiction::one_pass_synthesis(const Ntk& ntk, const one_pass_synthesis_params<Lyt>& ps = {}, one_pass_synthesis_stats* pst = nullptr)
18 changes: 9 additions & 9 deletions docs/algorithms/verification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Design Rule Violations (DRVs)
.. tab:: C++
**Header:** ``fiction/algorithms/verification/design_rule_violations.hpp``

.. doxygenstruct:: fiction::gate_level_drv_params
:members:
.. doxygenstruct:: fiction::gate_level_drv_stats
:members:
.. doxygenfunction:: fiction::gate_level_drvs
.. doxygenstruct:: fiction::gate_level_drv_params
:members:
.. doxygenstruct:: fiction::gate_level_drv_stats
:members:
.. doxygenfunction:: fiction::gate_level_drvs

.. tab:: Python
.. autoclass:: mnt.pyfiction.gate_level_drv_params
Expand All @@ -25,10 +25,10 @@ Equivalence Checking
.. tab:: C++
**Header:** ``fiction/algorithms/verification/equivalence_checking.hpp``

.. doxygenenum:: fiction::eq_type
.. doxygenstruct:: fiction::equivalence_checking_stats
:members:
.. doxygenfunction:: fiction::equivalence_checking
.. doxygenenum:: fiction::eq_type
.. doxygenstruct:: fiction::equivalence_checking_stats
:members:
.. doxygenfunction:: fiction::equivalence_checking

.. tab:: Python
.. autoclass:: mnt.pyfiction.eq_type
Expand Down

0 comments on commit 859b763

Please sign in to comment.