Skip to content

Commit 5be6d94

Browse files
james-d-mitchellJoseph-Edwards
authored andcommitted
doc: remove "vector"
1 parent 1df8f10 commit 5be6d94

5 files changed

Lines changed: 16 additions & 18 deletions

File tree

src/bipart.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ transverse and those consisting of positive values are not.
9595
:raises LibsemigroupsError: if the constructed :any:`Blocks` object is not valid.
9696
9797
:complexity:
98-
linear in the sum of the sizes of the vectors in blocks.
98+
linear in the sum of the sizes of the lists in blocks.
9999
)pbdoc");
100100

101101
thing.def(

src/pbr.cpp

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ Construct empty PBR of given degree.
6161
Construct from adjacencies ``1`` to ``n`` and ``-1`` to ``-n``.
6262
6363
Construct from adjacencies ``1`` to ``n`` and ``-1`` to ``-n``. The parameters
64-
*left* and *right* should be containers of ``n`` vectors of integer values,
65-
so that the vector in position ``i`` of *left* is the list of points
66-
adjacent to ``i`` in the :any:`PBR`, and the vector in position ``i`` of
67-
*right* is the list of points adjacent to ``n + i`` in the :any:`PBR`.
68-
A negative value ``i`` corresponds to ``n - i``.
64+
*left* and *right* should be containers of ``n`` lists of integer values, so
65+
that the list in position ``i`` of *left* is the list of points adjacent to
66+
``i`` in the :any:`PBR`, and the list in position ``i`` of *right* is the
67+
list of points adjacent to ``n + i`` in the :any:`PBR`. A negative value ``i``
68+
corresponds to ``n - i``.
6969
7070
:param left: container of adjacencies of ``1`` to ``n``
7171
:type left: list[list[int]]
@@ -85,11 +85,11 @@ A negative value ``i`` corresponds to ``n - i``.
8585
Construct from adjacencies ``0`` to ``2n - 1``.
8686
8787
Construct from adjacencies ``0`` to ``2n - 1``. The parameter *x* must be a
88-
container of vectors of ``int`` with size ``2n`` for some integer ``n``,
89-
and the vector in position ``i`` is the list of points adjacent to ``i``
88+
container of lists of ``int`` with size ``2n`` for some integer ``n``,
89+
and the list in position ``i`` is the list of points adjacent to ``i``
9090
in the :any:`PBR` constructed.
9191
92-
:param x: the container of vectors of adjacencies.
92+
:param x: the container of lists of adjacencies.
9393
:type x: list[list[int]]
9494
9595
:raises LibsemigroupsError: if the resultant PBR:

src/present.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This class can be used to construction presentations for semigroups or monoids
6060
and is intended to be used as the input to other algorithms in
6161
``libsemigroups_pybind11``. The idea is to provide a shallow wrapper around a
6262
collection of words of type :ref:`Word<pseudo_word_type_class>`. We refer to
63-
this vector of words as the *rules* of the presentation. The :any:`Presentation`
63+
this list of words as the *rules* of the presentation. The :any:`Presentation`
6464
class also provides some checks that the rules really define a presentation,
6565
(i.e. it's consistent with its alphabet), and some related functionality is
6666
available in the module :any:`libsemigroups_pybind11.presentation`.)pbdoc");
@@ -605,7 +605,7 @@ Change or re-order the alphabet.
605605
This function replaces ``p.alphabet()`` with ``new_alphabet``, where possible,
606606
and re-writes the rules in the presentation using the new alphabet.
607607
608-
:param p: the presentation .
608+
:param p: the presentation.
609609
:type p: Presentation
610610
611611
:param new_alphabet: the replacement alphabet.
@@ -991,7 +991,7 @@ If *existing* and *replacement* are words, then this function replaces every
991991
non-overlapping instance of *existing* in every rule by *replacement*. The
992992
presentation *p* is changed in-place.
993993
994-
:param p: the presentation .
994+
:param p: the presentation.
995995
:type p: Presentation
996996
997997
:param existing: the word to be replaced.

src/presentation-examples.cpp

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1717,13 +1717,11 @@ least congruence containing the relation :math:`a^{\sigma(a)} = a` for each
17171717
resultant :math:`\sigma`-plactic monoid is known as the stylic monoid,
17181718
and is given in :any:`stylic_monoid`.
17191719
1720-
:param sigma: a vector representing the image of :math:`\sigma`.
1721-
:type sigma: list
1720+
:param sigma: a list representing the image of :math:`\sigma`.
1721+
:type sigma: list[int]
17221722
17231723
:returns: The specified presentation.
17241724
:rtype: Presentation
1725-
1726-
:raises LibsemigroupsError: if ``n < 1``.
17271725
)pbdoc");
17281726
m.def("presentation_examples_zero_rook_monoid",
17291727
&examples::zero_rook_monoid,

src/transf.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -653,7 +653,7 @@ Class for representing permutations on up to ``2 ** 32`` points.
653653
654654
A *permutation* :math:`f` is an injective transformation defined on the whole
655655
of :math:`\{0, 1, \ldots, n - 1\}` for some integer :math:`n` called the
656-
*degree* of :math:`f`. A permutation is stored as a vector of the images of
656+
*degree* of :math:`f`. A permutation is stored as a list of the images of
657657
:math:`(0, 1, \ldots, n - 1)`, i.e. :math:`((0)f, (1)f, \ldots, (n - 1)f)`.
658658
659659
Permutations are optimised for the number of points in the image with
@@ -718,7 +718,7 @@ fewer points requiring less space per point.
718718
m.def("transf_inverse",
719719
py::overload_cast<Perm_ const&>(&inverse<N, Scalar>));
720720
} // bind_perm
721-
} // namespace
721+
} // namespace
722722

723723
void init_transf(py::module& m) {
724724
// Transformations

0 commit comments

Comments
 (0)