1use std::any::Any;
90use std::collections::{HashMap, HashSet};
91
92use apex_manifolds::{LieGroup, Tangent};
93use faer::Mat;
94use nalgebra::DVector;
95
96#[derive(Clone, Debug)]
119pub struct Variable<M: LieGroup> {
120 pub value: M,
122 pub fixed_indices: HashSet<usize>,
124 pub bounds: HashMap<usize, (f64, f64)>,
126 pub covariance: Option<faer::Mat<f64>>,
135}
136
137impl<M> Variable<M>
138where
139 M: LieGroup + Clone + 'static,
140 M::TangentVector: Tangent<M>,
141{
142 pub fn new(value: M) -> Self {
156 Variable {
157 value,
158 fixed_indices: HashSet::new(),
159 bounds: HashMap::new(),
160 covariance: None,
161 }
162 }
163
164 pub fn set_value(&mut self, value: M) {
169 self.value = value;
170 }
171
172 pub fn get_size(&self) -> usize {
180 self.value.tangent_dim()
181 }
182
183 pub fn plus(&self, tangent: &M::TangentVector) -> M {
209 self.value.plus(tangent, None, None)
210 }
211
212 pub fn minus(&self, other: &Self) -> M::TangentVector {
237 self.value.minus(&other.value, None, None)
238 }
239
240 pub fn get_covariance(&self) -> Option<&Mat<f64>> {
247 self.covariance.as_ref()
248 }
249
250 pub fn set_covariance(&mut self, cov: Mat<f64>) {
258 self.covariance = Some(cov);
259 }
260
261 pub fn clear_covariance(&mut self) {
263 self.covariance = None;
264 }
265}
266
267use apex_manifolds::rn::Rn;
269
270impl Variable<Rn> {
271 pub fn to_vector(&self) -> DVector<f64> {
273 self.value.data().clone()
274 }
275
276 pub fn from_vector(values: DVector<f64>) -> Self {
278 Self::new(Rn::new(values))
279 }
280
281 pub fn update_variable(&mut self, mut tangent_delta: DVector<f64>) {
283 for (&idx, &(lower, upper)) in &self.bounds {
285 tangent_delta[idx] = tangent_delta[idx].max(lower).min(upper);
286 }
287
288 for &index_to_fix in &self.fixed_indices {
290 tangent_delta[index_to_fix] = self.value.data()[index_to_fix];
291 }
292
293 self.value = Rn::new(tangent_delta);
294 }
295}
296
297pub trait ManifoldVariable: Send + Sync + 'static {
309 fn as_param_slice(&self) -> &[f64];
312 fn dof(&self) -> usize;
314 fn apply_tangent_step(&mut self, step: &[f64]);
317
318 fn set_fixed_indices(&mut self, indices: HashSet<usize>);
320 fn get_fixed_indices(&self) -> &HashSet<usize>;
321 fn set_bounds(&mut self, bounds: HashMap<usize, (f64, f64)>);
322 fn get_bounds(&self) -> &HashMap<usize, (f64, f64)>;
323 fn manifold_type_name(&self) -> &'static str;
325
326 fn set_covariance(&mut self, cov: faer::Mat<f64>);
328 fn covariance(&self) -> Option<&faer::Mat<f64>>;
329 fn clear_covariance(&mut self);
330
331 fn to_dvector(&self) -> DVector<f64>;
333
334 fn as_any(&self) -> &dyn Any;
336 fn as_any_mut(&mut self) -> &mut dyn Any;
337 fn clone_box(&self) -> Box<dyn ManifoldVariable>;
338}
339
340impl Clone for Box<dyn ManifoldVariable> {
341 fn clone(&self) -> Self {
342 self.clone_box()
343 }
344}
345
346impl<M> ManifoldVariable for Variable<M>
347where
348 M: LieGroup + Clone + Send + Sync + 'static,
349 M::TangentVector: Tangent<M> + Send + Sync + 'static,
350{
351 fn as_param_slice(&self) -> &[f64] {
352 self.value.as_param_slice()
353 }
354
355 fn dof(&self) -> usize {
356 self.value.tangent_dim()
357 }
358
359 fn apply_tangent_step(&mut self, step: &[f64]) {
360 let dof = self.dof();
361 if dof <= 16 {
364 let mut buf = [0f64; 16];
365 buf[..dof].copy_from_slice(&step[..dof]);
366 for &idx in &self.fixed_indices {
367 if idx < dof {
368 buf[idx] = 0.0;
369 }
370 }
371 let tangent = M::TangentVector::from_slice(&buf[..dof]);
372 self.value = self.value.plus(&tangent, None, None);
373 } else {
374 let mut v = step[..dof].to_vec();
375 for &idx in &self.fixed_indices {
376 if idx < dof {
377 v[idx] = 0.0;
378 }
379 }
380 let tangent = M::TangentVector::from_slice(&v);
381 self.value = self.value.plus(&tangent, None, None);
382 }
383 }
384
385 fn manifold_type_name(&self) -> &'static str {
386 M::NAME
387 }
388
389 fn set_fixed_indices(&mut self, indices: HashSet<usize>) {
390 self.fixed_indices = indices;
391 }
392
393 fn get_fixed_indices(&self) -> &HashSet<usize> {
394 &self.fixed_indices
395 }
396
397 fn set_bounds(&mut self, bounds: HashMap<usize, (f64, f64)>) {
398 self.bounds = bounds;
399 }
400
401 fn get_bounds(&self) -> &HashMap<usize, (f64, f64)> {
402 &self.bounds
403 }
404
405 fn set_covariance(&mut self, cov: faer::Mat<f64>) {
406 self.covariance = Some(cov);
407 }
408
409 fn covariance(&self) -> Option<&faer::Mat<f64>> {
410 self.covariance.as_ref()
411 }
412
413 fn clear_covariance(&mut self) {
414 self.covariance = None;
415 }
416
417 fn to_dvector(&self) -> DVector<f64> {
418 DVector::from_column_slice(self.value.as_param_slice())
419 }
420
421 fn as_any(&self) -> &dyn Any {
422 self
423 }
424
425 fn as_any_mut(&mut self) -> &mut dyn Any {
426 self
427 }
428
429 fn clone_box(&self) -> Box<dyn ManifoldVariable> {
430 Box::new(self.clone())
431 }
432}
433
434#[cfg(test)]
435mod tests {
436 use super::*;
437 use apex_manifolds::{rn::Rn, se2::SE2, se3::SE3, so2::SO2, so3::SO3};
438 use nalgebra::{DVector, Quaternion, Vector3};
439 use std;
440
441 #[test]
442 fn test_variable_creation_rn() {
443 let vec_data = DVector::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0]);
444 let rn_value = Rn::new(vec_data);
445 let variable = Variable::new(rn_value);
446
447 assert_eq!(variable.get_size(), 5);
449 assert!(variable.fixed_indices.is_empty());
450 assert!(variable.bounds.is_empty());
451 }
452
453 #[test]
454 fn test_variable_creation_se2() {
455 let se2 = SE2::from_xy_angle(1.0, 2.0, 0.5);
456 let variable = Variable::new(se2);
457
458 assert_eq!(variable.get_size(), SE2::DOF);
459 assert!(variable.fixed_indices.is_empty());
460 assert!(variable.bounds.is_empty());
461 }
462
463 #[test]
464 fn test_variable_creation_se3() {
465 let se3 = SE3::from_translation_quaternion(
466 Vector3::new(1.0, 2.0, 3.0),
467 Quaternion::new(1.0, 0.0, 0.0, 0.0),
468 );
469 let variable = Variable::new(se3);
470
471 assert_eq!(variable.get_size(), SE3::DOF);
472 assert!(variable.fixed_indices.is_empty());
473 assert!(variable.bounds.is_empty());
474 }
475
476 #[test]
477 fn test_variable_creation_so2() {
478 let so2 = SO2::from_angle(0.5);
479 let variable = Variable::new(so2);
480
481 assert_eq!(variable.get_size(), SO2::DOF);
482 assert!(variable.fixed_indices.is_empty());
483 assert!(variable.bounds.is_empty());
484 }
485
486 #[test]
487 fn test_variable_creation_so3() {
488 let so3 = SO3::from_euler_angles(0.1, 0.2, 0.3);
489 let variable = Variable::new(so3);
490
491 assert_eq!(variable.get_size(), SO3::DOF);
492 assert!(variable.fixed_indices.is_empty());
493 assert!(variable.bounds.is_empty());
494 }
495
496 #[test]
497 fn test_variable_set_value() {
498 let initial_vec = DVector::from_vec(vec![1.0, 2.0, 3.0]);
499 let mut variable = Variable::new(Rn::new(initial_vec));
500
501 let new_vec = DVector::from_vec(vec![4.0, 5.0, 6.0, 7.0]);
502 variable.set_value(Rn::new(new_vec));
503 assert_eq!(variable.get_size(), 4);
504
505 let se2_initial = SE2::from_xy_angle(0.0, 0.0, 0.0);
506 let mut se2_variable = Variable::new(se2_initial);
507
508 let se2_new = SE2::from_xy_angle(1.0, 2.0, std::f64::consts::PI / 4.0);
509 se2_variable.set_value(se2_new);
510 assert_eq!(se2_variable.get_size(), SE2::DOF);
511 }
512
513 #[test]
514 fn test_variable_plus_minus_operations() {
515 let se2_1 = SE2::from_xy_angle(2.0, 3.0, std::f64::consts::PI / 2.0);
517 let se2_2 = SE2::from_xy_angle(1.0, 1.0, std::f64::consts::PI / 4.0);
518 let var1 = Variable::new(se2_1);
519 let var2 = Variable::new(se2_2);
520
521 let diff_tangent = var1.minus(&var2);
522 let var2_updated = var2.plus(&diff_tangent);
523 let final_diff = var1.minus(&Variable::new(var2_updated));
524
525 assert!(DVector::from_column_slice(final_diff.as_slice()).norm() < 1e-10);
526 }
527
528 #[test]
529 fn test_variable_rn_plus_minus_operations() {
530 let rn_1 = Rn::new(DVector::from_vec(vec![1.0, 2.0, 3.0]));
532 let rn_2 = Rn::new(DVector::from_vec(vec![4.0, 5.0, 6.0]));
533 let var1 = Variable::new(rn_1);
534 let var2 = Variable::new(rn_2);
535
536 let diff_tangent = var1.minus(&var2);
538 assert_eq!(
539 diff_tangent.to_vector(),
540 DVector::from_vec(vec![-3.0, -3.0, -3.0])
541 );
542
543 let var2_updated = var2.plus(&diff_tangent);
545 assert_eq!(var2_updated.data(), &DVector::from_vec(vec![1.0, 2.0, 3.0]));
546
547 let final_diff = var1.minus(&Variable::new(var2_updated));
549 assert!(final_diff.to_vector().norm() < 1e-10);
550 }
551
552 #[test]
553 fn test_variable_update_with_bounds() {
554 let vec_data = DVector::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0]);
555 let mut variable = Variable::new(Rn::new(vec_data));
556
557 variable.bounds.insert(0, (-1.0, 1.0));
558 variable.bounds.insert(2, (0.0, 5.0));
559
560 let new_values = DVector::from_vec(vec![-5.0, 10.0, -3.0, 20.0, 30.0, 40.0]);
561 variable.update_variable(new_values);
562
563 let result_vec = variable.to_vector();
564 assert!(result_vec.len() == 6);
565 }
566
567 #[test]
568 fn test_variable_update_with_fixed_indices() {
569 let vec_data = DVector::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0]);
570 let mut variable = Variable::new(Rn::new(vec_data.clone()));
571
572 variable.fixed_indices.insert(1);
573 variable.fixed_indices.insert(4);
574
575 let delta_values = DVector::from_vec(vec![9.0, 18.0, 27.0, 36.0, 45.0, 54.0, 63.0, 72.0]);
576 variable.update_variable(delta_values);
577
578 let result_vec = variable.to_vector();
579 assert_eq!(result_vec[1], 2.0);
580 assert_eq!(result_vec[4], 5.0);
581 assert!(result_vec.len() == 8);
582 }
583
584 #[test]
585 fn test_variable_combined_bounds_and_fixed() {
586 let vec_data = DVector::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0]);
587 let mut variable = Variable::new(Rn::new(vec_data.clone()));
588
589 variable.bounds.insert(0, (-2.0, 2.0));
590 variable.bounds.insert(3, (-1.0, 1.0));
591 variable.fixed_indices.insert(1);
592 variable.fixed_indices.insert(5);
593
594 let delta_values = DVector::from_vec(vec![-5.0, 100.0, 30.0, 10.0, 50.0, 600.0, 70.0]);
595 variable.update_variable(delta_values);
596
597 let result = variable.to_vector();
598 assert_eq!(result[1], 2.0);
599 assert_eq!(result[5], 6.0);
600 assert!(result.len() == 7);
601 }
602
603 #[test]
604 fn test_variable_type_safety() {
605 let se2_var = Variable::new(SE2::from_xy_angle(1.0, 2.0, 0.5));
606 let se3_var = Variable::new(SE3::from_translation_quaternion(
607 Vector3::new(1.0, 2.0, 3.0),
608 Quaternion::new(1.0, 0.0, 0.0, 0.0),
609 ));
610 let so2_var = Variable::new(SO2::from_angle(0.5));
611 let so3_var = Variable::new(SO3::from_euler_angles(0.1, 0.2, 0.3));
612 let rn_var = Variable::new(Rn::new(DVector::from_vec(vec![1.0, 2.0, 3.0])));
613
614 assert_eq!(se2_var.get_size(), SE2::DOF);
615 assert_eq!(se3_var.get_size(), SE3::DOF);
616 assert_eq!(so2_var.get_size(), SO2::DOF);
617 assert_eq!(so3_var.get_size(), SO3::DOF);
618 assert_eq!(rn_var.get_size(), 3);
619 }
620
621 #[test]
622 fn test_variable_vector_conversion_roundtrip() {
623 let original_data = DVector::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0]);
624 let rn_var = Variable::new(Rn::new(original_data.clone()));
625 let vec_repr = rn_var.to_vector();
626 assert_eq!(vec_repr, original_data);
627
628 let reconstructed_var = Variable::<Rn>::from_vector(vec_repr);
629 assert_eq!(reconstructed_var.to_vector(), original_data);
630 }
631
632 #[test]
633 fn test_variable_manifold_operations_consistency() {
634 let rn_initial = Rn::new(DVector::from_vec(vec![1.0, 2.0, 3.0]));
636 let mut rn_var = Variable::new(rn_initial);
637 let rn_new_values = DVector::from_vec(vec![2.0, 3.0, 4.0]);
638 rn_var.update_variable(rn_new_values);
639
640 let rn_result = rn_var.to_vector();
641 assert_eq!(rn_result, DVector::from_vec(vec![2.0, 3.0, 4.0]));
642
643 let se2_1 = SE2::from_xy_angle(2.0, 3.0, std::f64::consts::PI / 2.0);
645 let se2_2 = SE2::from_xy_angle(1.0, 1.0, std::f64::consts::PI / 4.0);
646 let var1 = Variable::new(se2_1);
647 let var2 = Variable::new(se2_2);
648
649 let diff_tangent = var1.minus(&var2);
650 let var2_updated = var2.plus(&diff_tangent);
651 let final_diff = var1.minus(&Variable::new(var2_updated));
652
653 assert!(DVector::from_column_slice(final_diff.as_slice()).norm() < 1e-10);
655 }
656
657 #[test]
658 fn test_variable_constraints_interaction() {
659 let rn_data = DVector::from_vec(vec![0.0, 0.0, 0.0, 0.0, 0.0]);
660 let mut rn_var = Variable::new(Rn::new(rn_data));
661
662 rn_var.bounds.insert(0, (-1.0, 1.0));
663 rn_var.bounds.insert(2, (-10.0, 10.0));
664 rn_var.fixed_indices.insert(1);
665 rn_var.fixed_indices.insert(4);
666
667 let large_delta = DVector::from_vec(vec![5.0, 100.0, 15.0, 20.0, 200.0]);
668 rn_var.update_variable(large_delta);
669
670 let result = rn_var.to_vector();
671
672 assert_eq!(result[0], 1.0);
673 assert_eq!(result[1], 0.0);
674 assert_eq!(result[2], 10.0);
675 assert_eq!(result[3], 20.0);
676 assert_eq!(result[4], 0.0);
677 }
678}