pymittagleffler

https://mittagleffler.readthedocs.io/en/latest/
Admin
Python bindings for a fast Rust implementation of the Mittag-Leffler function, commonly used in...
Tokens:1,925
Snippets:29
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install pymittagleffler from PyPI

Source: https://mittagleffler.readthedocs.io/en/latest/_sources/index.rst

Use this command to install the package directly from the Python Package Index.

```bash
python -m pip install pymittagleffler
```

--------------------------------

### Install pymittagleffler for Development

Source: https://mittagleffler.readthedocs.io/en/latest/index.html

For development, clone the repository and install the package in editable mode using maturin.

```bash
python -m pip install --verbose --no-build-isolation --editable .

```

--------------------------------

### Evaluate Mittag-Leffler Function (Example)

Source: https://mittagleffler.readthedocs.io/en/latest/index.html

Example demonstrating how to evaluate the Mittag-Leffler function for various complex arguments and parameters using the `mittag_leffler` function.

```APIDOC
import numpy as np

from pymittagleffler import mittag_leffler

alphas = (0.5, 1.0, 2.0)
betas = (1.0, 1.5, 2.0)

arg = np.pi / 2
r = np.linspace(0.0, 12.0, 256)
z = r * np.exp(1j * arg)

result = np.empty((len(alphas), z.size), dtype=z.dtype)
for i, (alpha, beta) in enumerate(zip(alphas, betas, strict=True)):
    result[i] = mittag_leffler(z, alpha, beta)
```

--------------------------------

### Install pymittagleffler in Editable Mode

Source: https://mittagleffler.readthedocs.io/en/latest/_sources/index.rst

Install the package in editable mode for development. This requires cloning the repository and navigating to the 'python' folder. Ensure build requirements are met.

```bash
python -m pip install --verbose --no-build-isolation --editable .
```

--------------------------------

### Evaluate Mittag-Leffler Function

Source: https://mittagleffler.readthedocs.io/en/latest/_sources/index.rst

Example demonstrating the evaluation of the Mittag-Leffler function for complex parameters. This snippet is extracted from a larger script.

```python
from pymittagleffler import mlf
import numpy as np

# Parameters for the Mittag-Leffler function
alpha = 0.5
beta = 1.0
z = np.linspace(-5, 5, 256) + 1j * np.linspace(-5, 5, 256)[:, np.newaxis]

# Evaluate the function
result = mlf(alpha, beta, z)

# Plotting (omitted for brevity, see images in documentation)
print(f"Shape of the result: {result.shape}")

```

--------------------------------

### Evaluate Mittag-Leffler Function in Python

Source: https://mittagleffler.readthedocs.io/en/latest/index.html

Demonstrates how to use the `mittag_leffler` function from the `pymittagleffler` library. This function accepts real and complex inputs, including scalars and NumPy arrays of any shape, applying the calculation component-wise.

```python
from pymittagleffler import mittag_leffler

z = np.linspace(0.0, 1.0) + 1j * np.linspace(0.0, 1.0)
ml = mittag_leffler(z, alpha=1.0, beta=2.0)
```

--------------------------------

### GarrappaMittagLeffler.evaluate()

Source: https://mittagleffler.readthedocs.io/en/latest/index.html

Evaluate the Mittag-Leffler function at a scalar argument `z` using the algorithm from Garrappa (2015). This method does not use special cases.

```APIDOC
class GarrappaMittagLeffler:
    def evaluate(self, z, alpha, beta)
```

--------------------------------

### pymittagleffler.mittag_leffler()

Source: https://mittagleffler.readthedocs.io/en/latest/index.html

Evaluate the Mittag-Leffler function with parameters `alpha` and `beta`. This function can handle scalar or numpy array inputs for `z`.

```APIDOC
def mittag_leffler(z, alpha, beta)
```
Tokens:
Raw