Skip to main content

scirs2_core/api_reference/
mod.rs

1//! # SciRS2 API Reference
2//!
3//! Programmatic catalog of all major public APIs in the SciRS2 ecosystem,
4//! with mathematical references, usage examples, and cross-references.
5//!
6//! ## Usage
7//!
8//! ```rust
9//! use scirs2_core::api_reference::{api_catalog, search_api, by_crate, by_category, ApiCategory};
10//!
11//! // Browse full catalog
12//! let catalog = api_catalog();
13//! assert!(!catalog.is_empty());
14//!
15//! // Search by name
16//! let results = search_api("svd");
17//! assert!(!results.is_empty());
18//!
19//! // Filter by crate
20//! let linalg_apis = by_crate("scirs2-linalg");
21//! assert!(!linalg_apis.is_empty());
22//!
23//! // Filter by category
24//! let stats_apis = by_category(ApiCategory::Statistics);
25//! assert!(!stats_apis.is_empty());
26//! ```
27
28pub mod catalog;
29pub mod math_reference;
30
31pub use catalog::{api_catalog, by_category, by_crate, search_api, ApiCategory, ApiEntry};
32pub use math_reference::{math_references, MathReference};
33
34#[cfg(test)]
35mod tests;