sophus_opt/
lib.rs

1#![cfg_attr(feature = "simd", feature(portable_simd))]
2#![deny(missing_docs)]
3#![allow(clippy::needless_range_loop)]
4#![doc = include_str!(concat!("../", std::env!("CARGO_PKG_README")))]
5#![cfg_attr(nightly, feature(doc_auto_cfg))]
6
7#[doc = include_str!(concat!("../",  core::env!("CARGO_PKG_README")))]
8#[cfg(doctest)]
9pub struct ReadmeDoctests;
10
11mod asserts;
12
13/// Block vectors, block matrices and utilities
14pub mod block;
15/// Example problems
16pub mod example_problems;
17/// Non-linear least squares optimization
18pub mod nlls;
19/// Robust kernel functions
20pub mod robust_kernel;
21/// Decision variables
22pub mod variables;
23/// sophus_opt prelude.
24///
25/// It is recommended to import this prelude when working with `sophus_opt types:
26///
27/// ```
28/// use sophus_opt::prelude::*;
29/// ```
30///
31/// or
32///
33/// ```ignore
34/// use sophus::prelude::*;
35/// ```
36///
37/// to import all preludes when using the `sophus` umbrella crate.
38pub mod prelude {
39    pub use sophus_autodiff::prelude::*;
40    pub use sophus_image::prelude::*;
41    pub use sophus_lie::prelude::*;
42    pub use sophus_sensor::prelude::*;
43
44    pub use crate::{
45        nlls::{
46            HasEqConstraintResidualFn,
47            HasResidualFn,
48            IsCostFn,
49            IsEqConstraintsFn,
50            IsEvaluatedCost,
51            MakeEvaluatedCostTerm,
52            MakeEvaluatedEqConstraint,
53        },
54        robust_kernel::IsRobustKernel,
55    };
56}