iter-solver 0.4.0

A rust crate provide flexible and general iterative algorithm framework.
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
41
42
43
44
45
46
47
48
49

# A General Iterative Algorithm Framework

iter-solver is a flexible and general iterative algorithm framework that allows users to customize iteration logic and termination conditions, providing a unified abstraction for different problems and algorithms.
# Example

The following program defines a simple Newton iterative solver to compute ln(1.5):
```rust
use iter_solver::Solver;

fn f_and_df(x: f64) -> (f64, f64) {
    let fx = x.exp() - 1.5;
    let dfx = x.exp();
    (fx, dfx) 
}

fn main() {
    let iter_fn = |state: f64, problem: &fn(f64) -> (f64, f64)| {
        let x_n = state;
        let (fx, dfx) = problem(x_n);
        x_n - (fx / dfx)
    };

    let term_cond = |state: &f64, problem: &fn(f64) -> (f64, f64)| {
        let (fx, _) = problem(*state);
        fx.abs() < 1e-6
    };

    let solver = Solver::new(iter_fn, term_cond);

    let solution = solver.solve(1.5, &(f_and_df as fn(f64) -> (f64, f64)));

    println!("solver's solution: {}", solution);
    println!("use std function ln: {}", 1.5_f64.ln());

    // solver's solution: 0.4054651081202111
    // use std function ln: 0.4054651081081644
}
```
# Installation

Add the following to your `Cargo.toml` dependencies:
```toml
[dependencies]
iter-solver = "0.4"
```
or add it directly from the terminal:
```bash
cargo add iter-solver
```

# License

[MIT License](https://github.com/Y-S-Xing/iter-solver/blob/main/LICENSE).