diff --git a/src/base/alias.rs b/src/base/alias.rs index 7e64de0d..0f62a6e5 100644 --- a/src/base/alias.rs +++ b/src/base/alias.rs @@ -14,138 +14,242 @@ use crate::base::Matrix; * */ /// A statically sized column-major matrix with `R` rows and `C` columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[deprecated(note = "This matrix name contains a typo. Use MatrixMN instead.")] pub type MatrixNM = Matrix>; /// A statically sized column-major matrix with `R` rows and `C` columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixMN = Matrix>; /// A statically sized column-major square matrix with `D` rows and columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixN = Matrix>; /// A dynamically sized column-major matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type DMatrix = Matrix>; /// A heap-allocated, column-major, matrix with a dynamic number of rows and 1 columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type MatrixXx1 = Matrix>; /// A heap-allocated, column-major, matrix with a dynamic number of rows and 2 columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type MatrixXx2 = Matrix>; /// A heap-allocated, column-major, matrix with a dynamic number of rows and 3 columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type MatrixXx3 = Matrix>; /// A heap-allocated, column-major, matrix with a dynamic number of rows and 4 columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type MatrixXx4 = Matrix>; /// A heap-allocated, column-major, matrix with a dynamic number of rows and 5 columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type MatrixXx5 = Matrix>; /// A heap-allocated, column-major, matrix with a dynamic number of rows and 6 columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type MatrixXx6 = Matrix>; /// A heap-allocated, row-major, matrix with 1 rows and a dynamic number of columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type Matrix1xX = Matrix>; /// A heap-allocated, row-major, matrix with 2 rows and a dynamic number of columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type Matrix2xX = Matrix>; /// A heap-allocated, row-major, matrix with 3 rows and a dynamic number of columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type Matrix3xX = Matrix>; /// A heap-allocated, row-major, matrix with 4 rows and a dynamic number of columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type Matrix4xX = Matrix>; /// A heap-allocated, row-major, matrix with 5 rows and a dynamic number of columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type Matrix5xX = Matrix>; /// A heap-allocated, row-major, matrix with 6 rows and a dynamic number of columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** #[cfg(any(feature = "std", feature = "alloc"))] pub type Matrix6xX = Matrix>; /// A stack-allocated, column-major, 1x1 square matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix1 = Matrix>; /// A stack-allocated, column-major, 2x2 square matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix2 = Matrix>; /// A stack-allocated, column-major, 3x3 square matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix3 = Matrix>; /// A stack-allocated, column-major, 4x4 square matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix4 = Matrix>; /// A stack-allocated, column-major, 5x5 square matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix5 = Matrix>; /// A stack-allocated, column-major, 6x6 square matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix6 = Matrix>; /// A stack-allocated, column-major, 1x2 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix1x2 = Matrix>; /// A stack-allocated, column-major, 1x3 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix1x3 = Matrix>; /// A stack-allocated, column-major, 1x4 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix1x4 = Matrix>; /// A stack-allocated, column-major, 1x5 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix1x5 = Matrix>; /// A stack-allocated, column-major, 1x6 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix1x6 = Matrix>; /// A stack-allocated, column-major, 2x3 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix2x3 = Matrix>; /// A stack-allocated, column-major, 2x4 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix2x4 = Matrix>; /// A stack-allocated, column-major, 2x5 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix2x5 = Matrix>; /// A stack-allocated, column-major, 2x6 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix2x6 = Matrix>; /// A stack-allocated, column-major, 3x4 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix3x4 = Matrix>; /// A stack-allocated, column-major, 3x5 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix3x5 = Matrix>; /// A stack-allocated, column-major, 3x6 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix3x6 = Matrix>; /// A stack-allocated, column-major, 4x5 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix4x5 = Matrix>; /// A stack-allocated, column-major, 4x6 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix4x6 = Matrix>; /// A stack-allocated, column-major, 5x6 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix5x6 = Matrix>; /// A stack-allocated, column-major, 2x1 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix2x1 = Matrix>; /// A stack-allocated, column-major, 3x1 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix3x1 = Matrix>; /// A stack-allocated, column-major, 4x1 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix4x1 = Matrix>; /// A stack-allocated, column-major, 5x1 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix5x1 = Matrix>; /// A stack-allocated, column-major, 6x1 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix6x1 = Matrix>; /// A stack-allocated, column-major, 3x2 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix3x2 = Matrix>; /// A stack-allocated, column-major, 4x2 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix4x2 = Matrix>; /// A stack-allocated, column-major, 5x2 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix5x2 = Matrix>; /// A stack-allocated, column-major, 6x2 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix6x2 = Matrix>; /// A stack-allocated, column-major, 4x3 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix4x3 = Matrix>; /// A stack-allocated, column-major, 5x3 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix5x3 = Matrix>; /// A stack-allocated, column-major, 6x3 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix6x3 = Matrix>; /// A stack-allocated, column-major, 5x4 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix5x4 = Matrix>; /// A stack-allocated, column-major, 6x4 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix6x4 = Matrix>; /// A stack-allocated, column-major, 6x5 matrix. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type Matrix6x5 = Matrix>; /* diff --git a/src/base/alias_slice.rs b/src/base/alias_slice.rs index 9efbf857..d919fef9 100644 --- a/src/base/alias_slice.rs +++ b/src/base/alias_slice.rs @@ -10,129 +10,207 @@ use crate::base::Matrix; * */ /// A column-major matrix slice with `R` rows and `C` columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMN<'a, N, R, C, RStride = U1, CStride = R> = Matrix>; /// A column-major matrix slice with `D` rows and columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceN<'a, N, D, RStride = U1, CStride = D> = Matrix>; /// A column-major matrix slice dynamic numbers of rows and columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type DMatrixSlice<'a, N, RStride = U1, CStride = Dynamic> = Matrix>; /// A column-major 1x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice1<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 2x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice2<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 3x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice3<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 4x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice4<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 5x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice5<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 6x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice6<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 1x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice1x2<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice1x3<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice1x4<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice1x5<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice1x6<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 2x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice2x1<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice2x3<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice2x4<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice2x5<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice2x6<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 3x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice3x1<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice3x2<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice3x4<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice3x5<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice3x6<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 4x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice4x1<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice4x2<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice4x3<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice4x5<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice4x6<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 5x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice5x1<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice5x2<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice5x3<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice5x4<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice5x6<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 6x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice6x1<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice6x2<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice6x3<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice6x4<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSlice6x5<'a, N, RStride = U1, CStride = U6> = Matrix>; @@ -183,21 +261,33 @@ pub type DVectorSlice<'a, N, RStride = U1, CStride = Dynamic> = Matrix>; /// A 1D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSlice1<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A 2D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSlice2<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A 3D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSlice3<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A 4D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSlice4<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A 5D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSlice5<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A 6D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSlice6<'a, N, RStride = U1, CStride = U6> = Matrix>; @@ -209,129 +299,207 @@ pub type VectorSlice6<'a, N, RStride = U1, CStride = U6> = * */ /// A column-major matrix slice with `R` rows and `C` columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMutMN<'a, N, R, C, RStride = U1, CStride = R> = Matrix>; /// A column-major matrix slice with `D` rows and columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMutN<'a, N, D, RStride = U1, CStride = D> = Matrix>; /// A column-major matrix slice dynamic numbers of rows and columns. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type DMatrixSliceMut<'a, N, RStride = U1, CStride = Dynamic> = Matrix>; /// A column-major 1x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut1<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 2x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut2<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 3x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut3<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 4x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut4<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 5x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut5<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 6x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut6<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 1x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut1x2<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut1x3<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut1x4<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut1x5<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 1x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut1x6<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A column-major 2x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut2x1<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut2x3<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut2x4<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut2x5<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 2x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut2x6<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A column-major 3x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut3x1<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut3x2<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut3x4<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut3x5<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 3x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut3x6<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A column-major 4x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut4x1<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut4x2<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut4x3<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut4x5<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 4x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut4x6<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A column-major 5x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut5x1<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut5x2<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut5x3<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut5x4<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 5x6 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut5x6<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A column-major 6x1 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut6x1<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x2 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut6x2<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x3 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut6x3<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x4 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut6x4<'a, N, RStride = U1, CStride = U6> = Matrix>; /// A column-major 6x5 matrix slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type MatrixSliceMut6x5<'a, N, RStride = U1, CStride = U6> = Matrix>; @@ -382,20 +550,32 @@ pub type DVectorSliceMut<'a, N, RStride = U1, CStride = Dynamic> = Matrix>; /// A 1D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSliceMut1<'a, N, RStride = U1, CStride = U1> = Matrix>; /// A 2D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSliceMut2<'a, N, RStride = U1, CStride = U2> = Matrix>; /// A 3D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSliceMut3<'a, N, RStride = U1, CStride = U3> = Matrix>; /// A 4D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSliceMut4<'a, N, RStride = U1, CStride = U4> = Matrix>; /// A 5D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSliceMut5<'a, N, RStride = U1, CStride = U5> = Matrix>; /// A 6D column vector slice. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Matrix`](crate::base::Matrix) type too.** pub type VectorSliceMut6<'a, N, RStride = U1, CStride = U6> = Matrix>; diff --git a/src/geometry/isometry_alias.rs b/src/geometry/isometry_alias.rs index 69d33cb4..8eecd3ee 100644 --- a/src/geometry/isometry_alias.rs +++ b/src/geometry/isometry_alias.rs @@ -2,16 +2,33 @@ use crate::base::dimension::{U2, U3}; use crate::geometry::{Isometry, Rotation2, Rotation3, UnitComplex, UnitQuaternion}; -/// A 2-dimensional direct isometry using a unit complex number for its rotational part. Also known as a rigid-body motion, or as an element of SE(2). +/// A 2-dimensional direct isometry using a unit complex number for its rotational part. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Isometry`](crate::Isometry) type too.** +/// +/// Also known as a 2D rigid-body motion, or as an element of SE(2). + pub type Isometry2 = Isometry>; -/// A 3-dimensional direct isometry using a unit quaternion for its rotational part. Also known as a rigid-body motion, or as an element of SE(3). +/// A 3-dimensional direct isometry using a unit quaternion for its rotational part. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Isometry`](crate::Isometry) type too.** +/// +/// Also known as a rigid-body motion, or as an element of SE(3). pub type Isometry3 = Isometry>; -/// A 2-dimensional direct isometry using a rotation matrix for its rotational part. Also known as a rigid-body motion, or as an element of SE(2). +/// A 2-dimensional direct isometry using a rotation matrix for its rotational part. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Isometry`](crate::Isometry) type too.** +/// +/// Also known as a rigid-body motion, or as an element of SE(2). pub type IsometryMatrix2 = Isometry>; -/// A 3-dimensional direct isometry using a rotation matrix for its rotational part. Also known as a rigid-body motion, or as an element of SE(3). +/// A 3-dimensional direct isometry using a rotation matrix for its rotational part. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Isometry`](crate::Isometry) type too.** +/// +/// Also known as a rigid-body motion, or as an element of SE(3). pub type IsometryMatrix3 = Isometry>; // This tests that the types correctly implement `Copy`, without having to run tests diff --git a/src/geometry/point_alias.rs b/src/geometry/point_alias.rs index 83f57301..05874ae4 100644 --- a/src/geometry/point_alias.rs +++ b/src/geometry/point_alias.rs @@ -3,14 +3,26 @@ use crate::base::dimension::{U1, U2, U3, U4, U5, U6}; use crate::geometry::Point; /// A statically sized 1-dimensional column point. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Point`](crate::Point) type too.** pub type Point1 = Point; /// A statically sized 2-dimensional column point. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Point`](crate::Point) type too.** pub type Point2 = Point; /// A statically sized 3-dimensional column point. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Point`](crate::Point) type too.** pub type Point3 = Point; /// A statically sized 4-dimensional column point. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Point`](crate::Point) type too.** pub type Point4 = Point; /// A statically sized 5-dimensional column point. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Point`](crate::Point) type too.** pub type Point5 = Point; /// A statically sized 6-dimensional column point. +/// +/// **Because this is an alias, not all its methods are listed here. See the [`Point`](crate::Point) type too.** pub type Point6 = Point;