Skip to content

Commit

Permalink
Merge pull request #2051 from vneiger/minor_doc_fixes
Browse files Browse the repository at this point in the history
Minor doc fixes (one requires verification)
  • Loading branch information
vneiger committed Aug 23, 2024
2 parents 05340d2 + b020faf commit 338df24
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/source/fmpz_mod.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Arithmetic
--------------------------------------------------------------------------------

Unless specified otherwise all functions here expect their relevant arguments to be in the canonical range `[0,n)`.
Comparison of elements against each other or against zero can be accomplished with func::fmpz_equal or func::fmpz_is_zero without a context.
Comparison of elements against each other or against zero can be accomplished with :func:`fmpz_equal` or :func:`fmpz_is_zero` without a context.

.. function:: int fmpz_mod_is_canonical(const fmpz_t a, const fmpz_mod_ctx_t ctx)

Expand Down
2 changes: 1 addition & 1 deletion doc/source/fmpz_mod_poly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1909,7 +1909,7 @@ Berlekamp-Massey Algorithm

.. function:: const fmpz * fmpz_mod_berlekamp_massey_points(const fmpz_mod_berlekamp_massey_t B)

Return a pointer the array of points stored in ``B``. This may be ``NULL`` if func::fmpz_mod_berlekamp_massey_point_count returns ``0``.
Return a pointer the array of points stored in ``B``. This may be ``NULL`` if :func:`fmpz_mod_berlekamp_massey_point_count` returns ``0``.

.. function:: const fmpz_mod_poly_struct * fmpz_mod_berlekamp_massey_V_poly(const fmpz_mod_berlekamp_massey_t B)

Expand Down
5 changes: 3 additions & 2 deletions doc/source/longlong.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Division
.. macro:: udiv_qrnnd(q, r, n1, n0, d)

Computes the non-negative integers `q` and `r` in `d q + r = n_1 B + n_0`,
where `B = 2^{\mathtt{FLINT\_BITS}}`. Assumes that `d < n_1`.
where `B = 2^{\mathtt{FLINT\_BITS}}`. Assumes that `n_1 < d`.

.. macro:: sdiv_qrnnd(quotient, remainder, high_numerator, low_numerator, denominator)

Expand All @@ -89,4 +89,5 @@ Division
.. macro:: udiv_qrnnd_preinv(q, r, n1, n0, d, di)

Works like ``udiv_qrnnd``, but takes a precomputed inverse ``di`` as
computed by ::func::`n_preinvert_limb`.
computed by :func:`n_preinvert_limb_prenorm`. This function assumes ``d``
is normalised, i.e. with most significant bit set.

0 comments on commit 338df24

Please sign in to comment.