Trac #34468: fix W605 in all pyx files inside matroids/

this is about

W605 invalid escape sequence

namely, missing r prefix in some docstrings using latex code, mostly

URL: https://trac.sagemath.org/34468
Reported by: chapoton
Ticket author(s): Frédéric Chapoton
Reviewer(s): David Coudert

Author: Release Manager

src/sage/algebras/exterior_algebra_groebner.pyx

@@ -9,16 +9,16 @@ AUTHORS:
 - Trevor K. Karn, Travis Scrimshaw (July 2022): Initial implementation
 """
 
-#*****************************************************************************
+# ****************************************************************************
 #       Copyright (C) 2022 Trevor K. Karn <karnx018 at umn.edu>
 #                 (C) 2022 Travis Scrimshaw <tcscrims at gmail.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
-#                  http://www.gnu.org/licenses/
-#*****************************************************************************
+#                  https://www.gnu.org/licenses/
+# ****************************************************************************
 
 from cysignals.signals cimport sig_check
 from sage.libs.gmp.mpz cimport mpz_sizeinbase, mpz_setbit, mpz_tstbit, mpz_cmp_si, mpz_sgn
@@ -137,7 +137,7 @@ cdef class GroebnerStrategy:
         return self.int_to_bitset(max(self.bitset_to_int(k) for k in mc))
 
     cdef inline partial_S_poly_left(self, GBElement f, GBElement g):
-        """
+        r"""
         Compute one half of the `S`-polynomial for ``f`` and ``g``.
 
         This computes:
@@ -154,7 +154,7 @@ cdef class GroebnerStrategy:
         return ret
 
     cdef inline partial_S_poly_right(self, GBElement f, GBElement g):
-        """
+        r"""
         Compute one half of the `S`-polynomial for ``f`` and ``g``.
 
         This computes:

src/sage/matroids/basis_exchange_matroid.pyx

@@ -2115,7 +2115,7 @@ cdef class BasisExchangeMatroid(Matroid):
         return EQ[0]
 
     cpdef _is_isomorphism(self, other, morphism):
-        """
+        r"""
         Version of is_isomorphism() that does no type checking.
 
         INPUT:

src/sage/matroids/basis_matroid.pyx

@@ -1280,8 +1280,9 @@ cdef long set_to_index(bitset_t S):
         s = bitset_next(S, s + 1)
     return index
 
+
 cdef  index_to_set(bitset_t S, long index, long k, long n):
-    """
+    r"""
     Compute the k-subset of `\{0, ..., n-1\}` of rank index
     """
     bitset_clear(S)

src/sage/matroids/extension.pyx

@@ -248,7 +248,7 @@ cdef class LinearSubclassesIter:
 
 
 cdef class LinearSubclasses:
-    """
+    r"""
     An iterable set of linear subclasses of a matroid.
 
     Enumerate linear subclasses of a given matroid. A *linear subclass* is a
@@ -412,7 +412,7 @@ cdef class LinearSubclasses:
 
 
 cdef class MatroidExtensions(LinearSubclasses):
-    """
+    r"""
     An iterable set of single-element extensions of a given matroid.
 
     INPUT:

src/sage/matroids/linear_matroid.pyx

@@ -761,7 +761,7 @@ cdef class LinearMatroid(BasisExchangeMatroid):
         return {e: R[self._idx[e]] for e in self.groundset()}
 
     cpdef LeanMatrix _reduced_representation(self, B=None):
-        """
+        r"""
         Return a reduced representation of the matroid, i.e. a matrix `R` such
         that `[I\ \ R]` represents the matroid.
 
@@ -800,7 +800,7 @@ cdef class LinearMatroid(BasisExchangeMatroid):
     # (field) isomorphism
 
     cpdef bint _is_field_isomorphism(self, LinearMatroid other, morphism):  # not safe if self == other
-        """
+        r"""
         Version of :meth:`<LinearMatroid.is_field_isomorphism>` that does no
         type checking.
 
@@ -966,7 +966,7 @@ cdef class LinearMatroid(BasisExchangeMatroid):
         return self._is_field_isomorphism(other, morphism)
 
     cpdef is_field_isomorphism(self, other, morphism):
-        """
+        r"""
         Test if a provided morphism induces a bijection between represented
         matroids.
 
@@ -1322,7 +1322,7 @@ cdef class LinearMatroid(BasisExchangeMatroid):
         return type(self)(reduced_matrix=M, groundset=rows + cols)
 
     cpdef dual(self):
-        """
+        r"""
         Return the dual of the matroid.
 
         Let `M` be a matroid with ground set `E`. If `B` is the set of bases
@@ -1354,7 +1354,7 @@ cdef class LinearMatroid(BasisExchangeMatroid):
         return type(self)(reduced_matrix=R, groundset=cols + rows)
 
     cpdef has_line_minor(self, k, hyperlines=None, certificate=False):
-        """
+        r"""
         Test if the matroid has a `U_{2, k}`-minor.
 
         The matroid `U_{2, k}` is a matroid on `k` elements in which every
@@ -3130,7 +3130,7 @@ cdef class BinaryMatroid(LinearMatroid):
         self._one = GF2_one
 
     cpdef base_ring(self):
-        """
+        r"""
         Return the base ring of the matrix representing the matroid,
         in this case `\GF{2}`.
 
@@ -3308,7 +3308,7 @@ cdef class BinaryMatroid(LinearMatroid):
         return self._A.copy()   # Deprecated Sage matrix operation
 
     cpdef LeanMatrix _reduced_representation(self, B=None):
-        """
+        r"""
         Return a reduced representation of the matroid, i.e. a matrix `R` such
         that `[I\ \ R]` represents the matroid.
 
@@ -4197,7 +4197,7 @@ cdef class TernaryMatroid(LinearMatroid):
         self._two = GF3_minus_one
 
     cpdef base_ring(self):
-        """
+        r"""
         Return the base ring of the matrix representing the matroid, in this
         case `\GF{3}`.
 
@@ -4381,7 +4381,7 @@ cdef class TernaryMatroid(LinearMatroid):
         return self._A.copy()   # Deprecated Sage matrix operation
 
     cpdef LeanMatrix _reduced_representation(self, B=None):
-        """
+        r"""
         Return a reduced representation of the matroid, i.e. a matrix `R`
         such that `[I\ \ R]` represents the matroid.
 
@@ -4563,7 +4563,7 @@ cdef class TernaryMatroid(LinearMatroid):
         return self._t_invariant
 
     cpdef bicycle_dimension(self):
-        """
+        r"""
         Return the bicycle dimension of the ternary matroid.
 
         The bicycle dimension of a linear subspace `V` is
@@ -5096,7 +5096,7 @@ cdef class QuaternaryMatroid(LinearMatroid):
         self._x_one = (<QuaternaryMatrix>self._A)._x_one
 
     cpdef base_ring(self):
-        """
+        r"""
         Return the base ring of the matrix representing the matroid, in this
         case `\GF{4}`.
 
@@ -5273,7 +5273,7 @@ cdef class QuaternaryMatroid(LinearMatroid):
         return self._A.copy()   # Deprecated Sage matrix operation
 
     cpdef LeanMatrix _reduced_representation(self, B=None):
-        """
+        r"""
         Return a reduced representation of the matroid, i.e. a matrix `R` such
         that `[I\ \ R]` represents the matroid.
 
@@ -5413,7 +5413,7 @@ cdef class QuaternaryMatroid(LinearMatroid):
         return self._q_invariant
 
     cpdef bicycle_dimension(self):
-        """
+        r"""
         Return the bicycle dimension of the quaternary matroid.
 
         The bicycle dimension of a linear subspace `V` is
@@ -5810,7 +5810,7 @@ cdef class RegularMatroid(LinearMatroid):
         return P
 
     cpdef base_ring(self):
-        """
+        r"""
         Return the base ring of the matrix representing the matroid, in this
         case `\ZZ`.
 
@@ -6230,7 +6230,7 @@ cdef class RegularMatroid(LinearMatroid):
             return {e:idx[m[str(e)]] for e in self.groundset() if str(e) in m}
 
     cpdef has_line_minor(self, k, hyperlines=None, certificate=False):
-        """
+        r"""
         Test if the matroid has a `U_{2, k}`-minor.
 
         The matroid `U_{2, k}` is a matroid on `k` elements in which every

src/sage/matroids/matroid.pyx

@@ -3150,7 +3150,7 @@ cdef class Matroid(SageObject):
         return Polyhedron(vertices)
 
     def independence_matroid_polytope(self):
-        """
+        r"""
         Return the independence matroid polytope of ``self``.
 
         This is defined as the convex hull of the vertices
@@ -3430,7 +3430,7 @@ cdef class Matroid(SageObject):
         return self._is_isomorphism(other, morphism)
 
     cpdef is_isomorphism(self, other, morphism):
-        """
+        r"""
         Test if a provided morphism induces a matroid isomorphism.
 
         A *morphism* is a map from the groundset of ``self`` to the groundset
@@ -3553,7 +3553,7 @@ cdef class Matroid(SageObject):
         return self._is_isomorphism(other, mf)
 
     cpdef _is_isomorphism(self, other, morphism):
-        """
+        r"""
         Version of is_isomorphism() that does no type checking.
 
         INPUT:
@@ -3942,7 +3942,7 @@ cdef class Matroid(SageObject):
         return self.delete(X)
 
     cpdef dual(self):
-        """
+        r"""
         Return the dual of the matroid.
 
         Let `M` be a matroid with ground set `E`. If `B` is the set of bases
@@ -4054,7 +4054,7 @@ cdef class Matroid(SageObject):
         return self._has_minor(N, certificate)
 
     cpdef has_line_minor(self, k, hyperlines=None, certificate=False):
-        """
+        r"""
         Test if the matroid has a `U_{2, k}`-minor.
 
         The matroid `U_{2, k}` is a matroid on `k` elements in which every
@@ -4125,7 +4125,7 @@ cdef class Matroid(SageObject):
         return self._has_line_minor(k, hyperlines, certificate)
 
     cpdef _has_line_minor(self, k, hyperlines, certificate=False):
-        """
+        r"""
         Test if the matroid has a `U_{2, k}`-minor.
 
         Internal version that does no input checking.
@@ -4313,7 +4313,7 @@ cdef class Matroid(SageObject):
         return self.dual().extension(element, subsets).dual()
 
     cpdef modular_cut(self, subsets):
-        """
+        r"""
         Compute the modular cut generated by ``subsets``.
 
         A *modular cut* is a collection `C` of flats such that
@@ -4403,7 +4403,7 @@ cdef class Matroid(SageObject):
         return final_list
 
     cpdef linear_subclasses(self, line_length=None, subsets=None):
-        """
+        r"""
         Return an iterable set of linear subclasses of the matroid.
 
         A *linear subclass* is a set of hyperplanes (i.e. closed sets of rank
@@ -4714,7 +4714,7 @@ cdef class Matroid(SageObject):
         return True
 
     cpdef is_cosimple(self):
-        """
+        r"""
         Test if the matroid is cosimple.
 
         A matroid is *cosimple* if it contains no cocircuits of length 1 or 2.
@@ -4791,7 +4791,7 @@ cdef class Matroid(SageObject):
         return components
 
     cpdef is_connected(self, certificate=False):
-        """
+        r"""
         Test if the matroid is connected.
 
         A *separation* in a matroid is a partition `(X, Y)` of the
@@ -7480,7 +7480,7 @@ cdef class Matroid(SageObject):
         return A
 
     cpdef tutte_polynomial(self, x=None, y=None):
-        """
+        r"""
         Return the Tutte polynomial of the matroid.
 
         The *Tutte polynomial* of a matroid is the polynomial

src/sage/modules/free_module_element.pyx

@@ -3743,7 +3743,7 @@ cdef class FreeModuleElement(Vector):   # abstract base class
         from sage.misc.latex import latex
         vector_delimiters = latex.vector_delimiters()
         s = '\\left' + vector_delimiters[0]
-        s += ',\,'.join(latex(a) for a in self.list())
+        s += r',\,'.join(latex(a) for a in self.list())
         return s + '\\right' + vector_delimiters[1]
 
     def dense_vector(self):