Skip to content

Commit 38b6ce1

Browse files
committed
change docstrings for the type stuff
1 parent ee4ae24 commit 38b6ce1

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

src/flint/types/fq_default.pyx

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ cdef class fq_default_ctx:
2525
>>> fq_default_ctx(modulus=mod, fq_type='FQ_NMOD')
2626
fq_default_ctx(11, 2, 'x', x^2 + 1, 'FQ_NMOD')
2727
28-
For more details, see the documentation of :method:`~.set_from_order`
29-
and :method:`~.set_from_modulus`.
28+
For more details, see the documentation of :method:`~._set_from_order`
29+
and :method:`~._set_from_modulus`.
3030
"""
3131
def __cinit__(self):
3232
pass
@@ -124,13 +124,8 @@ cdef class fq_default_ctx:
124124
125125
`var` is a name for the ring generator of this field over GF(p).
126126
127-
The optional parameter `type` select the implementation. The
128-
possible values are:
129-
130-
- `fq_default_ctx.DEFAULT`: implementation automatically decided by Flint (default),
131-
- `fq_default_ctx.FQ_ZECH`: Use `fq_zech_t`,
132-
- `fq_default_ctx.FQ_NMOD`: Use `fq_nmod_t`,
133-
- `fq_default_ctx.FQ`: Use `fq_t`.
127+
The optional parameter `type` select the implementation. For more
128+
information about the types available, see :method:`~.fq_type`.
134129
"""
135130
# c_from_order expects the characteristic to be fmpz type
136131
prime = any_as_fmpz(p)
@@ -169,13 +164,8 @@ cdef class fq_default_ctx:
169164
170165
`var` is a name for the ring generator of this field over the prime field.
171166
172-
The optional parameter `type` select the implementation. The
173-
possible values are:
174-
175-
- `fq_default_ctx.DEFAULT`: implementation automatically decided by Flint (default),
176-
- `fq_default_ctx.FQ_ZECH`: Use `fq_zech_t`,
177-
- `fq_default_ctx.FQ_NMOD`: Use `fq_nmod_t`,
178-
- `fq_default_ctx.FQ`: Use `fq_t`.
167+
The optional parameter `type` select the implementation. For more
168+
information about the types available, see :method:`~.fq_type`.
179169
"""
180170
if check_modulus and not modulus.is_irreducible():
181171
raise ValueError("modulus must be irreducible")
@@ -188,9 +178,14 @@ cdef class fq_default_ctx:
188178
"""
189179
Return the implementation of this context. It is one of:
190180
191-
- 1: `fq_default_ctx.FQ_ZECH`: Using `fq_zech_t`,
192-
- 2: `fq_default_ctx.FQ_NMOD`: Using `fq_nmod_t`,
193-
- 3: `fq_default_ctx.FQ`: Using `fq_t`.
181+
- 1. `fq_default_ctx.FQ_ZECH`: Use `fq_zech_t`,
182+
- 2. `fq_default_ctx.FQ_NMOD`: Use `fq_nmod_t`,
183+
- 3. `fq_default_ctx.FQ`: Use `fq_t`.
184+
- 4. `fq_default_ctx.NMOD`: Use `nmod` for degree = 1,
185+
- 5. `fq_default_ctx.FMPZ_MOD`: Use `fmpz_mod` for degree = 1.
186+
187+
These can be manually selected, or type: `fq_default_ctx.DEFAULT` can be used
188+
for the implementation to be automatically decided by Flint (default),
194189
"""
195190
return fq_default_type(fq_default_ctx_type(self.val))
196191

0 commit comments

Comments
 (0)