kernelvex 0.3.0

VEX Controls library
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
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
use kernelvex::odom::pose::Pose;
use kernelvex::util::si::QAngle;
use std::f64::consts::PI;
use kernelvex::Vector2;
// TODO: fix heading not being added in tests
// ============================================================================
// Basic Construction Tests
// ============================================================================

#[test]
fn test_pose_new() {
    let pose = Pose::new(Vector2::<f64>::new(1.5, 2.0), QAngle::from_degrees(45.0));
    let pos =pose.position();
    assert_eq!(pos.x, 1.5);
    assert_eq!(pos.y, 2.0);
    assert!((pose.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_identity() {
    let identity = Pose::identity();
    let pos =identity.position();
    assert_eq!(pos.x, 0.0);
    assert_eq!(pos.y, 0.0);
    assert_eq!(identity.heading().as_radians(), 0.0);
}

#[test]
fn test_pose_default() {
    let default: Pose = Default::default();
    let pos =default.position();
    assert_eq!(pos.x, 0.0);
    assert_eq!(pos.y, 0.0);
    assert_eq!(default.heading().as_radians(), 0.0);
}

#[test]
fn test_pose_position() {
    let pose = Pose::new(Vector2::<f64>::new(3.0, 4.0), QAngle::from_degrees(90.0));
    let pos =pose.position();
    assert_eq!(pos.x, 3.0);
    assert_eq!(pos.y, 4.0);
}

#[test]
fn test_pose_heading() {
    let pose = Pose::new(Default::default(), QAngle::from_degrees(45.0));
    assert!((pose.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

// ============================================================================
// Distance Tests
// ============================================================================

#[test]
fn test_pose_distance_horizontal() {
    let p1 = Pose::new(Default::default(), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(3.0, 0.0), QAngle::from_degrees(0.0));
    let dist = p1.distance(p2);
    assert_eq!(dist.as_meters(), 3.0);
}

#[test]
fn test_pose_distance_vertical() {
    let p1 = Pose::new(Default::default(), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(0., 4.), QAngle::from_degrees(0.0));
    let dist = p1.distance(p2);
    assert_eq!(dist.as_meters(), 4.0);
}

#[test]
fn test_pose_distance_diagonal() {
    let p1 = Pose::new(Default::default(), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(3.0, 4.0), QAngle::from_degrees(0.0));
    let dist = p1.distance(p2);
    // Distance should be sqrt(3^2 + 4^2) = 5.0
    assert_eq!(dist.as_meters(), 5.0);
}

#[test]
fn test_pose_distance_symmetric() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(3.0, 4.0), QAngle::from_degrees(0.0));
    let dist1 = p1.distance(p2);
    let dist2 = p2.distance(p1);
    assert_eq!(dist1.as_meters(), dist2.as_meters());
}

#[test]
fn test_pose_distance_zero() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(0.0));
    let dist = p1.distance(p2);
    assert_eq!(dist.as_meters(), 0.0);
}

// ============================================================================
// Angle Tests
// ============================================================================

#[test]
fn test_pose_angle_horizontal() {
    let p1 = Pose::new(Default::default(), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));
    let angle = p1.angle(p2);
    assert_eq!(angle.as_radians(), 0.0);
}

#[test]
fn test_pose_angle_vertical() {
    let p1 = Pose::new(Default::default(), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(0.0, 1.0), QAngle::from_degrees(0.0));
    let angle = p1.angle(p2);
    assert!((angle.as_radians() - PI / 2.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_angle_diagonal() {
    let p1 = Pose::new(Default::default(), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(1.0, 1.0), QAngle::from_degrees(0.0));
    let angle = p1.angle(p2);
    // Angle should be 45 degrees = π/4 radians
    assert!((angle.as_degrees() - 45.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_angle_negative_y() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 1.0), QAngle::from_degrees(0.0));
    let p2 = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));
    let angle = p1.angle(p2);
    // Angle should be -90 degrees = -π/2 radians
    assert_eq!(angle.as_degrees(), -90.);
}

// ============================================================================
// Rotation Tests
// ============================================================================

#[test]
fn test_pose_rotate() {
    let pose = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(0.0));
    let rotated = pose.rotate(QAngle::from_degrees(90.0));
    let pos =rotated.position();
    // Position should remain unchanged
    assert_eq!(pos.x, 1.0);
    assert_eq!(pos.y, 2.0);
    // Heading should be rotated
    assert!((rotated.heading().as_degrees() - 90.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_rotate_multiple() {
    let pose = Pose::new(Default::default(), QAngle::from_degrees(30.0));
    let rotated = pose.rotate(QAngle::from_degrees(60.0));
    // Heading should be 30 + 60 = 90 degrees
    assert!((rotated.heading().as_degrees() - 90.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_rotate_negative() {
    let pose = Pose::new(Vector2::<f64>::new(1.0, 1.0), QAngle::from_degrees(90.0));
    let rotated = pose.rotate(QAngle::from_degrees(-45.0));
    assert!((rotated.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

// ============================================================================
// Addition Tests
// ============================================================================

#[test]
fn test_pose_add() {
    let p1 = Pose::new(Vector2::<f64>::new(1., 2.), QAngle::from_degrees(45.0));
    let p2 = Pose::new(Vector2::<f64>::new(3., 4.), QAngle::from_degrees(90.0));
    let sum = p1 + p2;
    let pos =sum.position();
    // Positions should be added: (1+3, 2+4) = (4, 6)
    assert_eq!(pos.x, 4.0);
    assert_eq!(pos.y, 6.0);
    // Heading should be preserved from left operand
    assert!((sum.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_add_identity() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(30.0));
    let identity = Pose::identity();
    let sum = p1 + identity;
    let pos =sum.position();
    assert_eq!(pos.x, 1.0);
    assert_eq!(pos.y, 2.0);
}

// ============================================================================
// Subtraction Tests
// ============================================================================

#[test]
fn test_pose_sub() {
    let p1 = Pose::new(Vector2::<f64>::new(5.0, 7.0), QAngle::from_degrees(45.0));
    let p2 = Pose::new(Vector2::<f64>::new(2.0, 3.0), QAngle::from_degrees(90.0));
    let diff = p1 - p2;
    let pos =diff.position();
    // Positions should be subtracted: (5-2, 7-3) = (3, 4)
    assert_eq!(pos.x, 3.0);
    assert_eq!(pos.y, 4.0);
    // Heading should be preserved from left operand
    assert!((diff.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_sub_identity() {
    let p1 = Pose::new(Vector2::<f64>::new(3.0, 4.0), QAngle::from_degrees(60.0));
    let identity = Pose::identity();
    let diff = p1 - identity;
    let pos =diff.position();
    assert_eq!(pos.x, 3.0);
    assert_eq!(pos.y, 4.0);
    assert!((diff.heading().as_degrees() - 60.0).abs() < 1e-10);
}

// ============================================================================
// Multiplication Tests (Composition)
// ============================================================================

#[test]
fn test_pose_mul_identity() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(45.0));
    let identity = Pose::identity();
    let result = p1 * identity;
    let pos = result.position();
    // Multiplying by identity should leave position unchanged
    assert!((pos.x - 1.0).abs() < f64::EPSILON);
    assert!((pos.y - 2.0).abs() < f64::EPSILON);
    // Heading should be unchanged (45 + 0 = 45)
    assert!((result.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_mul_translation_only() {
    // First pose: identity (0, 0, 0°)
    let p1 = Pose::identity();
    // Second pose: translation only (1, 2, 0°)
    let p2 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(0.0));
    let result = p1 * p2;
    let pos =result.position();
    // Result should be (1, 2)
    assert!((pos.x - 1.0).abs() < f64::EPSILON);
    assert!((pos.y - 2.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_mul_rotation_only() {
    // First pose: at origin, rotated 90°
    let p1 = Pose::new(Default::default(), QAngle::from_degrees(90.0));
    // Second pose: at (1, 0), no rotation
    let p2 = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));
    let result = p1 * p2;
    let pos =result.position();
    // Rotating (1, 0) by 90° should give (0, 1)
    assert!((pos.x - 0.0).abs() < f64::EPSILON);
    assert!((pos.y - 1.0).abs() < f64::EPSILON);
    // Combined heading should be 90° + 0° = 90°
    assert!((result.heading().as_degrees() - 90.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_mul_combined() {
    // First pose: (1, 0) with 90° rotation
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(90.0));
    // Second pose: (0, 1) with 90° rotation
    let p2 = Pose::new(Vector2::<f64>::new(0.0, 1.0), QAngle::from_degrees(90.0));
    let result = p1 * p2;
    // Combined heading should be 90° + 90° = 180°
    assert!((result.heading().as_degrees() - 180.0).abs() < f64::EPSILON);
}

// ============================================================================
// Scalar Multiplication Tests
// ============================================================================

#[test]
fn test_pose_mul_scalar() {
    let pose = Pose::new(Vector2::<f64>::new(2.0, 3.0), QAngle::from_degrees(45.0));
    let scaled = pose * 2.0;
    let pos =scaled.position();
    // Position should be scaled: (2*2, 3*2) = (4, 6)
    assert_eq!(pos.x, 4.0);
    assert_eq!(pos.y, 6.0);
    // Heading should be preserved
    assert!((scaled.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_mul_scalar_zero() {
    let pose = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(30.0));
    let scaled = pose * 0.0;
    let pos =scaled.position();
    assert_eq!(pos.x, 0.0);
    assert_eq!(pos.y, 0.0);
    assert!((scaled.heading().as_degrees() - 30.0).abs() < 1e-10);
}

#[test]
fn test_pose_mul_scalar_negative() {
    let pose = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(45.0));
    let scaled = pose * -1.0;
    let pos =scaled.position();
    assert_eq!(pos.x, -1.0);
    assert_eq!(pos.y, -2.0);
    assert!((scaled.heading().as_degrees() - 45.0).abs() < f64::EPSILON);
}

// ============================================================================
// Scalar Division Tests
// ============================================================================

#[test]
fn test_pose_div_scalar() {
    let pose = Pose::new(Vector2::<f64>::new(4.0, 6.0), QAngle::from_degrees(60.0));
    let scaled = pose / 2.0;
    let pos =scaled.position();
    // Position should be divided: (4/2, 6/2) = (2, 3)
    assert_eq!(pos.x, 2.0);
    assert_eq!(pos.y, 3.0);
}

#[test]
fn test_pose_div_scalar_fractional() {
    let pose = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(45.0));
    let scaled = pose / 4.0;
    let pos =scaled.position();
    assert_eq!(pos.x, 0.25);
    assert_eq!(pos.y, 0.5);
}

// ============================================================================
// Move Local Tests
// ============================================================================

#[test]
fn test_pose_move_local() {
    // Robot at origin facing east
    let robot = Pose::new(Default::default(), QAngle::from_degrees(0.0));
    // Local point at (1, 0) in robot's frame
    let local = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));
    let global = robot.move_local(local);
    let pos =global.position();
    // Should still be (1, 0) since robot is at origin facing east
    assert!((pos.x - 1.0).abs() < f64::EPSILON);
    assert!((pos.y - 0.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_move_local_rotated() {
    // Robot at origin facing north (90°)
    let robot = Pose::new(Default::default(), QAngle::from_degrees(90.0));
    // Local point at (1, 0) in robot's frame (to its right)
    let local = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));
    let global = robot.move_local(local);
    let pos =global.position();
    // When facing north, (1, 0) in local frame is (0, 1) in global frame
    assert!((pos.x - 0.0).abs() < f64::EPSILON);
    assert!((pos.y - 1.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_move_local_translated() {
    // Robot at (2, 3) facing east
    let robot = Pose::new(Vector2::<f64>::new(2.0, 3.0), QAngle::from_degrees(0.0));
    // Local point at (1, 0) in robot's frame
    let local = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));
    let global = robot.move_local(local);
    let pos =global.position();
    // Should be (2+1, 3+0) = (3, 3)
    assert!((pos.x - 3.0).abs() < f64::EPSILON);
    assert!((pos.y - 3.0).abs() < f64::EPSILON);
}

// ============================================================================
// Move Global Tests
// ============================================================================

#[test]
fn test_pose_move_global() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(45.0));
    let p2 = Pose::new(Vector2::<f64>::new(3.0, 4.0), QAngle::from_degrees(90.0));
    let result = p1.move_global(p2);
    let pos =result.position();
    // Positions should be added: (1+3, 2+4) = (4, 6)
    assert_eq!(pos.x, 1.0);
    assert_eq!(pos.y, 5.0);
    // Heading should be reset to 0
    assert!(result.heading().as_radians() - 135.0 < f64::EPSILON);
}

#[test]
fn test_pose_move_global_zero() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(30.0));
    let zero = Pose::identity();
    let result = p1.move_global(zero);
    let pos =result.position();
    assert_eq!(pos.x, 1.0);
    assert_eq!(pos.y, 2.0);
    let z = result.heading().as_degrees();
    // Floating point precision: 30.0 degrees -> radians -> back to degrees may not be exactly 30.0
    assert!((z - 30.0).abs() < 1e-10);
}

// ============================================================================
// Transformation Matrix Tests
// ============================================================================

#[test]
fn test_pose_transformation_matrix_zero_rotation() {
    // Pose at (1, 2) with 0° rotation
    let pose = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(0.0));
    let pos =pose.position();
    assert_eq!(pos.x, 1.0);
    assert_eq!(pos.y, 2.0);
    // Cos(0) = 1, Sin(0) = 0
    assert!((pose.heading().cos() - 1.0).abs() < f64::EPSILON);
    assert!((pose.heading().sin() - 0.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_transformation_matrix_ninety_rotation() {
    // Pose at (0, 0) with 90° rotation
    let pose = Pose::new(Default::default(), QAngle::from_degrees(90.0));
    // Cos(90°) = 0, Sin(90°) = 1
    assert!((pose.heading().cos() - 0.0).abs() < f64::EPSILON);
    assert!((pose.heading().sin() - 1.0).abs() < f64::EPSILON);
}

// ============================================================================
// Integration Tests
// ============================================================================

#[test]
fn test_pose_chained_transformations() {
    // Start at origin
    let start = Pose::identity();
    // Move forward 1 meter
    let forward = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));
    // Rotate 90 degrees
    let rotate = Pose::new(Default::default(), QAngle::from_degrees(90.0));
    // Move forward 1 meter again
    let forward2 = Pose::new(Vector2::<f64>::new(1.0, 0.0), QAngle::from_degrees(0.0));

    // Chain transformations
    let result = start * forward * rotate * forward2;
    let _position = result.position();

    // After first forward: (1, 0)
    // After rotate 90°: heading is 90°
    // After second forward in new frame: should be (1, 1) in global
    // The exact position depends on matrix multiplication order
    // Combined heading: 0 + 0 + 90 + 0 = 90°
    assert!((result.heading().as_degrees() - 90.0).abs() < f64::EPSILON);
}

#[test]
fn test_pose_roundtrip() {
    // Create odom pose
    let original = Pose::new(Vector2::<f64>::new(1.5, 2.5), QAngle::from_degrees(45.0));

    // Extract components
    let pos = original.position();
    let heading = original.heading();

    // Recreate pose
    let recreated = Pose::new(pos, heading);

    // Verify components match
    let (x2, y2) = (recreated.position().x, recreated.position().y);
    assert_eq!(pos.x, x2);
    assert_eq!(pos.y, y2);
    assert!((heading.as_degrees() - recreated.heading().as_degrees()).abs() < f64::EPSILON);
}

#[test]
fn test_pose_clone() {
    let p1 = Pose::new(Vector2::<f64>::new(1.0, 2.0), QAngle::from_degrees(45.0));
    let p2 = p1;
    // Both should have same position and heading
    let pos1 = p1.position();
    let pos2 = p2.position();
    assert_eq!(pos1.x, pos2.x);
    assert_eq!(pos2.y, pos1.y);
    assert!((p1.heading().as_degrees() - p2.heading().as_degrees()).abs() < f64::EPSILON);
}