Skip to content

Commit e3e2db8

Browse files
committed
Add missing documentation in MPolynomialRing_base class
1 parent 9f90540 commit e3e2db8

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

src/sage/rings/polynomial/multi_polynomial_ring_base.pyx

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -868,6 +868,21 @@ cdef class MPolynomialRing_base(CommutativeRing):
868868
return False
869869

870870
def term_order(self):
871+
"""
872+
Return the term order of ``self``.
873+
874+
OUTPUT: a :class:`sage.rings.polynomial.term_order.TermOrder` of the
875+
variables of ``self``.
876+
877+
EXAMPLES::
878+
879+
sage: R.<x,y,z> = PolynomialRing(ZZ, 3)
880+
sage: R.term_order()
881+
Degree reverse lexicographic term order
882+
sage: S.<t,u> = PolynomialRing(QQ, 2, order='lex')
883+
sage: S.term_order()
884+
Lexicographic term order
885+
"""
871886
return self._term_order
872887

873888
def characteristic(self):
@@ -886,6 +901,28 @@ cdef class MPolynomialRing_base(CommutativeRing):
886901
return self.base_ring().characteristic()
887902

888903
def gen(self, n=0):
904+
"""
905+
Return the ``n``-th indeterminate generator of ``self``.
906+
907+
INPUT:
908+
909+
- ``n`` -- integer (default: ``0``) number of the generator
910+
911+
EXAMPLES::
912+
913+
sage: R = ZZ['x,y,z']
914+
sage: x = R.gen()
915+
sage: x
916+
x
917+
sage: parent(x)
918+
Multivariate Polynomial Ring in x, y, z over Integer Ring
919+
sage: R.gen(2)
920+
z
921+
sage: R.gen(23)
922+
Traceback (most recent call last):
923+
...
924+
ValueError: Generator not defined.
925+
"""
889926
if n < 0 or n >= self._ngens:
890927
raise ValueError("generator not defined")
891928
return self._gens[int(n)]
@@ -943,9 +980,30 @@ cdef class MPolynomialRing_base(CommutativeRing):
943980
return self.base_ring()
944981

945982
def krull_dimension(self):
983+
"""
984+
Return the Krull dimension of ``self``.
985+
986+
EXAMPLES::
987+
988+
sage: R = ZZ['t,u']
989+
sage: R.krull_dimension()
990+
3
991+
sage: S = QQ['x,y']
992+
sage: S.krull_dimension()
993+
2
994+
"""
946995
return self.base_ring().krull_dimension() + self.ngens()
947996

948997
def ngens(self):
998+
"""
999+
Return the number of indeterminate generators of ``self``.
1000+
1001+
EXAMPLES::
1002+
1003+
sage: R = RR['x,y']
1004+
sage: R.ngens()
1005+
2
1006+
"""
9491007
return self._ngens
9501008

9511009
def _monomial_order_function(self):

0 commit comments

Comments
 (0)