Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
Clarify docs for polynomial()
Browse files Browse the repository at this point in the history
  • Loading branch information
jdemeyer committed Oct 28, 2014
1 parent 5028e10 commit 0d9b5cc
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions src/sage/rings/finite_rings/finite_field_base.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,10 @@ cdef class FiniteField(Field):
coefficients in the base field that has `a` as a root. In
finite field extensions, `\GF{p^n}`, the base field is `\GF{p}`.
OUTPUT:
- a monic polynomial over `\GF{p}` in the variable `x`.
EXAMPLES::
sage: F.<a> = GF(7^2); F
Expand Down Expand Up @@ -829,9 +833,22 @@ cdef class FiniteField(Field):

def polynomial(self, name=None):
"""
Return the irreducible characteristic polynomial of the
generator of this finite field, i.e., the polynomial `f(x)` so
elements of the finite field as elements modulo `f`.
Return the minimal polynomial of the generator of ``self`` over
the prime finite field.
INPUT:
- ``name`` -- a variable name to use for the polynomial. By
default, use the name given when constructing this field.
OUTPUT:
- a monic polynomial over `\GF{p}` in the variable ``name``.
.. SEEALSO::
Except for the ``name`` argument, this is identical to the
:meth:`modulus` method.
EXAMPLES::
Expand Down

0 comments on commit 0d9b5cc

Please sign in to comment.