bindings: auto-generate nmod_*

Author: oscarbenjamin

bin/all_rst_to_pxd.sh

@@ -71,13 +71,13 @@ modules=(
     #"fq_zech"
     "mag"
     #"mpoly"
-    #"nmod_mat"
+    "nmod_mat"
     #"nmod_mpoly_factor"
     #"nmod_mpoly"
-    #"nmod_poly_factor"
-    #"nmod_poly"
-    #"nmod"
-    #"nmod_vec"
+    "nmod_poly_factor"
+    "nmod_poly"
+    "nmod"
+    "nmod_vec"
     "partitions"
     "ulong_extras"
 )

pyproject.toml

@@ -59,7 +59,7 @@ build-backend = "mesonpy"
 #            resolved.
 max-line-length = 120
 ignore = ['E129','E501','E741','E743']
-exclude = 'src/flint/flintlib/.*'
+exclude = 'src/flint/flintlib/functions.*'
 
 [tool.spin]
 package = "flint"

src/flint/flintlib/functions/nmod.pxd

@@ -1,27 +1,34 @@
-from flint.flintlib.types.flint cimport mp_limb_t, mp_bitcnt_t, ulong, nmod_t
-from flint.flintlib.functions.fmpz cimport fmpz_t
+from flint.flintlib.types.flint cimport nmod_t, ulong
+from flint.flintlib.types.fmpz cimport fmpz_t
 
-cdef extern from "flint/nmod.h":
-# TODO add macros
+# unknown type nmod_discrete_log_pohlig_hellman_t
+
+# .. macro:: NMOD_BITS(mod)
+# .. macro:: NMOD_CAN_USE_SHOUP(mod)
+# .. macro:: NMOD_RED2(r, a_hi, a_lo, mod)
+# .. macro:: NMOD_RED(r, a, mod)
+# .. macro:: NMOD2_RED2(r, a_hi, a_lo, mod)
+# .. macro:: NMOD_RED3(r, a_hi, a_me, a_lo, mod)
+# .. macro:: NMOD_MUL_PRENORM(res, a, b, mod)
+# .. macro:: NMOD_MUL_FULLWORD(res, a, b, mod)
+# .. macro:: NMOD_ADDMUL(r, a, b, mod)
 
-# from here on is parsed
-    void nmod_init(nmod_t * mod, mp_limb_t n)
-    mp_limb_t _nmod_add(mp_limb_t a, mp_limb_t b, nmod_t mod)
-    mp_limb_t nmod_add(mp_limb_t a, mp_limb_t b, nmod_t mod)
-    mp_limb_t _nmod_sub(mp_limb_t a, mp_limb_t b, nmod_t mod)
-    mp_limb_t nmod_sub(mp_limb_t a, mp_limb_t b, nmod_t mod)
-    mp_limb_t nmod_neg(mp_limb_t a, nmod_t mod)
-    mp_limb_t nmod_mul(mp_limb_t a, mp_limb_t b, nmod_t mod)
-    mp_limb_t _nmod_mul_fullword(mp_limb_t a, mp_limb_t b, nmod_t mod)
-    mp_limb_t nmod_inv(mp_limb_t a, nmod_t mod)
-    mp_limb_t nmod_div(mp_limb_t a, mp_limb_t b, nmod_t mod)
-    mp_limb_t nmod_pow_ui(mp_limb_t a, ulong e, nmod_t mod)
-    mp_limb_t nmod_pow_fmpz(mp_limb_t a, const fmpz_t e, nmod_t mod)
+cdef extern from "flint/nmod.h":
+    void nmod_init(nmod_t * mod, ulong n)
+    ulong _nmod_add(ulong a, ulong b, nmod_t mod)
+    ulong nmod_add(ulong a, ulong b, nmod_t mod)
+    ulong _nmod_sub(ulong a, ulong b, nmod_t mod)
+    ulong nmod_sub(ulong a, ulong b, nmod_t mod)
+    ulong nmod_neg(ulong a, nmod_t mod)
+    ulong nmod_mul(ulong a, ulong b, nmod_t mod)
+    ulong _nmod_mul_fullword(ulong a, ulong b, nmod_t mod)
+    ulong nmod_inv(ulong a, nmod_t mod)
+    ulong nmod_div(ulong a, ulong b, nmod_t mod)
+    int nmod_divides(ulong * a, ulong b, ulong c, nmod_t mod)
+    ulong nmod_pow_ui(ulong a, ulong e, nmod_t mod)
+    ulong nmod_pow_fmpz(ulong a, const fmpz_t e, nmod_t mod)
     # void nmod_discrete_log_pohlig_hellman_init(nmod_discrete_log_pohlig_hellman_t L)
     # void nmod_discrete_log_pohlig_hellman_clear(nmod_discrete_log_pohlig_hellman_t L)
-    # double nmod_discrete_log_pohlig_hellman_precompute_prime(nmod_discrete_log_pohlig_hellman_t L, mp_limb_t p)
-    # mp_limb_t nmod_discrete_log_pohlig_hellman_primitive_root(const nmod_discrete_log_pohlig_hellman_t L)
-    # ulong nmod_discrete_log_pohlig_hellman_run(const nmod_discrete_log_pohlig_hellman_t L, mp_limb_t y)
-
-cdef extern from "flint/fmpz.h":
-    mp_limb_t fmpz_get_nmod(const fmpz_t f, nmod_t mod)
+    # double nmod_discrete_log_pohlig_hellman_precompute_prime(nmod_discrete_log_pohlig_hellman_t L, ulong p)
+    # ulong nmod_discrete_log_pohlig_hellman_primitive_root(const nmod_discrete_log_pohlig_hellman_t L)
+    # ulong nmod_discrete_log_pohlig_hellman_run(const nmod_discrete_log_pohlig_hellman_t L, ulong y)

src/flint/flintlib/functions/nmod_mat.pxd

@@ -1,58 +1,55 @@
-from flint.flintlib.types.flint cimport mp_limb_t, flint_rand_t, mp_ptr
-from flint.flintlib.types.flint cimport mp_srcptr, slong, ulong
-from flint.flintlib.functions.nmod cimport nmod_t
 from flint.flintlib.functions.nmod_poly cimport nmod_poly_t
-from flint.flintlib.functions.fmpz cimport fmpz_t
+from flint.flintlib.types.flint cimport flint_rand_t, nn_ptr, nn_srcptr, slong, ulong
+from flint.flintlib.types.fmpz cimport fmpz_t
+from flint.flintlib.types.nmod cimport nmod_mat_t
 
-cdef extern from "flint/nmod_mat.h":
-    ctypedef struct nmod_mat_struct:
-        mp_limb_t * entries
-        long r
-        long c
-        mp_limb_t ** rows
-        nmod_t mod
-    ctypedef nmod_mat_struct nmod_mat_t[1]
+# unknown type FILE
+# unknown type thread_pool_handle
+
+# .. macro:: nmod_mat_entry(mat, i, j)
 
-# from here on is parsed
-    void nmod_mat_init(nmod_mat_t mat, slong rows, slong cols, mp_limb_t n)
-    void nmod_mat_init_set(nmod_mat_t mat, nmod_mat_t src)
+cdef extern from "flint/nmod_mat.h":
+    void nmod_mat_init(nmod_mat_t mat, slong rows, slong cols, ulong n)
+    void nmod_mat_init_set(nmod_mat_t mat, const nmod_mat_t src)
     void nmod_mat_clear(nmod_mat_t mat)
-    void nmod_mat_set(nmod_mat_t mat, nmod_mat_t src)
+    void nmod_mat_set(nmod_mat_t mat, const nmod_mat_t src)
     void nmod_mat_swap(nmod_mat_t mat1, nmod_mat_t mat2)
     void nmod_mat_swap_entrywise(nmod_mat_t mat1, nmod_mat_t mat2)
-    mp_limb_t nmod_mat_entry(nmod_mat_t mat, long i, long j)
-    # MACRO nmod_mat_entry(nmod_mat_t mat, slong i, slong j)
-    mp_limb_t nmod_mat_get_entry(const nmod_mat_t mat, slong i, slong j)
-    mp_limb_t * nmod_mat_entry_ptr(const nmod_mat_t mat, slong i, slong j)
-    void nmod_mat_set_entry(nmod_mat_t mat, slong i, slong j, mp_limb_t x)
-    slong nmod_mat_nrows(nmod_mat_t mat)
-    slong nmod_mat_ncols(nmod_mat_t mat)
+    ulong nmod_mat_get_entry(const nmod_mat_t mat, slong i, slong j)
+    ulong * nmod_mat_entry_ptr(const nmod_mat_t mat, slong i, slong j)
+    void nmod_mat_set_entry(nmod_mat_t mat, slong i, slong j, ulong x)
+    slong nmod_mat_nrows(const nmod_mat_t mat)
+    slong nmod_mat_ncols(const nmod_mat_t mat)
     void nmod_mat_zero(nmod_mat_t mat)
-    int nmod_mat_is_zero(nmod_mat_t mat)
+    int nmod_mat_is_zero(const nmod_mat_t mat)
     void nmod_mat_window_init(nmod_mat_t window, const nmod_mat_t mat, slong r1, slong c1, slong r2, slong c2)
     void nmod_mat_window_clear(nmod_mat_t window)
     void nmod_mat_concat_vertical(nmod_mat_t res, const nmod_mat_t mat1, const nmod_mat_t mat2)
     void nmod_mat_concat_horizontal(nmod_mat_t res, const nmod_mat_t mat1, const nmod_mat_t mat2)
-    void nmod_mat_print_pretty(nmod_mat_t mat)
+    void nmod_mat_print_pretty(const nmod_mat_t mat)
+    # int nmod_mat_fprint_pretty(FILE * file, const nmod_mat_t mat)
+    int nmod_mat_print(const nmod_mat_t mat)
+    # int nmod_mat_fprint(FILE * f, const nmod_mat_t mat)
     void nmod_mat_randtest(nmod_mat_t mat, flint_rand_t state)
     void nmod_mat_randfull(nmod_mat_t mat, flint_rand_t state)
-    int nmod_mat_randpermdiag(nmod_mat_t mat, mp_limb_t * diag, slong n, flint_rand_t state)
-    void nmod_mat_randrank(nmod_mat_t mat, slong rank, flint_rand_t state)
-    void nmod_mat_randops(nmod_mat_t mat, slong count, flint_rand_t state)
+    int nmod_mat_randpermdiag(nmod_mat_t mat, flint_rand_t state, nn_srcptr diag, slong n)
+    void nmod_mat_randrank(nmod_mat_t mat, flint_rand_t state, slong rank)
+    void nmod_mat_randops(nmod_mat_t mat, flint_rand_t state, slong count)
     void nmod_mat_randtril(nmod_mat_t mat, flint_rand_t state, int unit)
     void nmod_mat_randtriu(nmod_mat_t mat, flint_rand_t state, int unit)
-    int nmod_mat_equal(nmod_mat_t mat1, nmod_mat_t mat2)
+    int nmod_mat_equal(const nmod_mat_t mat1, const nmod_mat_t mat2)
     int nmod_mat_is_zero_row(const nmod_mat_t mat, slong i)
-    void nmod_mat_transpose(nmod_mat_t B, nmod_mat_t A)
+    void nmod_mat_transpose(nmod_mat_t B, const nmod_mat_t A)
     void nmod_mat_swap_rows(nmod_mat_t mat, slong * perm, slong r, slong s)
     void nmod_mat_swap_cols(nmod_mat_t mat, slong * perm, slong r, slong s)
     void nmod_mat_invert_rows(nmod_mat_t mat, slong * perm)
     void nmod_mat_invert_cols(nmod_mat_t mat, slong * perm)
-    void nmod_mat_add(nmod_mat_t C, nmod_mat_t A, nmod_mat_t B)
-    void nmod_mat_sub(nmod_mat_t C, nmod_mat_t A, nmod_mat_t B)
-    void nmod_mat_neg(nmod_mat_t A, nmod_mat_t B)
-    void nmod_mat_scalar_mul(nmod_mat_t B, const nmod_mat_t A, mp_limb_t c)
-    void nmod_mat_scalar_addmul_ui(nmod_mat_t dest, const nmod_mat_t X, const nmod_mat_t Y, const mp_limb_t b)
+    void nmod_mat_permute_rows(nmod_mat_t mat, const slong * perm_act, slong * perm_store)
+    void nmod_mat_add(nmod_mat_t C, const nmod_mat_t A, const nmod_mat_t B)
+    void nmod_mat_sub(nmod_mat_t C, const nmod_mat_t A, const nmod_mat_t B)
+    void nmod_mat_neg(nmod_mat_t A, const nmod_mat_t B)
+    void nmod_mat_scalar_mul(nmod_mat_t B, const nmod_mat_t A, ulong c)
+    void nmod_mat_scalar_addmul_ui(nmod_mat_t dest, const nmod_mat_t X, const nmod_mat_t Y, const ulong b)
     void nmod_mat_scalar_mul_fmpz(nmod_mat_t res, const nmod_mat_t M, const fmpz_t c)
     void nmod_mat_mul(nmod_mat_t C, const nmod_mat_t A, const nmod_mat_t B)
     void _nmod_mat_mul_classical_op(nmod_mat_t D, const nmod_mat_t C, const nmod_mat_t A, const nmod_mat_t B, int op)
@@ -64,27 +61,27 @@ cdef extern from "flint/nmod_mat.h":
     int nmod_mat_mul_blas(nmod_mat_t C, const nmod_mat_t A, const nmod_mat_t B)
     void nmod_mat_addmul(nmod_mat_t D, const nmod_mat_t C, const nmod_mat_t A, const nmod_mat_t B)
     void nmod_mat_submul(nmod_mat_t D, const nmod_mat_t C, const nmod_mat_t A, const nmod_mat_t B)
-    void nmod_mat_mul_nmod_vec(mp_limb_t * c, const nmod_mat_t A, const mp_limb_t * b, slong blen)
-    void nmod_mat_mul_nmod_vec_ptr(mp_limb_t * const * c, const nmod_mat_t A, const mp_limb_t * const * b, slong blen)
-    void nmod_mat_nmod_vec_mul(mp_limb_t * c, const mp_limb_t * a, slong alen, const nmod_mat_t B)
-    void nmod_mat_nmod_vec_mul_ptr(mp_limb_t * const * c, const mp_limb_t * const * a, slong alen, const nmod_mat_t B)
+    void nmod_mat_mul_nmod_vec(ulong * c, const nmod_mat_t A, const ulong * b, slong blen)
+    void nmod_mat_mul_nmod_vec_ptr(ulong * const * c, const nmod_mat_t A, const ulong * const * b, slong blen)
+    void nmod_mat_nmod_vec_mul(ulong * c, const ulong * a, slong alen, const nmod_mat_t B)
+    void nmod_mat_nmod_vec_mul_ptr(ulong * const * c, const ulong * const * a, slong alen, const nmod_mat_t B)
     void _nmod_mat_pow(nmod_mat_t dest, const nmod_mat_t mat, ulong pow)
-    void nmod_mat_pow(nmod_mat_t dest, nmod_mat_t mat, ulong pow)
-    mp_limb_t nmod_mat_trace(const nmod_mat_t mat)
-    mp_limb_t nmod_mat_det_howell(const nmod_mat_t A)
-    mp_limb_t nmod_mat_det(const nmod_mat_t A)
+    void nmod_mat_pow(nmod_mat_t dest, const nmod_mat_t mat, ulong pow)
+    ulong nmod_mat_trace(const nmod_mat_t mat)
+    ulong nmod_mat_det_howell(const nmod_mat_t A)
+    ulong nmod_mat_det(const nmod_mat_t A)
     slong nmod_mat_rank(const nmod_mat_t A)
-    int nmod_mat_inv(nmod_mat_t B, nmod_mat_t A)
+    int nmod_mat_inv(nmod_mat_t B, const nmod_mat_t A)
     void nmod_mat_solve_tril(nmod_mat_t X, const nmod_mat_t L, const nmod_mat_t B, int unit)
     void nmod_mat_solve_tril_classical(nmod_mat_t X, const nmod_mat_t L, const nmod_mat_t B, int unit)
     void nmod_mat_solve_tril_recursive(nmod_mat_t X, const nmod_mat_t L, const nmod_mat_t B, int unit)
     void nmod_mat_solve_triu(nmod_mat_t X, const nmod_mat_t U, const nmod_mat_t B, int unit)
     void nmod_mat_solve_triu_classical(nmod_mat_t X, const nmod_mat_t U, const nmod_mat_t B, int unit)
     void nmod_mat_solve_triu_recursive(nmod_mat_t X, const nmod_mat_t U, const nmod_mat_t B, int unit)
-    int nmod_mat_solve(nmod_mat_t X, nmod_mat_t A, nmod_mat_t B)
+    int nmod_mat_solve(nmod_mat_t X, const nmod_mat_t A, const nmod_mat_t B)
     int nmod_mat_can_solve_inner(slong * rank, slong * perm, slong * pivots, nmod_mat_t X, const nmod_mat_t A, const nmod_mat_t B)
-    int nmod_mat_can_solve(nmod_mat_t X, nmod_mat_t A, nmod_mat_t B)
-    int nmod_mat_solve_vec(mp_limb_t * x, nmod_mat_t A, mp_limb_t * b)
+    int nmod_mat_can_solve(nmod_mat_t X, const nmod_mat_t A, const nmod_mat_t B)
+    int nmod_mat_solve_vec(nn_ptr x, const nmod_mat_t A, nn_srcptr b)
     slong nmod_mat_lu(slong * P, nmod_mat_t A, int rank_check)
     slong nmod_mat_lu_classical(slong * P, nmod_mat_t A, int rank_check)
     slong nmod_mat_lu_classical_delayed(slong * P, nmod_mat_t A, int rank_check)
@@ -99,5 +96,3 @@ cdef extern from "flint/nmod_mat.h":
     void nmod_mat_minpoly(nmod_poly_t p, const nmod_mat_t M)
     void nmod_mat_strong_echelon_form(nmod_mat_t A)
     slong nmod_mat_howell_form(nmod_mat_t A)
-    # not in doc
-    int nmod_mat_is_square(nmod_mat_t mat)