TidalPy.utilities.math package

Submodules

TidalPy.utilities.math.complex module

Modified from https://github.com/numpy/numpy/blob/main/numpy/core/src/npymath/npy_math_complex.c.src */ /*==========================================================

Helper functions

These are necessary because we do not count on using a

C99 compiler.

=========================================================/

TidalPy.utilities.math.complex.cabs(z)

TidalPy.utilities.math.complex.cabs2(z)

TidalPy.utilities.math.complex.cexp(z)

TidalPy.utilities.math.complex.cinv(z)

TidalPy.utilities.math.complex.cipow(a, b)

TidalPy.utilities.math.complex.clog(z)

TidalPy.utilities.math.complex.cpow(a, b)

TidalPy.utilities.math.complex.csqrt(z)

TidalPy.utilities.math.complex.hypot(x, y)

TidalPy.utilities.math.complex.scaled_cexp(x, y, expt)

TidalPy.utilities.math.numba_special module

This module provides several special functions that are specifically designed to work with TidalPy and its dependencies (looking at you, Numba).

TidalPy.utilities.math.numba_special.sqrt_neg(z: NumArray, is_real: bool = False) → NumArray[source]

Square root - Allows for negative values

Parameters:: z (FloatArray) – Input value (domain is all positive and negative numbers)
Returns:: z_sqrt – Output value (range is all positive values and complex numbers)
Return type:: FloatArray

TidalPy.utilities.math.numerics module

TidalPy.utilities.math.numerics.isclose(a, b, rtol=1e-09, atol=0.0)

TidalPy.utilities.math.special module

TidalPy.utilities.math.special.double_factorial(n)