basin 3.0.0

Numerical optimization in pure Rust, with pluggable linear-algebra backends and WASM support.
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! Backend-agnostic slice views over the parameter vector.
//!
//! L-BFGS-B's inner numerics (cauchy, subsm, formk, compact-form
//! helpers) operate on `&[F]`/`&mut [F]` for the solver's scalar
//! `F: Scalar`. To stay generic over the user-chosen parameter backend
//! (`Vec<F>`, nalgebra `DVector<F>`, faer `Col<F>`, ndarray
//! `Array1<F>`), the top-level solver views each vector as a
//! contiguous `F` slice at iteration boundaries. The two tiny traits
//! below capture that view and allow custom contiguous backends.
//!
//! The trait carries an `F = f64` default so existing call sites
//! resolve unchanged.

/// Read-only view of a parameter vector as a contiguous `&[F]`.
pub trait AsFloatSlice<F = f64> {
    /// Borrow the underlying storage as a contiguous slice.
    fn as_float_slice(&self) -> &[F];
}

/// Mutable companion to [`AsFloatSlice`].
pub trait AsFloatSliceMut<F = f64>: AsFloatSlice<F> {
    /// Borrow the underlying storage as a contiguous mutable slice.
    fn as_float_slice_mut(&mut self) -> &mut [F];
}

impl<F> AsFloatSlice<F> for &[F] {
    fn as_float_slice(&self) -> &[F] {
        self
    }
}

impl<F> AsFloatSlice<F> for Vec<F> {
    fn as_float_slice(&self) -> &[F] {
        self.as_slice()
    }
}
impl<F> AsFloatSliceMut<F> for Vec<F> {
    fn as_float_slice_mut(&mut self) -> &mut [F] {
        self.as_mut_slice()
    }
}

#[cfg(feature = "nalgebra_all")]
mod nalgebra_slices {
    use super::*;
    crate::backend_macros::nalgebra_versions!(
        nalgebra,
        nalgebra_sparse,
        nalgebra_lapack,
        {
            use super::{AsFloatSlice, AsFloatSliceMut};
            impl<F: nalgebra::Scalar> AsFloatSlice<F> for nalgebra::DVector<F> {
                fn as_float_slice(&self) -> &[F] {
                    self.as_slice()
                }
            }
            impl<F: nalgebra::Scalar> AsFloatSliceMut<F> for nalgebra::DVector<F> {
                fn as_float_slice_mut(&mut self) -> &mut [F] {
                    self.as_mut_slice()
                }
            }
        }
    );
}

#[cfg(feature = "faer_all")]
mod faer_slices {
    use super::*;
    crate::backend_macros::faer_versions!(faer, faer_traits, {
        use super::{AsFloatSlice, AsFloatSliceMut};
        impl<F: faer_traits::ComplexField> AsFloatSlice<F> for faer::Col<F> {
            fn as_float_slice(&self) -> &[F] {
                self.try_as_col_major()
                    .expect("faer::Col<F> backing storage must be col-major contiguous")
                    .as_slice()
            }
        }
        impl<F: faer_traits::ComplexField> AsFloatSliceMut<F> for faer::Col<F> {
            fn as_float_slice_mut(&mut self) -> &mut [F] {
                self.try_as_col_major_mut()
                    .expect("faer::Col<F> backing storage must be col-major contiguous")
                    .as_slice_mut()
            }
        }
    });
}

#[cfg(feature = "ndarray_all")]
mod ndarray_slices {
    use super::*;
    crate::backend_macros::ndarray_versions!(ndarray, {
        use super::{AsFloatSlice, AsFloatSliceMut};
        impl<F> AsFloatSlice<F> for ndarray::Array1<F> {
            fn as_float_slice(&self) -> &[F] {
                self.as_slice().expect("Array1 is contiguous")
            }
        }
        impl<F> AsFloatSliceMut<F> for ndarray::Array1<F> {
            fn as_float_slice_mut(&mut self) -> &mut [F] {
                self.as_slice_mut().expect("Array1 is contiguous")
            }
        }
    });
}