scirs2-sparse 0.4.2

Sparse matrix module for SciRS2 (scirs2-sparse)
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

//! Advanced block-level preconditioners for sparse linear systems
//!
//! This module provides preconditioners that operate on block structure,
//! complementing the scalar preconditioners in `crate::preconditioners`.
//!
//! # Available Preconditioners
//!
//! | Type | Module | Description |
//! |------|--------|-------------|
//! | [`BlockJacobiPreconditioner`] | [`block_jacobi`] | Block Jacobi — inverts diagonal blocks independently |
//! | [`BlockILU0`] | [`block_ilu`] | Block ILU(0) — incomplete LU on BSR block structure |
//!
//! # Quick Start
//!
//! ```rust
//! use scirs2_sparse::block_preconditioners::{BlockJacobiPreconditioner};
//!
//! let n = 4;
//! let indptr: Vec<usize> = (0..=n).collect();
//! let indices: Vec<usize> = (0..n).collect();
//! let data: Vec<f64> = vec![2.0, 4.0, 6.0, 8.0];
//!
//! let mut prec = BlockJacobiPreconditioner::<f64>::new(2).expect("new failed");
//! prec.setup(n, &indptr, &indices, &data).expect("setup failed");
//! let y = prec.apply(&[2.0, 4.0, 6.0, 8.0]).expect("apply failed");
//! ```

pub mod block_jacobi;
pub mod block_ilu;

pub use block_jacobi::BlockJacobiPreconditioner;
pub use block_ilu::{BlockILU0, apply_block_ilu};