Expand description
[Reexported at the root of this crate.] Data structures for vector and matrix computations.
Re-exports§
pub use self::default_allocator::*;pub use self::dimension::*;pub use self::storage::*;
Modules§
- allocator
- Abstract definition of a matrix data storage allocator.
- constraint
- Compatibility constraints between matrix shapes, e.g., for addition or multiplication.
- coordinates
- Structures to which matrices and vector can be auto-dereferenced (through
Deref) to access components using their names. For example, ifvis a 3D vector, one can writev.zinstead ofv[2]. - default_
allocator - The default matrix data storage allocator.
- dimension
- Traits and tags for identifying the dimension of all algebraic entities.
- indexing
- Indexing
- iter
- Matrix iterators.
- storage
- Abstract definition of a matrix data storage.
- uninit
- Mechanisms for working with values that may not be initialized.
Structs§
- Array
Storage - A array-based statically sized matrix data storage.
- Euclidean
Norm - Euclidean norm.
- LpNorm
- Lp norm.
- Matrix
- The most generic column-major matrix (and vector) type.
- Slice
Storage - A matrix data storage for a matrix slice. Only contains an internal reference to another matrix data storage.
- Slice
Storage Mut - A mutable matrix data storage for mutable matrix slice. Only contains an internal mutable reference to another matrix data storage.
- Uniform
Norm - L-infinite norm aka. Chebytchev norm aka. uniform norm aka. suppremum norm.
- Unit
- A wrapper that ensures the underlying algebraic entity has a unit norm.
- VecStorage
- A Vec-based matrix data storage. It may be dynamically-sized.
Traits§
- Norm
- A trait for abstract matrix norms.
- Normed
- Trait implemented by entities scan be be normalized and put in an
Unitstruct. - Scalar
- The basic scalar type for all structures of
nalgebra. - Slice
Range - A range with a size that may be known at compile-time.
Type Aliases§
- DMatrix
- A dynamically sized column-major matrix.
- DMatrix
Slice - A column-major matrix slice dynamic numbers of rows and columns.
- DMatrix
Slice Mut - A column-major matrix slice dynamic numbers of rows and columns.
- DVector
- A dynamically sized column vector.
- DVector
Slice - A column vector slice dynamic numbers of rows and columns.
- DVector
Slice Mut - A column vector slice dynamic numbers of rows and columns.
- Matrix1
- A stack-allocated, column-major, 1x1 square matrix.
- Matrix2
- A stack-allocated, column-major, 2x2 square matrix.
- Matrix3
- A stack-allocated, column-major, 3x3 square matrix.
- Matrix4
- A stack-allocated, column-major, 4x4 square matrix.
- Matrix5
- A stack-allocated, column-major, 5x5 square matrix.
- Matrix6
- A stack-allocated, column-major, 6x6 square matrix.
- Matrix1x2
- A stack-allocated, column-major, 1x2 matrix.
- Matrix1x3
- A stack-allocated, column-major, 1x3 matrix.
- Matrix1x4
- A stack-allocated, column-major, 1x4 matrix.
- Matrix1x5
- A stack-allocated, column-major, 1x5 matrix.
- Matrix1x6
- A stack-allocated, column-major, 1x6 matrix.
- Matrix1xX
- A heap-allocated, row-major, matrix with 1 rows and a dynamic number of columns.
- Matrix2x1
- A stack-allocated, column-major, 2x1 matrix.
- Matrix2x3
- A stack-allocated, column-major, 2x3 matrix.
- Matrix2x4
- A stack-allocated, column-major, 2x4 matrix.
- Matrix2x5
- A stack-allocated, column-major, 2x5 matrix.
- Matrix2x6
- A stack-allocated, column-major, 2x6 matrix.
- Matrix2xX
- A heap-allocated, row-major, matrix with 2 rows and a dynamic number of columns.
- Matrix3x1
- A stack-allocated, column-major, 3x1 matrix.
- Matrix3x2
- A stack-allocated, column-major, 3x2 matrix.
- Matrix3x4
- A stack-allocated, column-major, 3x4 matrix.
- Matrix3x5
- A stack-allocated, column-major, 3x5 matrix.
- Matrix3x6
- A stack-allocated, column-major, 3x6 matrix.
- Matrix3xX
- A heap-allocated, row-major, matrix with 3 rows and a dynamic number of columns.
- Matrix4x1
- A stack-allocated, column-major, 4x1 matrix.
- Matrix4x2
- A stack-allocated, column-major, 4x2 matrix.
- Matrix4x3
- A stack-allocated, column-major, 4x3 matrix.
- Matrix4x5
- A stack-allocated, column-major, 4x5 matrix.
- Matrix4x6
- A stack-allocated, column-major, 4x6 matrix.
- Matrix4xX
- A heap-allocated, row-major, matrix with 4 rows and a dynamic number of columns.
- Matrix5x1
- A stack-allocated, column-major, 5x1 matrix.
- Matrix5x2
- A stack-allocated, column-major, 5x2 matrix.
- Matrix5x3
- A stack-allocated, column-major, 5x3 matrix.
- Matrix5x4
- A stack-allocated, column-major, 5x4 matrix.
- Matrix5x6
- A stack-allocated, column-major, 5x6 matrix.
- Matrix5xX
- A heap-allocated, row-major, matrix with 5 rows and a dynamic number of columns.
- Matrix6x1
- A stack-allocated, column-major, 6x1 matrix.
- Matrix6x2
- A stack-allocated, column-major, 6x2 matrix.
- Matrix6x3
- A stack-allocated, column-major, 6x3 matrix.
- Matrix6x4
- A stack-allocated, column-major, 6x4 matrix.
- Matrix6x5
- A stack-allocated, column-major, 6x5 matrix.
- Matrix6xX
- A heap-allocated, row-major, matrix with 6 rows and a dynamic number of columns.
- Matrix
Cross - The type of the result of a matrix cross product.
- MatrixMN
Deprecated - An owned matrix column-major matrix with
Rrows andCcolumns. - MatrixN
Deprecated - An owned matrix column-major matrix with
Dcolumns. - Matrix
Slice - A matrix slice.
- Matrix
Slice1 - A column-major 1x1 matrix slice.
- Matrix
Slice2 - A column-major 2x2 matrix slice.
- Matrix
Slice3 - A column-major 3x3 matrix slice.
- Matrix
Slice4 - A column-major 4x4 matrix slice.
- Matrix
Slice5 - A column-major 5x5 matrix slice.
- Matrix
Slice6 - A column-major 6x6 matrix slice.
- Matrix
Slice1x2 - A column-major 1x2 matrix slice.
- Matrix
Slice1x3 - A column-major 1x3 matrix slice.
- Matrix
Slice1x4 - A column-major 1x4 matrix slice.
- Matrix
Slice1x5 - A column-major 1x5 matrix slice.
- Matrix
Slice1x6 - A column-major 1x6 matrix slice.
- Matrix
Slice1xX - A column-major matrix slice with 1 row and a number of columns chosen at runtime.
- Matrix
Slice2x1 - A column-major 2x1 matrix slice.
- Matrix
Slice2x3 - A column-major 2x3 matrix slice.
- Matrix
Slice2x4 - A column-major 2x4 matrix slice.
- Matrix
Slice2x5 - A column-major 2x5 matrix slice.
- Matrix
Slice2x6 - A column-major 2x6 matrix slice.
- Matrix
Slice2xX - A column-major matrix slice with 2 rows and a number of columns chosen at runtime.
- Matrix
Slice3x1 - A column-major 3x1 matrix slice.
- Matrix
Slice3x2 - A column-major 3x2 matrix slice.
- Matrix
Slice3x4 - A column-major 3x4 matrix slice.
- Matrix
Slice3x5 - A column-major 3x5 matrix slice.
- Matrix
Slice3x6 - A column-major 3x6 matrix slice.
- Matrix
Slice3xX - A column-major matrix slice with 3 rows and a number of columns chosen at runtime.
- Matrix
Slice4x1 - A column-major 4x1 matrix slice.
- Matrix
Slice4x2 - A column-major 4x2 matrix slice.
- Matrix
Slice4x3 - A column-major 4x3 matrix slice.
- Matrix
Slice4x5 - A column-major 4x5 matrix slice.
- Matrix
Slice4x6 - A column-major 4x6 matrix slice.
- Matrix
Slice4xX - A column-major matrix slice with 4 rows and a number of columns chosen at runtime.
- Matrix
Slice5x1 - A column-major 5x1 matrix slice.
- Matrix
Slice5x2 - A column-major 5x2 matrix slice.
- Matrix
Slice5x3 - A column-major 5x3 matrix slice.
- Matrix
Slice5x4 - A column-major 5x4 matrix slice.
- Matrix
Slice5x6 - A column-major 5x6 matrix slice.
- Matrix
Slice5xX - A column-major matrix slice with 5 rows and a number of columns chosen at runtime.
- Matrix
Slice6x1 - A column-major 6x1 matrix slice.
- Matrix
Slice6x2 - A column-major 6x2 matrix slice.
- Matrix
Slice6x3 - A column-major 6x3 matrix slice.
- Matrix
Slice6x4 - A column-major 6x4 matrix slice.
- Matrix
Slice6x5 - A column-major 6x5 matrix slice.
- Matrix
Slice6xX - A column-major matrix slice with 6 rows and a number of columns chosen at runtime.
- Matrix
Slice Mut - A mutable matrix slice.
- Matrix
Slice Mut1 - A column-major 1x1 matrix slice.
- Matrix
Slice Mut2 - A column-major 2x2 matrix slice.
- Matrix
Slice Mut3 - A column-major 3x3 matrix slice.
- Matrix
Slice Mut4 - A column-major 4x4 matrix slice.
- Matrix
Slice Mut5 - A column-major 5x5 matrix slice.
- Matrix
Slice Mut6 - A column-major 6x6 matrix slice.
- Matrix
Slice Mut1x2 - A column-major 1x2 matrix slice.
- Matrix
Slice Mut1x3 - A column-major 1x3 matrix slice.
- Matrix
Slice Mut1x4 - A column-major 1x4 matrix slice.
- Matrix
Slice Mut1x5 - A column-major 1x5 matrix slice.
- Matrix
Slice Mut1x6 - A column-major 1x6 matrix slice.
- Matrix
Slice Mut1xX - A column-major matrix slice with 1 row and a number of columns chosen at runtime.
- Matrix
Slice Mut2x1 - A column-major 2x1 matrix slice.
- Matrix
Slice Mut2x3 - A column-major 2x3 matrix slice.
- Matrix
Slice Mut2x4 - A column-major 2x4 matrix slice.
- Matrix
Slice Mut2x5 - A column-major 2x5 matrix slice.
- Matrix
Slice Mut2x6 - A column-major 2x6 matrix slice.
- Matrix
Slice Mut2xX - A column-major matrix slice with 2 rows and a number of columns chosen at runtime.
- Matrix
Slice Mut3x1 - A column-major 3x1 matrix slice.
- Matrix
Slice Mut3x2 - A column-major 3x2 matrix slice.
- Matrix
Slice Mut3x4 - A column-major 3x4 matrix slice.
- Matrix
Slice Mut3x5 - A column-major 3x5 matrix slice.
- Matrix
Slice Mut3x6 - A column-major 3x6 matrix slice.
- Matrix
Slice Mut3xX - A column-major matrix slice with 3 rows and a number of columns chosen at runtime.
- Matrix
Slice Mut4x1 - A column-major 4x1 matrix slice.
- Matrix
Slice Mut4x2 - A column-major 4x2 matrix slice.
- Matrix
Slice Mut4x3 - A column-major 4x3 matrix slice.
- Matrix
Slice Mut4x5 - A column-major 4x5 matrix slice.
- Matrix
Slice Mut4x6 - A column-major 4x6 matrix slice.
- Matrix
Slice Mut4xX - A column-major matrix slice with 4 rows and a number of columns chosen at runtime.
- Matrix
Slice Mut5x1 - A column-major 5x1 matrix slice.
- Matrix
Slice Mut5x2 - A column-major 5x2 matrix slice.
- Matrix
Slice Mut5x3 - A column-major 5x3 matrix slice.
- Matrix
Slice Mut5x4 - A column-major 5x4 matrix slice.
- Matrix
Slice Mut5x6 - A column-major 5x6 matrix slice.
- Matrix
Slice Mut5xX - A column-major matrix slice with 5 rows and a number of columns chosen at runtime.
- Matrix
Slice Mut6x1 - A column-major 6x1 matrix slice.
- Matrix
Slice Mut6x2 - A column-major 6x2 matrix slice.
- Matrix
Slice Mut6x3 - A column-major 6x3 matrix slice.
- Matrix
Slice Mut6x4 - A column-major 6x4 matrix slice.
- Matrix
Slice Mut6x5 - A column-major 6x5 matrix slice.
- Matrix
Slice Mut6xX - A column-major matrix slice with 6 rows and a number of columns chosen at runtime.
- Matrix
Slice MutMN - A column-major matrix slice with
Rrows andCcolumns. - Matrix
Slice MutN - A column-major matrix slice with
Drows and columns. - Matrix
Slice MutXx1 - A column-major matrix slice with a number of rows chosen at runtime and 1 column.
- Matrix
Slice MutXx2 - A column-major matrix slice with a number of rows chosen at runtime and 2 columns.
- Matrix
Slice MutXx3 - A column-major matrix slice with a number of rows chosen at runtime and 3 columns.
- Matrix
Slice MutXx4 - A column-major matrix slice with a number of rows chosen at runtime and 4 columns.
- Matrix
Slice MutXx5 - A column-major matrix slice with a number of rows chosen at runtime and 5 columns.
- Matrix
Slice MutXx6 - A column-major matrix slice with a number of rows chosen at runtime and 6 columns.
- Matrix
Slice Xx1 - A column-major matrix slice with a number of rows chosen at runtime and 1 column.
- Matrix
Slice Xx2 - A column-major matrix slice with a number of rows chosen at runtime and 2 columns.
- Matrix
Slice Xx3 - A column-major matrix slice with a number of rows chosen at runtime and 3 columns.
- Matrix
Slice Xx4 - A column-major matrix slice with a number of rows chosen at runtime and 4 columns.
- Matrix
Slice Xx5 - A column-major matrix slice with a number of rows chosen at runtime and 5 columns.
- Matrix
Slice Xx6 - A column-major matrix slice with a number of rows chosen at runtime and 6 columns.
- Matrix
Sum - The type of the result of a matrix sum.
- Matrix
Vec Deprecated - Renamed to
VecStorage. - Matrix
Xx1 - A heap-allocated, column-major, matrix with a dynamic number of rows and 1 columns.
- Matrix
Xx2 - A heap-allocated, column-major, matrix with a dynamic number of rows and 2 columns.
- Matrix
Xx3 - A heap-allocated, column-major, matrix with a dynamic number of rows and 3 columns.
- Matrix
Xx4 - A heap-allocated, column-major, matrix with a dynamic number of rows and 4 columns.
- Matrix
Xx5 - A heap-allocated, column-major, matrix with a dynamic number of rows and 5 columns.
- Matrix
Xx6 - A heap-allocated, column-major, matrix with a dynamic number of rows and 6 columns.
- OMatrix
- An owned matrix column-major matrix with
Rrows andCcolumns. - OVector
- An owned D-dimensional column vector.
- RowD
Vector - A dynamically sized row vector.
- RowO
Vector - An owned D-dimensional row vector.
- RowS
Vector - A statically sized D-dimensional row vector.
- RowVector
- A matrix with one row and
Dcolumns . - RowVector1
- A stack-allocated, 1-dimensional row vector.
- RowVector2
- A stack-allocated, 2-dimensional row vector.
- RowVector3
- A stack-allocated, 3-dimensional row vector.
- RowVector4
- A stack-allocated, 4-dimensional row vector.
- RowVector5
- A stack-allocated, 5-dimensional row vector.
- RowVector6
- A stack-allocated, 6-dimensional row vector.
- SMatrix
- A statically sized column-major matrix with
Rrows andCcolumns. - SMatrix
Slice - A column-major matrix slice with dimensions known at compile-time.
- SMatrix
Slice Mut - A column-major matrix slice with dimensions known at compile-time.
- SVector
- A statically sized D-dimensional column vector.
- SVector
Slice - A column vector slice with dimensions known at compile-time.
- SVector
Slice Mut - A column vector slice with dimensions known at compile-time.
- Square
Matrix - A square matrix.
- Uninit
Matrix - An owned matrix with uninitialized data.
- Uninit
Vector - An owned matrix with uninitialized data.
- Unit
Vector1 - A stack-allocated, 1-dimensional unit vector.
- Unit
Vector2 - A stack-allocated, 2-dimensional unit vector.
- Unit
Vector3 - A stack-allocated, 3-dimensional unit vector.
- Unit
Vector4 - A stack-allocated, 4-dimensional unit vector.
- Unit
Vector5 - A stack-allocated, 5-dimensional unit vector.
- Unit
Vector6 - A stack-allocated, 6-dimensional unit vector.
- Vector
- A matrix with one column and
Drows. - Vector1
- A stack-allocated, 1-dimensional column vector.
- Vector2
- A stack-allocated, 2-dimensional column vector.
- Vector3
- A stack-allocated, 3-dimensional column vector.
- Vector4
- A stack-allocated, 4-dimensional column vector.
- Vector5
- A stack-allocated, 5-dimensional column vector.
- Vector6
- A stack-allocated, 6-dimensional column vector.
- VectorN
Deprecated - An owned matrix column-major matrix with
Rrows andCcolumns. - Vector
Slice - A column vector slice with dimensions known at compile-time.
- Vector
Slice1 - A 1D column vector slice.
- Vector
Slice2 - A 2D column vector slice.
- Vector
Slice3 - A 3D column vector slice.
- Vector
Slice4 - A 4D column vector slice.
- Vector
Slice5 - A 5D column vector slice.
- Vector
Slice6 - A 6D column vector slice.
- Vector
Slice Mut - A column vector slice with dimensions known at compile-time.
- Vector
Slice Mut1 - A 1D column vector slice.
- Vector
Slice Mut2 - A 2D column vector slice.
- Vector
Slice Mut3 - A 3D column vector slice.
- Vector
Slice Mut4 - A 4D column vector slice.
- Vector
Slice Mut5 - A 5D column vector slice.
- Vector
Slice Mut6 - A 6D column vector slice.
- Vector
Sum - The type of the result of a matrix sum.