mathru 0.16.2

Fundamental algorithms for scientific computing in Rust
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
50
51
52
53
54
55
56
57
58
59
60

use crate::{
    algebra::{
        abstr::Real,
        linear::{matrix::General, vector::vector::Vector},
    },
    optimization::{Optim, OptimResult},
};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::clone::Clone;
use std::marker::PhantomData;

/// Gauss-Newton method
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Clone, Copy, Debug)]
pub struct GaussNewton<T> {
    iters: u64,
    __phantom: PhantomData<T>,
}

impl<T> GaussNewton<T> {
    pub fn new(iters: u64) -> GaussNewton<T> {
        GaussNewton {
            iters,
            __phantom: PhantomData,
        }
    }
}

impl<T> GaussNewton<T>
where
    T: Real,
{
    /// Minimize function func
    ///
    /// # Arguments
    ///
    /// * 'func0': Function to be minimized
    /// * 'x_0': Initial guess for the minimum
    ///
    /// # Return
    ///
    /// local minimum
    pub fn minimize<F>(&self, func: &F, x_0: &Vector<T>) -> Result<OptimResult<Vector<T>>, ()>
    where
        F: Optim<T>,
    {
        let mut x_n: Vector<T> = x_0.clone();

        for _i in 0..self.iters {
            let jacobian_x_n: General<T> = func.jacobian(&x_n);
            let f_x_n: Vector<T> = func.eval(&x_n);
            let pinv = jacobian_x_n.pinv()?;
            let delta_x_n: Vector<T> = pinv * f_x_n;
            x_n -= delta_x_n;
        }

        Ok(OptimResult::new(x_n))
    }
}