_epsteinlib Namespace Reference

Functions
None	validate_inputs (Union[float, int] nu, NDArray[# pylint:disable=invalid-name Union[np.integer[Any], np.floating[Any]]] A, NDArray[Union[np.integer[Any], np.floating[Any]]] x, NDArray[Union[np.integer[Any], np.floating[Any]]] y)
tuple[ np.float64, int, NDArray[np.float64], NDArray[np.float64], NDArray[np.float64],]	prepare_inputs (Union[float, int] nu, NDArray[# pylint:disable=invalid-name Union[np.integer[Any], np.floating[Any]]] A, NDArray[Union[np.integer[Any], np.floating[Any]]] x, NDArray[Union[np.integer[Any], np.floating[Any]]] y)
complex	epstein_zeta_c_call (cython.double nu, cython.int dim, cython.double[::1] a, cython.double[::1] x, cython.double[::1] y)
complex	epstein_zeta (Union[float, int] nu, NDArray[# pylint:disable=invalid-name Union[np.integer[Any], np.floating[Any]]] A, NDArray[Union[np.integer[Any], np.floating[Any]]] x, NDArray[Union[np.integer[Any], np.floating[Any]]] y)
complex	epstein_zeta_reg_c_call (cython.double nu, cython.int dim, cython.double[::1] a, cython.double[::1] x, cython.double[::1] y)
complex	epstein_zeta_reg (Union[float, int] nu, NDArray[# pylint:disable=invalid-name Union[np.integer[Any], np.floating[Any]]] A, NDArray[Union[np.integer[Any], np.floating[Any]]] x, NDArray[Union[np.integer[Any], np.floating[Any]]] y)

Detailed Description

Python wrapper for the Epstein Zeta function

Function Documentation

epstein_zeta()

complex _epsteinlib.epstein_zeta	(	Union[float, int]	nu,
		NDArray[ # pylint: disable=invalid-name Union[np.integer[Any], np.floating[Any]] ]	A,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	x,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	y )

Calculate the Epstein zeta function.

epstein_zeta_c_call()

complex _epsteinlib.epstein_zeta_c_call	(	cython.double	nu,
		cython.int	dim,
		cython.double[::1]	a,
		cython.double[::1]	x,
		cython.double[::1]	y )

Call the C function to calculate the Epstein zeta function.

epstein_zeta_reg()

complex _epsteinlib.epstein_zeta_reg	(	Union[float, int]	nu,
		NDArray[ # pylint: disable=invalid-name Union[np.integer[Any], np.floating[Any]] ]	A,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	x,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	y )

Calculate the regularized Epstein zeta function.

epstein_zeta_reg_c_call()

complex _epsteinlib.epstein_zeta_reg_c_call	(	cython.double	nu,
		cython.int	dim,
		cython.double[::1]	a,
		cython.double[::1]	x,
		cython.double[::1]	y )

Call the C function to calculate the regularized Epstein zeta function.

prepare_inputs()

tuple[ np.float64, int, NDArray[np.float64], NDArray[np.float64], NDArray[np.float64], ] _epsteinlib.prepare_inputs	(	Union[float, int]	nu,
		NDArray[ # pylint: disable=invalid-name Union[np.integer[Any], np.floating[Any]] ]	A,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	x,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	y )

Prepare the inputs for the Epstein zeta function calculation.
Makes sure, the input arrays are C_CONTIGUOUS of type float64, see
https://numpy.org/doc/stable/reference/generated/numpy.ndarray.flags.html

validate_inputs()

None _epsteinlib.validate_inputs	(	Union[float, int]	nu,
		NDArray[ # pylint: disable=invalid-name Union[np.integer[Any], np.floating[Any]] ]	A,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	x,
		NDArray[Union[np.integer[Any], np.floating[Any]]]	y )

Validate the inputs for the Epstein zeta function calculation.

Raises:
TypeError: If x or y is not a 1D NumPy array,
or if nu is not a real number
ValueError: If x and y have different lengths,
or if A is not a 2D array with correct dimensions