Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/bmat8.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ Returns the identity :any:`BMat8` of a given dimension.
This function returns the :any:`BMat8` with the first *dim* entries in the
main diagonal equal to ``1`` and every other value equal to ``0``.

:param dim: the dimension of the identity (default: 8)
:param dim: the dimension of the identity (default: ``8``)
:type dim: int

:returns: A :any:`BMat8`.
Expand Down
4 changes: 2 additions & 2 deletions src/knuth-bendix-impl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Return the number of pending rules that must accumulate before they are reduced,
processed, and added to the system.

The default value is ``128``. A value of ``1`` means :any:`Runner.run` should
attempt to add each rule as they are created without waiting for rules to
attempt to add each rule as it is created without waiting for rules to
accumulate.

:return: The batch size.
Expand All @@ -145,7 +145,7 @@ Specify the number of pending rules that must accumulate before they are
reduced, processed, and added to the system.

The default value is ``128``, and should be set to ``1`` if :any:`Runner.run`
should attempt to add each rule as they are created without waiting for rules
should attempt to add each rule as it is created without waiting for rules
to accumulate.

:param val: The new value of the batch size.
Expand Down
3 changes: 2 additions & 1 deletion src/runner.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,8 @@ has been called since construction or the last call to :any:`init`.
R"pbdoc(
Initialize an existing Runner object.

This function puts a :any:`Runner` object back into the same state as if it had been newly default constructed.
This function puts a :any:`Runner` object back into the same state as if it had
been newly default constructed.

:returns: ``self``.
:rtype: Runner
Expand Down
34 changes: 18 additions & 16 deletions src/todd-coxeter-impl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ phase of the `ACE <https://staff.itee.uq.edu.au/havas/>`_ style
If the strategy is not one of those listed above, then this setting is
ignored.

The default value of this setting is ``100000``.
The default value of this setting is ``10 ** 5``.

:returns:
The current value of the setting.
Expand Down Expand Up @@ -488,15 +488,15 @@ style strategies:
If the strategy is not one of those listed above, then this setting is
ignored.

The default value of this setting is ``100'000``.
The default value of this setting is ``10 ** 5``.

:param val: the value to use.
:type val: int

:returns: ``self``.
:rtype: ToddCoxeter

:raises LibsemigroupsError: if ``val`` is ``0``.
:raises LibsemigroupsError: if *val* is ``0``.
)pbdoc");

thing.def(
Expand All @@ -518,7 +518,7 @@ the `ACE <https://staff.itee.uq.edu.au/havas/>`_ style strategies:
If the strategy is not one of those listed above, then this setting is
ignored.

The default value of this setting is ``100000``.
The default value of this setting is ``10 ** 5``.

:returns:
The current value of the setting.
Expand Down Expand Up @@ -549,15 +549,15 @@ style strategies:

If the strategy is not one of those listed above, then this setting is ignored.

The default value of this setting is ``200000``.
The default value of this setting is ``2 * 10 ** 5``.

:param val: the value to use.
:type val: int

:returns: ``self``.
:rtype: ToddCoxeter

:raises LibsemigroupsError: if ``val`` is ``0``.
:raises LibsemigroupsError: if *val* is ``0``.

)pbdoc");

Expand All @@ -571,7 +571,7 @@ Get the current size of a large collapse. This function can be used to
get what is currently considered a "large" collapse. See
:any:`large_collapse` for the meaning of this setting.

The default value of this setting is ``100'000``.
The default value of this setting is ``10 ** 5``.

:returns:
The current value of the setting.
Expand Down Expand Up @@ -686,7 +686,7 @@ a lookahead grows. More specifically, at the end of any lookahead if the number
of active nodes already exceeds the value of :any:`lookahead_next` or the
number of nodes killed during the lookahead is less than the number of active
nodes divided by :any:`lookahead_growth_threshold`, then the value of
:any:`lookahead_next` is increased by a multiple of ``val``. The default value
:any:`lookahead_next` is increased by a multiple of *val*. The default value
is of this setting is ``2.0``.

:param val: the value indicating the lookahead growth factor.
Expand All @@ -695,7 +695,7 @@ is of this setting is ``2.0``.
:returns: ``self``.
:rtype: ToddCoxeter

:raises LibsemigroupsError: if ``val`` is less than ``1.0``.
:raises LibsemigroupsError: if *val* is less than ``1.0``.
)pbdoc");
thing.def(
"lookahead_growth_threshold",
Expand Down Expand Up @@ -747,7 +747,7 @@ active nodes divided by :any:`lookahead_growth_threshold`, then the value of
Get the current value of the minimum lookahead setting. This function
returns the current value of the minimum lookahead. See
:any:`lookahead_min` for a full description of this setting. The
default value is ``10000``.
default value is ``10 ** 4``.

:returns:
The current value of the minimum lookahead.
Expand All @@ -770,7 +770,7 @@ depending on the outcome of the current lookahead. If the return value of
:any:`lookahead_next` is too small or too large, then the value is adjusted
according to :any:`lookahead_growth_factor` and
:any:`lookahead_growth_threshold`. This setting specified the minimum possible
value for :any:`lookahead_next()`. The default value is ``10000``.
value for :any:`lookahead_next()`. The default value is ``10 ** 4``.

:param val: value indicating the minimum value of lookahead_next.
:type val: int
Expand Down Expand Up @@ -807,8 +807,8 @@ Set the threshold that will trigger a lookahead.

If the number of active nodes exceeds the value set by this function, then a
lookahead of style :any:`ToddCoxeter.lookahead_style` and extent
:any:`ToddCoxeter.lookahead_extent` will be triggered. The default value is 5
million.
:any:`ToddCoxeter.lookahead_extent` will be triggered. The default value is
``5 * 10 ** 6``.

:param val: value indicating the initial threshold.
:type val: int
Expand Down Expand Up @@ -909,7 +909,7 @@ result in many nodes being killed).
:rtype: ToddCoxeter

:raises LibsemigroupsError:
if ``val`` is not in the interval :math:`[0, 1)`.
if *val* is not in the interval :math:`[0, 1)`.
)pbdoc");
thing.def(
"lookahead_style",
Expand Down Expand Up @@ -1199,12 +1199,14 @@ has been standardized with respect to the any :any:`Order` other than
Check if the word graph is currently standardized with respect to a given order.

This function returns ``True`` if the :any:`current_word_graph` has been
standardized with respect to the order ``val`` ; and ``False`` if not.
standardized with respect to the order *val* ; and ``False`` if not.

:param val: the Order to check for.
:type val: Order

:returns: Whether or not the current word graph is standardized with respect to a given order.
:returns:
Whether or not the current word graph is standardized with respect to
a given order.
:rtype: bool
)pbdoc");

Expand Down
11 changes: 8 additions & 3 deletions src/ukkonen.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -653,13 +653,18 @@ The index of one past the last letter in the edge leading to the node.
R"pbdoc(
Construct a node from left most index, right most index, and parent.

:param l: the left most index and value of the data member l (defaults to ``0``).
:param l:
the left most index and value of the data member *l* (defaults to ``0``).
:type l: int

:param r: one after the right most index and value of the data member r (defaults to ``0``).
:param r:
one after the right most index and value of the data member *r*
(defaults to ``0``).
:type r: int

:param parent: parent of the node being constructed (defaults to :any:`UNDEFINED`).
:param parent:
parent of the node being constructed (defaults to
:any:`UNDEFINED`).
:type parent: int
)pbdoc");
node.def("__copy__",
Expand Down