Skip to content

Commit bbb9a09

Browse files
📝 Documenation fix related to bdl_input_iterator (#691)
* 📝 Reordered enumeration to match the `enum class` value order * 📝 Added missing Python classes to the `bdl_input_iterator` RST documentation * 📝 Update pyfiction docstrings Signed-off-by: GitHub Actions <[email protected]> --------- Signed-off-by: GitHub Actions <[email protected]> Co-authored-by: GitHub Actions <[email protected]>
1 parent 15b53ec commit bbb9a09

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

bindings/mnt/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp

+7-6
Original file line numberDiff line numberDiff line change
@@ -787,12 +787,13 @@ R"doc(This enum defines how BDL inputs are manipulated within the algorithm.
787787
According to existing literature, there are two main approaches for
788788
handling BDL inputs:
789789

790-
1. A perturber is used to set the input to `1`, while the absence of a
791-
perturber represents a `0` (as described in
792-
https://ieeexplore.ieee.org/abstract/document/8963859). 2. An input of
793-
`1` is generated by placing a perturber closer to the target, whereas
794-
a `0` is produced by positioning the perturber farther away (as
795-
described in https://dl.acm.org/doi/10.1145/3489517.3530525).)doc";
790+
1. Distance Encoding, in which an input of `1` is generated by placing
791+
a perturber closer to the target, whereas a `0` is produced by
792+
positioning the perturber farther away (as described in
793+
https://dl.acm.org/doi/10.1145/3489517.3530525). 2. Absence Encoding,
794+
in which a perturber is used to set the input to `1`, while the
795+
absence of a perturber represents a `0` (as described in
796+
https://ieeexplore.ieee.org/abstract/document/8963859).)doc";
796797

797798
static const char *__doc_fiction_bdl_input_iterator_params_input_bdl_configuration_PERTURBER_ABSENCE_ENCODED =
798799
R"doc(A perturber is used to set the input to `1`, while the absence of a

docs/algorithms/iterators.rst

+4
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ BDL Input Iterator
2929
:members:
3030

3131
.. tab:: Python
32+
.. autoclass:: mnt.pyfiction.input_bdl_configuration
33+
:members:
34+
.. autoclass:: mnt.pyfiction.bdl_input_iterator_params
35+
:members:
3236
.. autoclass:: mnt.pyfiction.bdl_input_iterator_100
3337
:members:
3438
.. autoclass:: mnt.pyfiction.bdl_input_iterator_111

include/fiction/algorithms/iter/bdl_input_iterator.hpp

+5-4
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ struct bdl_input_iterator_params
2727
* This enum defines how BDL inputs are manipulated within the algorithm.
2828
* According to existing literature, there are two main approaches for handling BDL inputs:
2929
*
30-
* 1. A perturber is used to set the input to `1`, while the absence of a perturber represents a `0`
31-
* (as described in https://ieeexplore.ieee.org/abstract/document/8963859).
32-
* 2. An input of `1` is generated by placing a perturber closer to the target, whereas a `0` is produced
33-
* by positioning the perturber farther away (as described in https://dl.acm.org/doi/10.1145/3489517.3530525).
30+
* 1. Distance Encoding, in which an input of `1` is generated by placing a perturber closer to the target, whereas
31+
* a `0` is produced by positioning the perturber farther away (as described in
32+
* https://dl.acm.org/doi/10.1145/3489517.3530525).
33+
* 2. Absence Encoding, in which a perturber is used to set the input to `1`, while the absence of a perturber
34+
* represents a `0` (as described in https://ieeexplore.ieee.org/abstract/document/8963859).
3435
*/
3536
enum class input_bdl_configuration : uint8_t
3637
{

0 commit comments

Comments
 (0)