33 Distributed under the terms of the GPL license version 3.
44
55 The full license is in the file LICENSE, distributed with this software.
6-
6+
77 This file was auto-generated from the template in docs/templates/api/transf.rst
88
99 DO NOT EDIT this file directly
@@ -21,11 +21,11 @@ internal classes. These internal types are optimised for the number of points
2121in the image of the specified {{LongNameNoCap}} with fewer points requiring less
2222space per point. If ``libsemigroups `` has been compiled with ``HPCombi ``
2323enabled, then the objects returned by :py:class: `{{Type}} ` use the SSE and AVX
24- instruction sets are used for very fast manipulation.
24+ instruction sets are used for very fast manipulation.
2525
2626While :py:class: `{{Type}} ` is not a class the objects returned by
2727:py:class: `{{Type}} ` have identical methods, and so we document
28- :py:class: `{{Type}} ` as if it was a class.
28+ :py:class: `{{Type}} ` as if it was a class.
2929
3030.. py :class :: {{Type}}
3131
@@ -37,7 +37,7 @@ While :py:class:`{{Type}}` is not a class the objects returned by
3737 as an array of the images :math:`\{(0)f,(1)f,\ldots,(n−1)f\}`.
3838
3939 .. py:method:: __eq__ (self : {{Type}}, that: {{Type}}) -> bool
40-
40+
4141 Equality comparison.
4242
4343 Returns `` True `` if `` self `` equals `` that`` by comparing their
@@ -47,16 +47,16 @@ While :py:class:`{{Type}}` is not a class the objects returned by
4747 :type that: {{Type}}
4848
4949 :returns: A `` bool `` .
50-
50+
5151 .. py:method:: __getitem__ (self : {{Type}}, i: int ) -> int
52-
52+
5353 Returns the image of `` i`` .
5454
5555 :param i: the value whose image is sought.
5656 :type i: int
5757
5858 :return : An `` int `` .
59-
59+
6060 .. py:method:: __lt__ (self : {{Type}}, that: {{Type}}) -> bool
6161
6262 Less than comparison.
@@ -68,16 +68,16 @@ While :py:class:`{{Type}}` is not a class the objects returned by
6868 :type that: {{Type}}
6969
7070 :returns: A `` bool `` .
71-
72- .. py:method:: __mul__ (self : {{Type}}, that: {{Type}}) -> {{Type}}
71+
72+ .. py:method:: __mul__ (self : {{Type}}, that: {{Type}}) -> {{Type}}
7373
7474 Right multiply `` self `` by `` that`` .
7575
7676 :param that: the {{LongNameNoCap}} to multiply with .
7777 :type that: {{Type}}
7878
7979 :returns: A :py:class :`{{Type}}` .
80-
80+
8181 .. py:method:: degree(self : {{Type}}) -> int
8282
8383 Returns the degree.
@@ -87,7 +87,7 @@ While :py:class:`{{Type}}` is not a class the objects returned by
8787
8888 :Parameters: `` None ``
8989 :return : An `` int `` .
90-
90+
9191 .. py:method:: identity(self : {{Type}}) -> int
9292
9393 Returns the identity {{LongNameNoCap}} on :py:meth:`degree` points.
@@ -111,7 +111,7 @@ While :py:class:`{{Type}}` is not a class the objects returned by
111111 :rtype: {{Type}}
112112
113113 :raises RuntimeError : if any value in `` l`` exceeds `` len (l)`` .
114-
114+
115115 .. py:staticmethod :: make_identity(M: int ) -> {{Type}}
116116
117117 Returns the identity {{LongNameNoCap}} on the given number of
@@ -120,9 +120,9 @@ While :py:class:`{{Type}}` is not a class the objects returned by
120120 :Parameters: ** M** (int ) - the degree.
121121
122122 :Returns: A value of type :py:class :`{{Type}}` .
123-
123+
124124 .. py:method:: product_inplace(self : {{Type}}, x: {{Type}}, y: {{Type}}) -> None
125-
125+
126126 Multiply two {{LongNameNoCap}}s and store the product in `` self `` .
127127
128128 :param x: a {{LongNameNoCap}}.
@@ -131,7 +131,7 @@ While :py:class:`{{Type}}` is not a class the objects returned by
131131 :type y: {{Type}}
132132
133133 :return : (None )
134-
134+
135135 .. py:method:: rank(self : {{Type}}) -> int
136136
137137 Returns the number of distinct image values.
@@ -141,14 +141,13 @@ While :py:class:`{{Type}}` is not a class the objects returned by
141141
142142 :Parameters: None
143143 :return : An `` int `` .
144-
144+
145145 .. py:method:: images(self : {{Type}}) -> Iterator
146146
147147 Returns an iterator pointing at the first image value.
148148
149149 :Parameters: None
150150 :return : An iterator.
151-
152151 {% if Type == " PPerm" or Type == " Perm" -% }
153152 .. py:method:: inverse(self : {{Type}}) -> {{Type}}
154153
@@ -157,9 +156,7 @@ While :py:class:`{{Type}}` is not a class the objects returned by
157156 :Parameters: None
158157 :Returns: A :py:class :`{{Type}}` .
159158 {% endif % }
160-
161159 {% if Type == " PPerm" -% }
162-
163160 .. py:staticmethod :: make(dom: List[int ], ran: List[int ], M: int ) -> {{Type}}
164161 :noindex:
165162
@@ -186,20 +183,19 @@ While :py:class:`{{Type}}` is not a class the objects returned by
186183
187184 :Parameters: None .
188185 :return : A `` {{Type}}`` .
189-
186+
190187 .. py:method:: right_one(self : {{Type}}) -> {{Type}}
191188
192189 Returns the right one of this.
193190
194191 :Parameters: None .
195192 :return : A `` {{Type}}`` .
196-
193+
197194 .. py:method:: undef(self : {{Type}}) -> int
198195
199196 Returns the integer value used to represent undefined.
200197
201198 :Parameters: None .
202199
203200 :Returns: An `` int `` .
204-
205201 {% endif % }
0 commit comments