Skip to content

Some fixes in documentation #1655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 11, 2023
Merged

Some fixes in documentation #1655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1535993
remove extra ; in doc
videlec Dec 11, 2023
6f84704
remove deprecated fmpq_poly_scalar_mul_mpq from documentation
videlec Dec 11, 2023
e1ecaf6
add fmpq_poly_scalar_mul_fmpq in doc
videlec Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/fft_small.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Polynomial arithmetic
---------------------------------------------------------------------------------

.. function:: void _nmod_poly_mul_mid_mpn_ctx(ulong * z, ulong zl, ulong zh, const ulong * a, ulong an, const ulong * b, ulong bn, nmod_t mod, mpn_ctx_t R)
void _nmod_poly_mul_mid_default_mpn_ctx(z res, slong zl, slong zh, mp_srcptr a, slong an, mp_srcptr b, slong bn, nmod_t mod);
void _nmod_poly_mul_mid_default_mpn_ctx(mp_ptr res, slong zl, slong zh, mp_srcptr a, slong an, mp_srcptr b, slong bn, nmod_t mod)

Writes to ``z`` the middle product containing coefficients in the
range `[zl, zh)` of the product of the polynomials ``(a, an)`` and ``(b, bn)``,
Expand Down
12 changes: 3 additions & 9 deletions doc/source/fmpq_poly.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,11 +586,9 @@ Scalar multiplication and division
Supports aliasing of ``(rpoly, den)`` and ``(poly, den)``.
The ``fmpz_t``'s `r` and `s` may not be part of ``(rpoly, rden)``.

.. function:: void fmpq_poly_scalar_mul_si(fmpq_poly_t rop, const fmpq_poly_t op, slong c)

Sets ``rop`` to `c` times ``op``.

.. function:: void fmpq_poly_scalar_mul_ui(fmpq_poly_t rop, const fmpq_poly_t op, ulong c)
.. function:: void fmpq_poly_scalar_mul_fmpq(fmpq_poly_t rop, const fmpq_poly_t op, const fmpq_t c)
void fmpq_poly_scalar_mul_si(fmpq_poly_t rop, const fmpq_poly_t op, slong c)
void fmpq_poly_scalar_mul_ui(fmpq_poly_t rop, const fmpq_poly_t op, ulong c)

Sets ``rop`` to `c` times ``op``.

Expand All @@ -599,10 +597,6 @@ Scalar multiplication and division
Sets ``rop`` to `c` times ``op``. Assumes that the ``fmpz_t c``
is not part of ``rop``.

.. function:: void fmpq_poly_scalar_mul_mpq(fmpq_poly_t rop, const fmpq_poly_t op, const fmpq_t c)

Sets ``rop`` to `c` times ``op``.

.. function:: void _fmpq_poly_scalar_div_fmpz(fmpz * rpoly, fmpz_t rden, const fmpz * poly, const fmpz_t den, slong len, const fmpz_t c)

Sets ``(rpoly, rden, len)`` to ``(poly, den, len)`` divided by `c`,
Expand Down
2 changes: 1 addition & 1 deletion doc/source/gr_mat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ Arithmetic
.. function:: int gr_mat_sub(gr_mat_t res, const gr_mat_t mat1, const gr_mat_t mat2, gr_ctx_t ctx)

.. function:: int gr_mat_mul_classical(gr_mat_t res, const gr_mat_t mat1, const gr_mat_t mat2, gr_ctx_t ctx)
int gr_mat_mul_strassen(gr_mat_t C, const gr_mat_t A, const gr_mat_t B, gr_ctx_t ctx);
int gr_mat_mul_strassen(gr_mat_t C, const gr_mat_t A, const gr_mat_t B, gr_ctx_t ctx)
int gr_mat_mul_generic(gr_mat_t C, const gr_mat_t A, const gr_mat_t B, gr_ctx_t ctx)
int gr_mat_mul(gr_mat_t res, const gr_mat_t mat1, const gr_mat_t mat2, gr_ctx_t ctx)

Expand Down