quat 0.2.1

quat
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use core::ops::{Add, Mul, Neg, Sub};

/// # Example
/// ```
/// use std::f32::consts::FRAC_2_PI;
/// let mut a = quat::new_identity::<f32>();
/// let mut b = quat::new_identity::<f32>();
///
/// quat::set_axis_angle(&mut a, &[0_f32, 0_f32, 1_f32], &FRAC_2_PI);
/// quat::set_axis_angle(&mut b, &[0_f32, 0_f32, 1_f32], &-FRAC_2_PI);
///
/// let mut q = quat::new_identity::<f32>();
/// quat::mul(&mut q, &a, &b);
/// assert_eq!(q, [0_f32, 0_f32, 0_f32, 1_f32]);
///
/// let mut axis = [0_f32; 3];
/// let angle = quat::axis_angle(&mut q, &mut axis);
///
/// assert_eq!(angle, 0_f32);
/// assert_eq!(axis, [0_f32, 0_f32, 1_f32]);
/// ```
#[inline]
pub fn mul<'out, T>(out: &'out mut [T; 4], a: &[T; 4], b: &[T; 4]) -> &'out mut [T; 4]
where
    T: Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    out[0] = &a[0] * &b[3] + &a[3] * &b[0] + &a[1] * &b[2] - &a[2] * &b[1];
    out[1] = &a[1] * &b[3] + &a[3] * &b[1] + &a[2] * &b[0] - &a[0] * &b[2];
    out[2] = &a[2] * &b[3] + &a[3] * &b[2] + &a[0] * &b[1] - &a[1] * &b[0];
    out[3] = &a[3] * &b[3] - &a[0] * &b[0] - &a[1] * &b[1] - &a[2] * &b[2];
    out
}
/// rmul_mut(out, a) does out = a * out
/// # Example
/// ```
/// let mut q = quat::new_identity::<f32>();
/// quat::rmul_mut(&mut q, &quat::new_identity::<f32>());
/// assert_eq!(q, [0_f32, 0_f32, 0_f32, 1_f32]);
/// ```
#[inline]
pub fn rmul_mut<'out, T>(out: &'out mut [T; 4], a: &[T; 4]) -> &'out mut [T; 4]
where
    T: Clone + Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    mul(out, a, &tmp)
}
/// lmul_mut(out, a) does out = out * a
/// # Example
/// ```
/// let mut q = quat::new_identity::<f32>();
/// quat::lmul_mut(&mut q, &quat::new_identity::<f32>());
/// assert_eq!(q, [0_f32, 0_f32, 0_f32, 1_f32]);
/// ```
#[inline]
pub fn lmul_mut<'out, T>(out: &'out mut [T; 4], a: &[T; 4]) -> &'out mut [T; 4]
where
    T: Clone + Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T>,
{
    let tmp = out.clone();
    mul(out, &tmp, a)
}
/// # Example
/// ```
/// use std::f32::consts::FRAC_2_PI;
/// let mut a = quat::new_identity::<f32>();
/// let mut b = quat::new_identity::<f32>();
///
/// quat::set_axis_angle(&mut a, &[0_f32, 0_f32, 1_f32], &FRAC_2_PI);
/// quat::set_axis_angle(&mut b, &[0_f32, 0_f32, 1_f32], &FRAC_2_PI);
///
/// let mut q = quat::new_identity::<f32>();
/// quat::div(&mut q, &a, &b);
/// assert_eq!(q, [0_f32, 0_f32, 0_f32, 1_f32]);
///
/// let mut axis = [0_f32; 3];
/// let angle = quat::axis_angle(&mut q, &mut axis);
///
/// assert_eq!(angle, 0_f32);
/// assert_eq!(axis, [0_f32, 0_f32, 1_f32]);
/// ```
#[inline]
pub fn div<'out, T>(out: &'out mut [T; 4], a: &[T; 4], b: &[T; 4]) -> &'out mut [T; 4]
where
    T: Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T> + Neg<Output = T>,
{
    out[0] = &a[0] * &b[3] + &a[3] * &-&b[0] + &a[1] * &-&b[2] - &a[2] * &-&b[1];
    out[1] = &a[1] * &b[3] + &a[3] * &-&b[1] + &a[2] * &-&b[0] - &a[0] * &-&b[2];
    out[2] = &a[2] * &b[3] + &a[3] * &-&b[2] + &a[0] * &-&b[1] - &a[1] * &-&b[0];
    out[3] = &a[3] * &b[3] - &a[0] * &-&b[0] - &a[1] * &-&b[1] - &a[2] * &-&b[2];
    out
}
/// rdiv_mut(out, a) does out = a / out
/// # Example
/// ```
/// let mut q = quat::new_identity::<f32>();
/// quat::rdiv_mut(&mut q, &quat::new_identity::<f32>());
/// assert_eq!(q, [0_f32, 0_f32, 0_f32, 1_f32]);
/// ```
#[inline]
pub fn rdiv_mut<'out, T>(out: &'out mut [T; 4], a: &[T; 4]) -> &'out mut [T; 4]
where
    T: Clone + Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T> + Neg<Output = T>,
{
    let tmp = out.clone();
    div(out, a, &tmp)
}
/// ldiv_mut(out, a) does out = out / a
/// # Example
/// ```
/// let mut q = quat::new_identity::<f32>();
/// quat::ldiv_mut(&mut q, &quat::new_identity::<f32>());
/// assert_eq!(q, [0_f32, 0_f32, 0_f32, 1_f32]);
/// ```
#[inline]
pub fn ldiv_mut<'out, T>(out: &'out mut [T; 4], a: &[T; 4]) -> &'out mut [T; 4]
where
    T: Clone + Add<T, Output = T> + Sub<T, Output = T>,
    for<'a, 'b> &'a T: Mul<&'b T, Output = T> + Neg<Output = T>,
{
    let tmp = out.clone();
    div(out, &tmp, a)
}