numrs2 0.2.0

A Rust implementation inspired by NumPy for numerical computing (NumRS2)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

//! Optimization operations for Python bindings

use crate::python::array::PyArray;
use pyo3::exceptions::PyValueError;
use pyo3::prelude::*;

/// Minimize a scalar function using BFGS algorithm
#[pyfunction]
fn minimize(
    _fun: PyObject,
    _x0: &PyArray,
    _method: Option<String>,
    _tol: Option<f64>,
) -> PyResult<PyObject> {
    Err(PyValueError::new_err(
        "minimize function not yet implemented - see NumRS2 Rust API for optimization",
    ))
}

/// Find roots of a scalar function
#[pyfunction]
fn root_scalar(_fun: PyObject, _bracket: (f64, f64), _method: Option<String>) -> PyResult<f64> {
    Err(PyValueError::new_err(
        "root_scalar function not yet implemented - see NumRS2 Rust API for root finding",
    ))
}

/// Register optimization functions
pub fn register(m: &Bound<'_, PyModule>) -> PyResult<()> {
    // Create optimize submodule
    let optimize_module = PyModule::new(m.py(), "optimize")?;

    // Add functions
    optimize_module.add_function(wrap_pyfunction!(minimize, m)?)?;
    optimize_module.add_function(wrap_pyfunction!(root_scalar, m)?)?;

    m.add_submodule(&optimize_module)?;

    Ok(())
}