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
use super::Vector;
use crate::{to_i32, StrError};
extern "C" {
// Computes constant times a vector plus a vector.
// <https://www.netlib.org/lapack/explore-html/d9/dcd/daxpy_8f.html>
fn cblas_daxpy(n: i32, alpha: f64, x: *const f64, incx: i32, y: *mut f64, incy: i32);
}
/// (daxpy) Updates vector based on another vector
///
/// ```text
/// v += α⋅u
/// ```
///
/// See also: <https://www.netlib.org/lapack/explore-html/d9/dcd/daxpy_8f.html>
///
/// # Examples
///
/// ```
/// use russell_lab::{vec_update, Vector, StrError};
///
/// fn main() -> Result<(), StrError> {
/// let u = Vector::from(&[10.0, 20.0, 30.0]);
/// let mut v = Vector::from(&[10.0, 20.0, 30.0]);
/// vec_update(&mut v, 0.1, &u)?;
/// let correct = "┌ ┐\n\
/// │ 11 │\n\
/// │ 22 │\n\
/// │ 33 │\n\
/// └ ┘";
/// assert_eq!(format!("{}", v), correct);
/// Ok(())
/// }
/// ```
pub fn vec_update(v: &mut Vector, alpha: f64, u: &Vector) -> Result<(), StrError> {
let n = v.dim();
if u.dim() != n {
return Err("vectors are incompatible");
}
let n_i32 = to_i32(n);
unsafe {
cblas_daxpy(n_i32, alpha, u.as_data().as_ptr(), 1, v.as_mut_data().as_mut_ptr(), 1);
}
Ok(())
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#[cfg(test)]
mod tests {
use super::{vec_update, Vector};
use crate::vec_approx_eq;
#[test]
fn vec_update_fails_on_wrong_dims() {
let u = Vector::new(4);
let mut v = Vector::new(3);
assert_eq!(vec_update(&mut v, 1.0, &u), Err("vectors are incompatible"));
}
#[test]
fn vec_update_works() {
let u = Vector::from(&[10.0, 20.0, 30.0]);
let mut v = Vector::from(&[100.0, 200.0, 300.0]);
vec_update(&mut v, 2.0, &u).unwrap();
let correct = &[120.0, 240.0, 360.0];
vec_approx_eq(&v, correct, 1e-15);
}
}