rebuilding site Wed 29 Mar 2023 17:23:13 BST

Author: james-d-mitchell

_sources/api/PPerm.rst.txt

@@ -3,7 +3,7 @@
    Distributed under the terms of the GPL license version 3.
 
    The full license is in the file LICENSE, distributed with this software.
-   
+
    This file was auto-generated from the template in docs/templates/api/transf.rst
 
    DO NOT EDIT this file directly
@@ -21,11 +21,11 @@ internal classes. These internal types are optimised for the number of points
 in the image of the specified partial perm with fewer points requiring less
 space per point.  If ``libsemigroups`` has been compiled with ``HPCombi``
 enabled, then the objects returned by :py:class:`PPerm` use the SSE and AVX
-instruction sets are used for very fast manipulation. 
+instruction sets are used for very fast manipulation.
 
 While :py:class:`PPerm` is not a class the objects returned by
 :py:class:`PPerm` have identical methods, and so we document
-:py:class:`PPerm` as if it was a class. 
+:py:class:`PPerm` as if it was a class.
 
 .. py:class:: PPerm
 
@@ -37,7 +37,7 @@ While :py:class:`PPerm` is not a class the objects returned by
       as an array of the images :math:`\{(0)f,(1)f,\ldots,(n−1)f\}`.
 
       .. py:method:: __eq__(self: PPerm, that: PPerm) -> bool
-        
+
           Equality comparison.
 
           Returns ``True`` if ``self`` equals ``that`` by comparing their
@@ -47,16 +47,16 @@ While :py:class:`PPerm` is not a class the objects returned by
           :type that: PPerm
 
           :returns: A ``bool``.
-      
+
       .. py:method:: __getitem__(self: PPerm, i: int) -> int
-        
+
             Returns the image of ``i``.
 
             :param i: the value whose image is sought.
             :type i: int
 
             :return: An ``int``.
-      
+
       .. py:method:: __lt__(self: PPerm, that: PPerm) -> bool
 
             Less than comparison.
@@ -68,16 +68,16 @@ While :py:class:`PPerm` is not a class the objects returned by
             :type that: PPerm
 
             :returns: A ``bool``.
-      
-      .. py:method:: __mul__(self: PPerm, that: PPerm) -> PPerm 
+
+      .. py:method:: __mul__(self: PPerm, that: PPerm) -> PPerm
 
             Right multiply ``self`` by ``that``.
 
             :param that: the partial perm to multiply with.
             :type that: PPerm
 
             :returns: A :py:class:`PPerm`.
-      
+
       .. py:method:: degree(self: PPerm) -> int
 
             Returns the degree.
@@ -87,7 +87,7 @@ While :py:class:`PPerm` is not a class the objects returned by
 
             :Parameters: ``None``
             :return: An ``int``.
-      
+
       .. py:method:: identity(self: PPerm) -> int
 
             Returns the identity partial perm on :py:meth:`degree` points.
@@ -111,7 +111,7 @@ While :py:class:`PPerm` is not a class the objects returned by
             :rtype: PPerm
 
             :raises RuntimeError: if any value in ``l`` exceeds ``len(l)``.
-       
+
       .. py:staticmethod:: make_identity(M: int) -> PPerm
 
             Returns the identity partial perm on the given number of
@@ -120,9 +120,9 @@ While :py:class:`PPerm` is not a class the objects returned by
             :Parameters: **M** (int) - the degree.
 
             :Returns: A value of type :py:class:`PPerm`.
-      
+
       .. py:method:: product_inplace(self: PPerm, x: PPerm, y: PPerm) -> None
-       
+
             Multiply two partial perms and store the product in ``self``.
 
             :param x: a partial perm.
@@ -131,7 +131,7 @@ While :py:class:`PPerm` is not a class the objects returned by
             :type y: PPerm
 
             :return: (None)
-            
+
       .. py:method:: rank(self: PPerm) -> int
 
             Returns the number of distinct image values.
@@ -141,21 +141,19 @@ While :py:class:`PPerm` is not a class the objects returned by
 
             :Parameters: None
             :return: An ``int``.
-      
+
       .. py:method:: images(self: PPerm) -> Iterator
 
             Returns an iterator pointing at the first image value.
 
             :Parameters: None
             :return: An iterator.
-
       .. py:method:: inverse(self: PPerm) -> PPerm
 
             Returns the inverse.
 
             :Parameters: None
             :Returns: A :py:class:`PPerm`.
-      
 
       .. py:staticmethod:: make(dom: List[int], ran: List[int], M: int) -> PPerm
             :noindex:
@@ -183,14 +181,14 @@ While :py:class:`PPerm` is not a class the objects returned by
 
             :Parameters: None.
             :return: A ``PPerm``.
-      
+
       .. py:method:: right_one(self: PPerm) -> PPerm
 
             Returns the right one of this.
 
             :Parameters: None.
             :return: A ``PPerm``.
-                 
+
       .. py:method:: undef(self: PPerm) -> int
 
             Returns the integer value used to represent undefined.
@@ -199,4 +197,3 @@ While :py:class:`PPerm` is not a class the objects returned by
 
             :Returns: An ``int``.
 
-      

_sources/api/Perm.rst.txt

@@ -3,7 +3,7 @@
    Distributed under the terms of the GPL license version 3.
 
    The full license is in the file LICENSE, distributed with this software.
-   
+
    This file was auto-generated from the template in docs/templates/api/transf.rst
 
    DO NOT EDIT this file directly
@@ -21,11 +21,11 @@ internal classes. These internal types are optimised for the number of points
 in the image of the specified permutation with fewer points requiring less
 space per point.  If ``libsemigroups`` has been compiled with ``HPCombi``
 enabled, then the objects returned by :py:class:`Perm` use the SSE and AVX
-instruction sets are used for very fast manipulation. 
+instruction sets are used for very fast manipulation.
 
 While :py:class:`Perm` is not a class the objects returned by
 :py:class:`Perm` have identical methods, and so we document
-:py:class:`Perm` as if it was a class. 
+:py:class:`Perm` as if it was a class.
 
 .. py:class:: Perm
 
@@ -37,7 +37,7 @@ While :py:class:`Perm` is not a class the objects returned by
       as an array of the images :math:`\{(0)f,(1)f,\ldots,(n−1)f\}`.
 
       .. py:method:: __eq__(self: Perm, that: Perm) -> bool
-        
+
           Equality comparison.
 
           Returns ``True`` if ``self`` equals ``that`` by comparing their
@@ -47,16 +47,16 @@ While :py:class:`Perm` is not a class the objects returned by
           :type that: Perm
 
           :returns: A ``bool``.
-      
+
       .. py:method:: __getitem__(self: Perm, i: int) -> int
-        
+
             Returns the image of ``i``.
 
             :param i: the value whose image is sought.
             :type i: int
 
             :return: An ``int``.
-      
+
       .. py:method:: __lt__(self: Perm, that: Perm) -> bool
 
             Less than comparison.
@@ -68,16 +68,16 @@ While :py:class:`Perm` is not a class the objects returned by
             :type that: Perm
 
             :returns: A ``bool``.
-      
-      .. py:method:: __mul__(self: Perm, that: Perm) -> Perm 
+
+      .. py:method:: __mul__(self: Perm, that: Perm) -> Perm
 
             Right multiply ``self`` by ``that``.
 
             :param that: the permutation to multiply with.
             :type that: Perm
 
             :returns: A :py:class:`Perm`.
-      
+
       .. py:method:: degree(self: Perm) -> int
 
             Returns the degree.
@@ -87,7 +87,7 @@ While :py:class:`Perm` is not a class the objects returned by
 
             :Parameters: ``None``
             :return: An ``int``.
-      
+
       .. py:method:: identity(self: Perm) -> int
 
             Returns the identity permutation on :py:meth:`degree` points.
@@ -111,7 +111,7 @@ While :py:class:`Perm` is not a class the objects returned by
             :rtype: Perm
 
             :raises RuntimeError: if any value in ``l`` exceeds ``len(l)``.
-       
+
       .. py:staticmethod:: make_identity(M: int) -> Perm
 
             Returns the identity permutation on the given number of
@@ -120,9 +120,9 @@ While :py:class:`Perm` is not a class the objects returned by
             :Parameters: **M** (int) - the degree.
 
             :Returns: A value of type :py:class:`Perm`.
-      
+
       .. py:method:: product_inplace(self: Perm, x: Perm, y: Perm) -> None
-       
+
             Multiply two permutations and store the product in ``self``.
 
             :param x: a permutation.
@@ -131,7 +131,7 @@ While :py:class:`Perm` is not a class the objects returned by
             :type y: Perm
 
             :return: (None)
-            
+
       .. py:method:: rank(self: Perm) -> int
 
             Returns the number of distinct image values.
@@ -141,20 +141,19 @@ While :py:class:`Perm` is not a class the objects returned by
 
             :Parameters: None
             :return: An ``int``.
-      
+
       .. py:method:: images(self: Perm) -> Iterator
 
             Returns an iterator pointing at the first image value.
 
             :Parameters: None
             :return: An iterator.
-
       .. py:method:: inverse(self: Perm) -> Perm
 
             Returns the inverse.
 
             :Parameters: None
             :Returns: A :py:class:`Perm`.
-      
 
-      
+
+