From 87091cfb1a14b95bfc9a5cd0387d679fd067ed47 Mon Sep 17 00:00:00 2001 From: Tomer Bauer Date: Fri, 3 Sep 2021 00:57:05 +0300 Subject: [PATCH] GBNP: remove periods from INPUT fields --- src/sage/algebras/gbnp.py | 56 +++++++++++++++++++-------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/src/sage/algebras/gbnp.py b/src/sage/algebras/gbnp.py index 6ef336279bb..b20438e14ca 100644 --- a/src/sage/algebras/gbnp.py +++ b/src/sage/algebras/gbnp.py @@ -224,9 +224,9 @@ def __init__(self, *args, **kwds): INPUT: - - ``ring`` -- the ring of the ideal. Should be a free algebra over some field. + - ``ring`` -- the ring of the ideal. Should be a free algebra over some field - - ``gens`` -- the generators of the ideal. + - ``gens`` -- the generators of the ideal EXAMPLES:: @@ -272,9 +272,9 @@ def groebner_basis(self, max_iters=10, strong=True): - ``max_iters`` (default: 10) -- the number of iterations for the Buchberger's Algorithm. If 0, the calculations will continue until it - terminates (but might not terminate at all). + terminates (but might not terminate at all) - - ``strong`` (default: ``True``) -- whether to compute a strong Groebner basis. + - ``strong`` (default: ``True``) -- whether to compute a strong Groebner basis OUTPUT: @@ -324,7 +324,7 @@ def is_groebner_basis(self, strong=True): INPUT: - - ``strong`` (default: ``True``) -- whether to check for a strong Groebner basis. + - ``strong`` (default: ``True``) -- whether to check for a strong Groebner basis OUTPUT: @@ -357,10 +357,10 @@ def reduce(self, elem, check=True): INPUT: - - ``elem`` -- an element of the free algebra. + - ``elem`` -- an element of the free algebra - ``check`` (default: ``True``) -- if ``True``, checks whether the given generators form a Groebner basis, and if not compute a new Groebner - basis (might not terminate!). + basis (might not terminate!) OUTPUT: @@ -407,9 +407,9 @@ def __init__(self, R, I, names=None, category=None): INPUT: - - ``R`` -- the cover ring. + - ``R`` -- the cover ring - - ``I`` -- the defining ideal of the quotient. + - ``I`` -- the defining ideal of the quotient EXAMPLES: @@ -452,12 +452,12 @@ def get_basis(self, maxno=0): INPUT: - ``maxno`` (default: 0) -- if nonzero, computes a basis until it has - at least this number of elements. + at least this number of elements OUTPUT: - A basis (or a partial set from the basis, if maxno is given) for the - quotient algebra. + A basis (or a partial set from the basis, if ``maxno`` is given) for + the quotient algebra. EXAMPLES: @@ -519,9 +519,9 @@ def get_matrix(self, gen_index, basis): INPUT: - - ``gen_index`` -- the index of the generator. + - ``gen_index`` -- the index of the generator - - ``basis`` -- a basis for the quotient algebra. + - ``basis`` -- a basis for the quotient algebra OUTPUT: @@ -573,7 +573,7 @@ def get_matrices(self, basis): INPUT: - - ``basis`` -- a basis for the quotient algebra. + - ``basis`` -- a basis for the quotient algebra OUTPUT: @@ -633,11 +633,11 @@ def reduce(self, elem, check=True): INPUT: - - ``elem`` -- an element of the free algebra. + - ``elem`` -- an element of the free algebra - ``check`` (default: ``True``) -- if ``True``, checks whether the generators form a Groebner basis, and if not compute a new Groebner - basis (might not terminate!). + basis (might not terminate!) OUTPUT: @@ -676,7 +676,7 @@ def get_leading_monomials(self, gap_obj=False): INPUT: - ``gap_obj`` (default: ``False``) -- if set to ``True``, returns the monomials - as GBNP objects. + as GBNP objects OUTPUT: @@ -705,7 +705,7 @@ def growth(self, exact=True): INPUT: - ``exact`` (default: ``True``) -- if set to ``False`` and the growth is - polynomial, returns a list of the possible degrees. + polynomial, returns a list of the possible degrees OUTPUT: @@ -806,7 +806,7 @@ def hilbert_series(self, deg): INPUT: - - ``deg`` -- The maximal degree to compute in the Hilbert series. + - ``deg`` -- The maximal degree to compute in the Hilbert series OUTPUT: @@ -835,9 +835,9 @@ def __init__(self, R, n=None, names=None): INPUT: - - ``R`` -- the base ring of the algebra. Should be a field. + - ``R`` -- the base ring of the algebra. Should be a field - - ``n`` (default: ``None``) -- the number of generators of the algebra. + - ``n`` (default: ``None``) -- the number of generators of the algebra If None, ``names`` must be given. - ``names`` (default: ``None``) -- the names for the generators of the @@ -872,17 +872,17 @@ def __init__(self, R, n=None, names=None): self._gap_algebra = libgap.FreeAssociativeAlgebraWithOne(libgap(self.base_ring()), self.variable_names()) - def ideal(self, *args, **kwds): + def ideal(self, *gens, **kwds): """ - Return the ideal defined by ``x``, i.e., generated by ``x``. + Return the ideal generated by the elements in ``gens``. INPUT: - - ``*x`` -- list or tuple of generators (or several input arguments). + - ``gens`` -- list or tuple of generators (or several input arguments) OUTPUT: - The ideal generated by ``*x``, implemented in GAP. + The ideal generated by ``gens``, implemented in GAP. EXAMPLES:: @@ -892,7 +892,7 @@ def ideal(self, *args, **kwds): sage: I # optional - gbnp Twosided Ideal (x*y - y*x, x^2) of Free Algebra on 2 generators (x, y) over Rational Field """ - I = super(FreeAlgebra_generic, self).ideal(*args, **kwds) + I = super(FreeAlgebra_generic, self).ideal(*gens, **kwds) return GapIdeal(self, I.gens()) def quotient(self, rels): @@ -901,7 +901,7 @@ def quotient(self, rels): INPUT: - - ``rels`` -- a list of the generators for the defining ideal of the quotient. + - ``rels`` -- a list of the generators for the defining ideal of the quotient OUTPUT: