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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
#![allow(dead_code)]
/// A reference-based 2D vector implementation that holds mutable references to f64 values.
///
/// This structure provides mathematical operations on 2D vectors using mutable references
/// to external f64 values rather than owning the values directly.
pub struct Vector2Ref<'a> {
/// Mutable reference to the x component
pub x: &'a mut f64,
/// Mutable reference to the y component
pub y: &'a mut f64,
}
impl<'a> Vector2Ref<'a> {
/// Creates a new Vector2Ref from mutable references to two f64 values.
///
/// # Arguments
///
/// * `x` - A mutable reference to the x component
/// * `y` - A mutable reference to the y component
///
/// # Examples
///
/// ```
/// use ginger::vector2_ref::Vector2Ref;
///
/// let mut x_val = 1.0;
/// let mut y_val = 2.0;
///
/// let mut v = Vector2Ref::new(&mut x_val, &mut y_val);
/// ```
pub fn new(x: &'a mut f64, y: &'a mut f64) -> Self {
Vector2Ref { x, y }
}
/// Computes the dot product of this vector with another vector.
///
/// # Arguments
///
/// * `other` - Another Vector2Ref to compute the dot product with
///
/// # Examples
///
/// ```
/// use ginger::vector2_ref::Vector2Ref;
///
/// let mut x1 = 1.0;
/// let mut y1 = 2.0;
/// let mut x2 = 3.0;
/// let mut y2 = 4.0;
///
/// let v1 = Vector2Ref::new(&mut x1, &mut y1);
/// let v2 = Vector2Ref::new(&mut x2, &mut y2);
/// let result = v1.dot(&v2);
///
/// assert_eq!(result, 11.0); // 1*3 + 2*4 = 11
/// ```
pub fn dot(&self, other: &Vector2Ref) -> f64 {
*self.x * *other.x + *self.y * *other.y
}
/// Computes the cross product of this vector with another vector.
///
/// # Arguments
///
/// * `other` - Another Vector2Ref to compute the cross product with
///
/// # Examples
///
/// ```
/// use ginger::vector2_ref::Vector2Ref;
///
/// let mut x1 = 1.0;
/// let mut y1 = 2.0;
/// let mut x2 = 3.0;
/// let mut y2 = 4.0;
///
/// let v1 = Vector2Ref::new(&mut x1, &mut y1);
/// let v2 = Vector2Ref::new(&mut x2, &mut y2);
/// let result = v1.cross(&v2);
///
/// assert_eq!(result, -2.0); // 1*4 - 3*2 = -2
/// ```
pub fn cross(&self, other: &Vector2Ref) -> f64 {
*self.x * *other.y - *other.x * *self.y
}
/// Adds another vector to this vector in-place.
///
/// # Arguments
///
/// * `other` - Another Vector2Ref to add to this vector
///
/// # Examples
///
/// ```
/// use ginger::vector2_ref::Vector2Ref;
///
/// let mut x1 = 1.0;
/// let mut y1 = 2.0;
/// let mut x2 = 3.0;
/// let mut y2 = 4.0;
///
/// let mut v1 = Vector2Ref::new(&mut x1, &mut y1);
/// let v2 = Vector2Ref::new(&mut x2, &mut y2);
/// v1.add_assign(&v2);
///
/// assert_eq!(*v1.x, 4.0); // 1 + 3 = 4
/// assert_eq!(*v1.y, 6.0); // 2 + 4 = 6
/// ```
pub fn add_assign(&mut self, other: &Vector2Ref) {
*self.x += *other.x;
*self.y += *other.y;
}
/// Subtracts another vector from this vector in-place.
///
/// # Arguments
///
/// * `other` - Another Vector2Ref to subtract from this vector
///
/// # Examples
///
/// ```
/// use ginger::vector2_ref::Vector2Ref;
///
/// let mut x1 = 5.0;
/// let mut y1 = 6.0;
/// let mut x2 = 3.0;
/// let mut y2 = 4.0;
///
/// let mut v1 = Vector2Ref::new(&mut x1, &mut y1);
/// let v2 = Vector2Ref::new(&mut x2, &mut y2);
/// v1.sub_assign(&v2);
///
/// assert_eq!(*v1.x, 2.0); // 5 - 3 = 2
/// assert_eq!(*v1.y, 2.0); // 6 - 4 = 2
/// ```
pub fn sub_assign(&mut self, other: &Vector2Ref) {
*self.x -= *other.x;
*self.y -= *other.y;
}
/// Scales this vector by a scalar value in-place.
///
/// # Arguments
///
/// * `alpha` - The scalar value to multiply the vector by
///
/// # Examples
///
/// ```
/// use ginger::vector2_ref::Vector2Ref;
///
/// let mut x = 2.0;
/// let mut y = 3.0;
///
/// let mut v = Vector2Ref::new(&mut x, &mut y);
/// v.mul_assign(2.0);
///
/// assert_eq!(*v.x, 4.0); // 2 * 2 = 4
/// assert_eq!(*v.y, 6.0); // 3 * 2 = 6
/// ```
pub fn mul_assign(&mut self, alpha: f64) {
*self.x *= alpha;
*self.y *= alpha;
}
/// Divides this vector by a scalar value in-place.
///
/// # Arguments
///
/// * `alpha` - The scalar value to divide the vector by
///
/// # Examples
///
/// ```
/// use ginger::vector2_ref::Vector2Ref;
///
/// let mut x = 6.0;
/// let mut y = 8.0;
///
/// let mut v = Vector2Ref::new(&mut x, &mut y);
/// v.div_assign(2.0);
///
/// assert_eq!(*v.x, 3.0); // 6 / 2 = 3
/// assert_eq!(*v.y, 4.0); // 8 / 2 = 4
/// ```
pub fn div_assign(&mut self, alpha: f64) {
*self.x /= alpha;
*self.y /= alpha;
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_vector2() {
let mut x = 1.0;
let mut y = 2.0;
let mut v = Vector2Ref::new(&mut x, &mut y);
v.mul_assign(2.0);
assert_eq!(*v.x, 2.0);
assert_eq!(*v.y, 4.0);
let mut v2 = Vector2Ref::new(&mut x, &mut y);
v2.mul_assign(2.0);
assert_eq!(*v2.y, 8.0);
}
#[test]
fn test_dot() {
let mut x1 = 3.0;
let mut y1 = 4.0;
let mut x2 = 5.0;
let mut y2 = 6.0;
let v1 = Vector2Ref::new(&mut x1, &mut y1);
let v2 = Vector2Ref::new(&mut x2, &mut y2);
assert_eq!(v1.dot(&v2), 39.0);
}
#[test]
fn test_cross() {
let mut x1 = 3.0;
let mut y1 = 4.0;
let mut x2 = 5.0;
let mut y2 = 6.0;
let v1 = Vector2Ref::new(&mut x1, &mut y1);
let v2 = Vector2Ref::new(&mut x2, &mut y2);
assert_eq!(v1.cross(&v2), -2.0);
}
#[test]
fn test_add_assign() {
let mut x1 = 1.0;
let mut y1 = 2.0;
let mut x2 = 3.0;
let mut y2 = 4.0;
let mut v1 = Vector2Ref::new(&mut x1, &mut y1);
let v2 = Vector2Ref::new(&mut x2, &mut y2);
v1.add_assign(&v2);
assert_eq!(*v1.x, 4.0);
assert_eq!(*v1.y, 6.0);
}
#[test]
fn test_sub_assign() {
let mut x1 = 5.0;
let mut y1 = 6.0;
let mut x2 = 3.0;
let mut y2 = 4.0;
let mut v1 = Vector2Ref::new(&mut x1, &mut y1);
let v2 = Vector2Ref::new(&mut x2, &mut y2);
v1.sub_assign(&v2);
assert_eq!(*v1.x, 2.0);
assert_eq!(*v1.y, 2.0);
}
#[test]
fn test_div_assign() {
let mut x = 6.0;
let mut y = 8.0;
let mut v = Vector2Ref::new(&mut x, &mut y);
v.div_assign(2.0);
assert_eq!(*v.x, 3.0);
assert_eq!(*v.y, 4.0);
}
}