documentation

doc/source/acb_theta.rst

@@ -0,0 +1,5 @@
+**acb_theta** -- Riemann theta functions
+===============================================================================
+
+.. autofunction :: flint.types.acb_theta.acb_theta
+

doc/source/index.rst

@@ -61,6 +61,7 @@ Matrix types
    fmpz_mod_mat.rst
    arb_mat.rst
    acb_mat.rst
+   acb_theta.rst
 
 Polynomial types
 ................

src/flint/types/acb_mat.pyx

@@ -818,15 +818,18 @@ cdef class acb_mat(flint_mat):
     def theta(tau, z, square=False):
         r"""
         Computes the vector valued Riemann theta function
-        `(\theta_{a,b}{z, tau) : a, b \in \{0,1\}^{g}\)` or its squares.
-        This is a wrapper for the C-function `acb_theta_all` and it follows the
-        same conventions for the ordering of the theta characteristics.
+        `(\theta_{a,b}(z, \tau) : a, b \in \{0,1\}^{g})` or its squares,
+        where `\tau` is given by ``self``.
+
+        This is a wrapper for :func:`.acb_theta.acb_theta`; see the
+        documentation for that method for details and examples.
+        This follows the same conventions of the C-function
+        `acb_theta_all <https://flintlib.org/doc/acb_theta.html#c.acb_theta_all>`_
+        for the ordering of the theta characteristics.
 
-        This is a wrapper for :meth:`.acb_theta.acb_mat_theta`; see the
-        documentation for that method for details for examples.
         """
         try:
-            from .acb_theta import acb_mat_theta
+            from .acb_theta import acb_theta
         except ImportError:
             raise NotImplementedError("acb_mat.theta needs Flint >= 3.1.0")
-        return acb_mat_theta(z, tau, square=square)
+        return acb_theta(z, tau, square=square)

src/flint/types/acb_theta.pyx

@@ -5,12 +5,16 @@ from flint.flintlib.acb cimport *
 from flint.flintlib.acb_mat cimport *
 from flint.flintlib.acb_theta cimport *
 
-def acb_mat_theta(acb_mat z, acb_mat tau, ulong square=False):
+def acb_theta(acb_mat z, acb_mat tau, ulong square=False):
     r"""
-    Computes the vector valued Riemann theta function `(\theta_{a,b}{z, tau) : a, b \in \{0,1\}^{g}\)` or its squares.
-    This is a wrapper for the function `acb_theta_all` and it follows the same conventions for the ordering of the theta characteristics.
+    Computes the vector valued Riemann theta function
+    `(\theta_{a,b}(z, \tau) : a, b \in \{0,1\}^{g})` or its squares.
 
-    This should be used via method `acb_mat.theta` with the order of `z` and `tau` swapped,
+    This is a wrapper for the C-function
+    `acb_theta_all <https://flintlib.org/doc/acb_theta.html#c.acb_theta_all>`_
+    and it follows the same conventions for the ordering of the theta characteristics.
+
+    This should be used via the method :meth:`.acb_mat.theta`, explicitly ``tau.theta(z)``.
 
         >>> from flint import acb, acb_mat, showgood
         >>> z = acb(1+1j); tau = acb(1.25+3j)