Merge branch 'main' into l_function_name

Author: oscarbenjamin

bin/all_rst_to_pxd.sh

@@ -0,0 +1,154 @@
+#!/usr/bin/env bash
+
+set -e
+
+if [ $# -eq 0 ]
+  then
+    echo "Usage: bin/all_rst_to_pxd.sh /path/to/flint/doc/source"
+    exit 1
+fi
+
+FLINT_DOC_DIR=$1
+
+modules=(
+    # "flint"
+    "mpoly"
+    # "thread_pool"
+    # "machine_vectors"
+    # "gr"
+    # "gr_domains"
+    # "gr_generic"
+    # "gr_implementing"
+    # "gr_mat"
+    # "gr_mpoly"
+    # "gr_poly"
+    # "gr_special"
+    # "gr_vec"
+    "ulong_extras"
+    "fmpz"
+    # "fmpz_extras"
+    "fmpz_factor"
+    "fmpz_lll"
+    "fmpz_mat"
+    "fmpz_mpoly"
+    "fmpz_mpoly_factor"
+    "fmpz_mpoly_q"
+    "fmpz_poly"
+    "fmpz_poly_factor"
+    # "fmpz_poly_mat"
+    # "fmpz_poly_q"
+    "fmpz_vec"
+    # "long_extras"
+    # "longlong"
+    # "mpn_extras"
+    # "aprcl"
+    "arith"
+    # "fft"
+    # "fft_small"
+    # "qsieve"
+    "fmpq"
+    "fmpq_mat"
+    "fmpq_mpoly"
+    "fmpq_mpoly_factor"
+    "fmpq_poly"
+    "fmpq_vec"
+    "nmod"
+    "nmod_mat"
+    "nmod_mpoly"
+    "nmod_mpoly_factor"
+    "nmod_poly"
+    "nmod_poly_factor"
+    # "nmod_poly_mat"
+    "nmod_vec"
+    # "mpn_mod"
+    "fmpz_mod"
+    "fmpz_mod_mat"
+    "fmpz_mod_mpoly"
+    "fmpz_mod_mpoly_factor"
+    "fmpz_mod_poly"
+    "fmpz_mod_poly_factor"
+    "fmpz_mod_vec"
+    "dirichlet"
+    # "dlog"
+    # "bool_mat"
+    # "perm"
+    # "qfb"
+    # "nf"
+    # "nf_elem"
+    # "fmpzi"
+    # "qqbar"
+    "mag"
+    # "nfloat"
+    "arf"
+    # "acf"
+    "arb"
+    # "arb_calc"
+    "arb_fmpz_poly"
+    # "arb_fpwrap"
+    "arb_hypgeom"
+    "arb_mat"
+    "arb_poly"
+    "acb"
+    "acb_calc"
+    "acb_dft"
+    "acb_dirichlet"
+    "acb_elliptic"
+    "acb_hypgeom"
+    "acb_mat"
+    "acb_modular"
+    "acb_poly"
+    "acb_theta"
+    "bernoulli"
+    # "hypgeom"
+    "partitions"
+    # "ca"
+    # "ca_ext"
+    # "ca_field"
+    # "ca_mat"
+    # "ca_poly"
+    # "ca_vec"
+    # "calcium"
+    # "fexpr"
+    # "fexpr_builtin"
+    "fq"
+    # "fq_embed"
+    "fq_mat"
+    "fq_poly"
+    "fq_poly_factor"
+    # "fq_vec"
+    "fq_nmod"
+    # "fq_nmod_embed"
+    "fq_nmod_mat"
+    # "fq_nmod_mpoly"
+    # "fq_nmod_mpoly_factor"
+    "fq_nmod_poly"
+    "fq_nmod_poly_factor"
+    # "fq_nmod_vec"
+    "fq_zech"
+    # "fq_zech_embed"
+    "fq_zech_mat"
+    "fq_zech_poly"
+    "fq_zech_poly_factor"
+    # "fq_zech_vec"
+    "fq_default"
+    "fq_default_mat"
+    "fq_default_poly"
+    "fq_default_poly_factor"
+    # "padic"
+    # "padic_mat"
+    # "padic_poly"
+    # "qadic"
+    # "double_extras"
+    # "double_interval"
+    # "d_mat"
+    # "d_vec"
+    # "mpfr_mat"
+    # "mpfr_vec"
+)
+
+for module in ${modules[@]}; do
+    echo "Processing $module"
+    bin/rst_to_pxd.py flint/$module \
+        --flint-doc-dir=$FLINT_DOC_DIR \
+        > src/flint/flintlib/functions/$module.pxd
+done

bin/rst_to_pxd.py

@@ -40,11 +40,16 @@
 #  recognize a function definition in rst
 is_func = re.compile(r"\.\.( )+(c:)?function( )*::")
 # rename types to avoid python -- c name collisions
-rename_types = [(re.compile(r"\bfmpz\b"),"fmpz_struct"),(re.compile(r"\bfmpq\b"), "fmpq_struct")]
+rename_types = [
+    (re.compile(r"\bfmpz\b"),"fmpz_struct"),
+    (re.compile(r"\bfmpq\b"), "fmpq_struct"),
+    (re.compile(r"\bin\b"), "in_"),
+    (re.compile(r"\blambda\b"), "lambda_"),
+]
 # comment out functions which use these types
 comment_types = re.compile(r"(\bFILE\b)|(\bmpz_t\b)|(\bmpq_t\b)")
 comment_set = set(["FILE", "mpz_t", "mpq_t"])
-c_types = set(["char", "short", "long", "int", "float", "double"])
+c_types = set(["void", "char", "short", "long", "int", "float", "double"])
 type_modifers = re.compile(r"\*|(\bconst\b)|(\bunsigned\b)|(\bsigned\b)")
 import_dict = {}
 
@@ -57,8 +62,14 @@ def get_cython_struct_types(file):
         l = line.strip()
         if l[:8] == "ctypedef":
             if l[-1] == ']':
+                # ctypedef foo foo_t[0]
                 l = l[:l.rfind('[')]
+            elif '(' in l:
+                # ctypedef int (*foo_func)(...)
+                l = l[l.index('('):].lstrip('(*')
+                l = l[:l.index(')')]
             else:
+                # ctypedef foo:
                 l = l.strip(':')
             ret.append(l.split()[-1])
     return ret
@@ -67,25 +78,30 @@ def fill_import_dict(pyflintlibdir):
     """
     Get a map from cython structs to the pxd that defines them
     """
-    with os.scandir(pyflintlibdir) as entry:
+    import_dict['fmpq_struct'] = 'types.fmpq'
+
+    with os.scandir(pyflintlibdir + '/types') as entry:
         for f in entry:
             if fnmatch.fnmatch(f.name, "*.pxd"):
                 with open(f.path) as pxd:
                     for t in get_cython_struct_types(pxd):
-                        import_dict[t] = f.name.split('.')[0]
+                        import_dict[t] = 'types.' + f.name.split('.')[0]
 
 def undecorate(str):
     """
     remove variable name, const, ``*``, etc. to just get types
     """
     ret = str.strip()
-    ret = ret[:ret.rfind(' ')]
-    ret = re.sub(type_modifers, '', ret)
-    return ret.strip()
+    if ' ' in ret:
+        ret = ret[:ret.rfind(' ')]
+    ret = re.sub(type_modifers, '', ret).strip()
+    return ret
 
 def get_parameter_types(str):
     params = str[str.find("(") + 1 : str.rfind(")")].split(",")
-    return [undecorate(s) for s in params]
+    ret_type = str.split('(')[0].rsplit(' ', 1)[0]
+    params.append(ret_type)
+    return [undecorate(s) for s in params if s]
 
 def clean_types(function):
     ret = function.strip()
@@ -98,8 +114,15 @@ def get_functions(file):
     Get a list of functions from an rst file
     """
     ret = []
+    macros = []
     in_list = False
     for line in file:
+        # Keep track of the macros
+        # We want to give them types in cython...
+        if line.startswith('.. macro'):
+            macros.append(line.strip())
+            continue
+
         m = is_func.match(line)
         if m:
             ret.append( clean_types(line[m.end():]))
@@ -110,7 +133,7 @@ def get_functions(file):
                     in_list = False
                 else:
                     ret.append(clean_types(line))
-    return ret
+    return ret, macros
 
 def get_all_types(function_list):
     ret = set()
@@ -119,6 +142,11 @@ def get_all_types(function_list):
             ret.add(t)
     return ret
 
+
+def has_types(line, types):
+    return any(t in types for t in get_parameter_types(line))
+
+
 def gen_imports(function_list):
     """
     Generate import statements for known functions.
@@ -132,10 +160,12 @@ def gen_imports(function_list):
             imports[import_dict[t]].append(t)
         else:
             ret.add(t)
-    for k,v in imports.items():
-        types = ", ".join(v)
+    for k,v in sorted(imports.items()):
+        types = ", ".join(sorted(v))
         print("from flint.flintlib." + k + " cimport " + types)
-    return ret
+    return sorted(ret)
+
+
 
 def generate_pxd_file(h_name, opts):
     fill_import_dict(opts.flint_lib_dir)
@@ -146,14 +176,18 @@ def generate_pxd_file(h_name, opts):
         docdir = opts.flint_doc_dir
         name = name[6:]
     with open(os.path.join(docdir, name + ".rst")) as f:
-        l = get_functions(f)
-        s = gen_imports(l)
+        l, macros = get_functions(f)
+        unknown_types = gen_imports(l)
+        print()
+        for t in unknown_types:
+            print("# unknown type " + t)
         print()
-        print ("\n# unimported types ", s - comment_set)
+        for m in macros:
+            print("# " + m)
         print()
         print(r'cdef extern from "' + h_name +r'.h":')
         for f in l:
-            if comment_types.search(f):
+            if has_types(f, unknown_types):
                 print("    # " + f)
             else:
                 print("    " + f)

doc/source/fmpq_mpoly.rst

@@ -0,0 +1,18 @@
+**fmpq_mpoly** -- multivariate polynomials over the rational numbers
+===============================================================================
+
+.. autoclass :: flint.fmpq_mpoly_ctx
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.fmpq_mpoly
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.fmpq_mpoly_vec
+  :members:
+  :inherited-members:
+  :undoc-members:
+

doc/source/fmpz_mod_mpoly.rst

@@ -0,0 +1,18 @@
+**fmpz_mod_mpoly** -- multivariate polynomials over the integers mod n
+===============================================================================
+
+.. autoclass :: flint.fmpz_mod_mpoly_ctx
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.fmpz_mod_mpoly
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.fmpz_mod_mpoly_vec
+  :members:
+  :inherited-members:
+  :undoc-members:
+

doc/source/fmpz_mpoly.rst

@@ -0,0 +1,18 @@
+**fmpz_mpoly** -- multivariate polynomials over the integers
+===============================================================================
+
+.. autoclass :: flint.fmpz_mpoly_ctx
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.fmpz_mpoly
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.fmpz_mpoly_vec
+  :members:
+  :inherited-members:
+  :undoc-members:
+

doc/source/index.rst

@@ -73,9 +73,13 @@ Polynomial types
    :maxdepth: 1
 
    fmpz_poly.rst
+   fmpz_mpoly.rst
    fmpq_poly.rst
+   fmpq_mpoly.rst
    nmod_poly.rst
+   nmod_mpoly.rst
    fmpz_mod_poly.rst
+   fmpz_mod_mpoly.rst
    fq_default_poly.rst
    arb_poly.rst
    acb_poly.rst

doc/source/nmod_mpoly.rst

@@ -0,0 +1,18 @@
+**nmod_mpoly** -- multivariate polynomials over the integers mod n (word-size n)
+===============================================================================
+
+.. autoclass :: flint.nmod_mpoly_ctx
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.nmod_mpoly
+  :members:
+  :inherited-members:
+  :undoc-members:
+
+.. autoclass :: flint.nmod_mpoly_vec
+  :members:
+  :inherited-members:
+  :undoc-members:
+