glamx 0.3.0

Extensions for glam: Pose2, Pose3, Rot2, and matrix utilities.
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

//! # glamx - Extensions for glam
//!
//! This crate provides additional types and utilities for the `glam` math library:
//!
//! - [`Rot2`] / [`DRot2`]: 2D rotations represented as unit complex numbers
//! - [`Rot3`] / [`DRot3`]: 3D rotations (re-exports of glam's quaternions)
//! - [`Pose2`] / [`DPose2`]: 2D rigid body transformations (rotation + translation)
//! - [`Pose3`] / [`DPose3`]: 3D rigid body transformations (rotation + translation)
//! - [`MatExt`]: Extension traits for glam matrix types
//! - [`SymmetricEigen2`] / [`SymmetricEigen3`]: Eigendecomposition for symmetric matrices
//! - [`Svd2`] / [`Svd3`]: Singular Value Decomposition for 2x2 and 3x3 matrices
//!
//! ## Naming Convention
//!
//! Types without a prefix use `f32` precision, while types with a `D` prefix use `f64` precision:
//! - `Rot2` (f32) / `DRot2` (f64)
//! - `Pose2` (f32) / `DPose2` (f64)
//! - `SymmetricEigen2` (f32) / `DSymmetricEigen2` (f64)
//!
//! ## Feature Flags
//!
//! - `std` (default): Enables standard library support
//! - `serde`: Enables serialization support via serde
//! - `bytemuck`: Enables bytemuck derive for Rot2/DRot2
//! - `nalgebra`: Enables conversions to/from nalgebra types
//! - `libm`: Uses libm for no_std math operations
//!
//! ### Type-gating features (mirror glam 0.33)
//!
//! These transitively enable the matching feature on `glam`. They control which
//! type aliases the underlying `glam` re-export exposes; glamx adds extension
//! types only for the floating-point variants, so disabling `f64` also removes
//! all `D*` types (DRot2, DPose2, DSymmetricEigen2, ...).
//!
//! - `all-types` (default): enables `float-types`, `integer-types`, `size-types`.
//! - `float-types`: enables `f64`.
//! - `integer-types`: enables `i8`, `u8`, `i16`, `u16`, `i32`, `u32`, `i64`, `u64`.
//! - `size-types`: enables `isize`, `usize`.
//! - Individual features: `f64`, `i8`, `u8`, `i16`, `u16`, `i32`, `u32`, `i64`,
//!   `u64`, `isize`, `usize`.
//!
//! ## glam Re-exports
//!
//! This crate re-exports all of glam's types so you can use it as a drop-in replacement without
//! an explicit dependency to `glam`.
//! Alternatively, depending on your coding style preferences, you can use the `glam` re-export.

#![no_std]

#[cfg(feature = "std")]
extern crate std;

// Re-export approx for convenience
#[cfg(feature = "approx")]
pub use approx;
/// Re-export of the glam crate.
pub use glam;

mod eigen2;
mod eigen3;
mod matrix_ext;
mod pose2;
mod pose3;
mod rot2;
mod rot3;
mod svd2;
mod svd3;

#[cfg(feature = "f64")]
pub use eigen2::DSymmetricEigen2;
pub use eigen2::SymmetricEigen2;
#[cfg(feature = "f64")]
pub use eigen3::DSymmetricEigen3;
pub use eigen3::{SymmetricEigen3, SymmetricEigen3A};
pub use glam::*;
pub use matrix_ext::MatExt;
#[cfg(feature = "f64")]
pub use pose2::DPose2;
pub use pose2::Pose2;
#[cfg(feature = "f64")]
pub use pose3::DPose3;
pub use pose3::{Pose3, Pose3A};
#[cfg(feature = "f64")]
pub use rot2::DRot2;
pub use rot2::Rot2;
#[cfg(feature = "f64")]
pub use rot3::DRot3;
pub use rot3::Rot3;
#[cfg(feature = "f64")]
pub use svd2::DSvd2;
pub use svd2::Svd2;
#[cfg(feature = "f64")]
pub use svd3::DSvd3;
pub use svd3::{Svd3, Svd3A};

/// Prelude module for convenient imports.
///
/// This module re-exports all public types and traits.
pub mod prelude {
    #[cfg(feature = "f64")]
    pub use crate::eigen2::DSymmetricEigen2;
    pub use crate::eigen2::SymmetricEigen2;
    #[cfg(feature = "f64")]
    pub use crate::eigen3::DSymmetricEigen3;
    pub use crate::eigen3::{SymmetricEigen3, SymmetricEigen3A};
    pub use crate::matrix_ext::MatExt;
    #[cfg(feature = "f64")]
    pub use crate::pose2::DPose2;
    pub use crate::pose2::Pose2;
    #[cfg(feature = "f64")]
    pub use crate::pose3::DPose3;
    pub use crate::pose3::Pose3;
    #[cfg(feature = "f64")]
    pub use crate::rot2::DRot2;
    pub use crate::rot2::Rot2;
    #[cfg(feature = "f64")]
    pub use crate::rot3::DRot3;
    pub use crate::rot3::Rot3;
    #[cfg(feature = "f64")]
    pub use crate::svd2::DSvd2;
    pub use crate::svd2::Svd2;
    #[cfg(feature = "f64")]
    pub use crate::svd3::DSvd3;
    pub use crate::svd3::{Svd3, Svd3A};
}