mathverse_calculus/lib.rs
1//! Calculus: numerical differentiation, integration, vector calculus, ODEs, root finding.
2//!
3//! `mathverse-calculus` provides numerical methods for calculus operations,
4//! from elementary derivatives and integrals to vector calculus and ODE solvers.
5//!
6//! # Quick Start
7//!
8//! ```rust
9//! use mathverse_calculus::prelude::*;
10//!
11//! // Derivative of sin at 0 ≈ 1
12//! let d = derivative(&f64::sin, 0.0);
13//! assert!((d - 1.0).abs() < 1e-8);
14//!
15//! // Integral of sin from 0 to π ≈ 2
16//! let i = integrate(&f64::sin, 0.0, core::f64::consts::PI, 1e-10);
17//! assert!((i - 2.0).abs() < 1e-8);
18//!
19//! // Solve dy/dt = y, y(0) = 1 → y = e^t
20//! let sol = OdeProblem::new(&|_, y| y, (0.0, 1.0), 1.0).solve().unwrap();
21//! let y_final = sol.last().unwrap().1;
22//! assert!((y_final - 1.0_f64.exp()).abs() < 1e-6);
23//! ```
24//!
25//! # Modules
26//!
27//! | Module | Description |
28//! |---|---|
29//! | [`derivative`] | Numerical derivatives (central differences, partial, nth, discrete gradient) |
30//! | [`integrate`] | Numerical integration (trapezoid, Simpson, adaptive, Gaussian, Romberg, 2D) |
31//! | [`ode`] | ODE solvers (Euler, midpoint, RK4) with builder API |
32//! | [`root_finding`] | Root finding with auto-differentiation, plus re-exports from `mathverse-numerical` |
33//! | [`vector_calculus`] | Gradient, divergence, curl, Laplacian, Jacobian, Hessian |
34//!
35//! # Python parity
36//!
37//! | Rust function | `SciPy` equivalent |
38//! |---|---|
39//! | `nth_derivative` | `scipy.misc.derivative` |
40//! | `gaussian_quadrature` | `scipy.integrate.fixed_quad` |
41//! | `romberg` | `scipy.integrate.romberg` |
42//! | `integrate_2d` | `scipy.integrate.dblquad` |
43//! | `OdeProblem` | `scipy.integrate.solve_ivp` |
44//! | `discrete_gradient` | `numpy.gradient` |
45//!
46//! # Error Handling
47//!
48//! Fallible functions return [`MathResult<T>`] (an alias for `Result<T, MathError>`).
49//! See [`mathverse_core::error`] for the full error taxonomy.
50
51pub mod derivative;
52pub mod integrate;
53pub mod ode;
54pub mod root_finding;
55pub mod vector_calculus;
56
57/// Common imports for convenient use.
58pub mod prelude {
59 pub use mathverse_core::error::{MathError, MathResult};
60 pub use crate::derivative::{derivative, second_derivative, partial_derivative, nth_derivative, discrete_gradient};
61 pub use crate::integrate::{trapezoid, simpson, integrate, gaussian_quadrature, romberg, integrate_2d};
62 pub use crate::ode::{euler, midpoint, runge_kutta_4, runge_kutta_4_system, OdeProblem, OdeMethod};
63 pub use crate::root_finding::{newton_raphson_auto, find_critical_point};
64 pub use crate::vector_calculus::{gradient, divergence, curl, laplacian, jacobian, hessian, directional_derivative};
65}
66
67// Re-export commonly used items at crate root
68pub use derivative::{derivative, second_derivative, partial_derivative, nth_derivative, discrete_gradient};
69pub use integrate::{trapezoid, simpson, integrate, gaussian_quadrature, romberg, integrate_2d};
70pub use ode::{euler, midpoint, runge_kutta_4, runge_kutta_4_system, OdeProblem, OdeMethod};
71pub use root_finding::{newton_raphson_auto, find_critical_point};
72pub use vector_calculus::{gradient, divergence, curl, laplacian, jacobian, hessian, directional_derivative};