Skip to main content

Module api_reference

Module api_reference 

Source
Expand description

§SciRS2 API Reference

Programmatic catalog of all major public APIs in the SciRS2 ecosystem, with mathematical references, usage examples, and cross-references.

§Usage

use scirs2_core::api_reference::{api_catalog, search_api, by_crate, by_category, ApiCategory};

// Browse full catalog
let catalog = api_catalog();
assert!(!catalog.is_empty());

// Search by name
let results = search_api("svd");
assert!(!results.is_empty());

// Filter by crate
let linalg_apis = by_crate("scirs2-linalg");
assert!(!linalg_apis.is_empty());

// Filter by category
let stats_apis = by_category(ApiCategory::Statistics);
assert!(!stats_apis.is_empty());

Re-exports§

pub use catalog::api_catalog;
pub use catalog::by_category;
pub use catalog::by_crate;
pub use catalog::search_api;
pub use catalog::ApiCategory;
pub use catalog::ApiEntry;
pub use math_reference::math_references;
pub use math_reference::MathReference;

Modules§

catalog
Programmatic API catalog for the SciRS2 ecosystem.
math_reference
Mathematical reference for key algorithms used throughout SciRS2.