All notable changes to nalgebra
, starting with the version 0.6.0 will be
documented here.
This project adheres to Semantic Versioning.
- The
cuda
feature has been removed, as the toolchain it depends on is long abandoned.
- Statically sized matrices are now serialized as tuples to match how serde serialized plain arrays.
- Don’t require
Scalar
for matrixPartialEq
andEq
.
- Allow trailing punctuation in macros
vector!
,matrix!
,point!
, etc. - Add the methods
Matrix1::as_scalar
,::as_scalar_mut
,::to_scalar
,::into_scalar
. - Add
Rotation3::euler_angles_ordered
, a generalized euler angles calculation. - Add the
glam-0.24
feature to enable conversion from/to types fromglam
v0.24. - Add the
glam-0.25
feature to enable conversion from/to types fromglam
v0.25. - Add the
lerp
method to points. - Implement
Clone
forMatrixIter
.
- Fixed severe catastrophic cancellation issue in variance calculation.
- Add the
glam-0.23
to enable conversion from/to type fromglam
v0.23.
- Updated
nalgebra-macros
to use the newDyn
, avoiding macro-generated deprecation warnings.
- Renamed all
MatrixSlice
types toMatrixView
. In general all occurrences of the worldSlice
orslice
have been replaced byView
orview
. - Deprecated all the types involving
Slice
in its name, in favor of the wordView
. - Make it so that most
nalgebra
objects archive as themselves (when usingrkyv
for serialization). - Renamed
Dynamic
toDyn
and makeDyn
a tuple struct.
- Add
Cholesky::ln_determinant
to compute the natural logarithm of the determinant of a matrix decomposed with Cholesky. This can be more numerically stable than computing the determinant itself when very small and/or large values are involved. - Added new methods
Matrix::as_view
andMatrix::as_view_mut
, which are very useful when working with view-based APIs. - Added parallel column iterator using
rayon
:Matrix::par_column_iter
andMatrix::par_column_iter_mut
. Therayon
feature must be enabled to access these methods. - Implement
ReshapableStorage
for matrix slices (only for unit strides at the moment). - Add
U0, U1, …
constants alongside theU0, U1, …
types. This lets us writeU4
instead ofU4::name()
orConst::<4>
when we need const dimensions.
- Fixed the implementation of
Rotation3::euler_angles
to return the angles in the documented order (roll, pitch, yaw).
- Add a
convert-glam022
feature to enable conversion betweennalgebra
andglam v0.22
.
- Add
Matrix::try_cast
to attempt casting the inner scalar types when that cast may fail.
- Fixed the usage of
CheckBytes
withrkyv
.
- Use
#[inline]
on theDim
implementation forConst
to improve opt-level 1 performance. - Make the
Point::new
constructions const-fn.
- Add
UnitVector::cast
to change the underlying scalar type.
- Improve performances of multiplication of two sparse matrices.
- Add
Matrix::from_row_iterator
to build a matrix from an iterator yielding components in row-major order. - Add support for conversion from/to types of
glam
0.21. nalgebra-sparse
: add support for the matrix-market export of sparse matrices.nalgebra-lapack
: add aGE
for solving the generalized eigenvalues problem.
- Fix
Rotation3::from_matrix
andUnitQuaternion::from_matrix
when the input matrix is already a valid rotation matrix.
- Switch to
cust
0.3 (for CUDA support). - Switch to
rkyv
0.7 - Remove support for serialization based on
abomonation
. - Remove support for conversions between
nalgebra
types andglam
0.13.
- The aliases for
Const
types have been simplified to helprust-analyzer
.
- Add
TryFrom
conversion betweenUnitVector2/3/4
andglam
’sVec2/3/4
. nalgebra-sparse
: added support for serialization of sparse matrices withserde
.nalgebra-sparse
: add a CSC matrix constructor from unsorted (but valid) data.nalgebra-lapack
: add generalized eigenvalues/eigenvectors calculation + QZ decomposition.
- Improve stability of SVD.
- Fix slerp for
UnitComplex
.
- Add conversion from/to types of
glam
0.19 and 0.20.
- The
Dim
trait is now marked as unsafe. - The
Matrix::pow
andMatrix::pow_mut
methods only allow positive integer exponents now. To compute negative exponents, the user is free to invert the matrix before callingpow
with the exponent’s absolute value. - Remove the
Bounded
requirement fromRealField
. Replace it by methods returningOption<Self>
so that they can still be implemented by unbounded types (by returningNone
). - The
ComplexField
trait derives fromFromPrimitive
again. We can actually keep this because all its methods returnOption<Self>
, meaning that it could be implemented by any type.
- Use more concise debug impls for matrices and geometric transformation types.
- The singular values computed by the SVD are now sorted in increasing order by default. Use
SVD::new_unordered
instead to reproduce the older behavior without the sorting overhead. - The
UnitDualQuaternion::sclerp
method will no longer panic when given two equal rotations. - The
Matrix::select_rows
andMatrix::select_columns
methods no longer require the matrix components to implement the traitZero
. - The
Matrix::pow
andMatrix::pow_mut
methods will now also work with integer matrices.
- Added the conversion trait
From<Vec<T>>
and methodfrom_vec_storage
forRowDVector
. - Added implementation of
From
andInto
for converting betweennalgebra
types and types fromglam 0.18
. These can be enabled by enabling theconvert-glam018
cargo features. - Added the methods
Matrix::product
,::row_product
,::row_product_tr
, and::column_product
to compute the product of the components, rows, or columns, of a single matrix or vector. - The
Default
trait is now implemented for most geometric types:Point
,Isometry
,Rotation
,Similarity
,Transform
,UnitComplex
, andUnitQuaternion
. - Added the
Scale
geometric type for representing non-uniform scaling. - Added
Cholesky::new_with_substitute
that will replace diagonal elements by a given constant wheneverCholesky
meets a non-definite-positiveness. - Re-added the conversion from a vector/matrix slice to a static array.
- Added the
cuda
feature that enables the support of rust-cuda for usingnalgebra
features with CUDA kernels written in Rust. - Added special-cases implementations for the 2x2 and 3x3 SVDs for better accuracy and performances.
- Added the methods
Matrix::polar
,Matrix::try_polar
, andSVD::to_polar
to compute the polar decomposition of a matrix, based on its SVD. nalgebra-sparse
: provide constructors for unsorted but otherwise valid data using the CSR format.nalgebra-sparse
: added reading MatrixMarked data files to a sparseCooMatrix
.
- Fixed a potential unsoundness with
matrix.get(i)
andmatrix.get_mut(i)
wherei
is anusize
, andmatrix
is a matrix slice with non-default strides. - Fixed potential unsoundness with
vector.perp
wherevector
isn’t actually a 2D vector as expected. - Fixed linkage issue with
nalgebra-lapack
: the user ofnalgebra-lapack
no longer have to addextern crate lapack-src
to theirmain.rs
. - Fixed the
no-std
build ofnalgebra-glm
. - Fix the
pow
andpow_mut
functions (the result was incorrect for some exponent values).
- We updated to the version 0.6 of
simba
. This means that the trait boundsT: na::RealField
,na::ComplexField
,na::SimdRealField
,na:SimdComplexField
no imply thatT: Copy
(they only imply thatT: Clone
). This may affect generic code. - The closure given to
apply
,zip_apply
,zip_zip_apply
must now modify the first argument inplace, instead of returning a new value. This makes these methods more versatile, and avoid useless clones when using non-Copy scalar types. - The
Allocator
trait signature has been significantly modified in order to handle uninitialized matrices in a sound way.
Orthographic3::from_matrix_unchecked
is nowconst fn
.Perspective3::from_matrix_unchecked
is nowconst fn
.Rotation::from_matrix_unchecked
is nowconst fn
.- The
Scalar
is now automatically implemented for most'static + Clone
types. Type that implementClone
but notCopy
are now much safer to work with thanks to the refactoring of theAllocator
system.
- The conversion traits form the
bytemuck
crates are now implemented for the geometric types too. - Added operator overloading for
Transform * UnitComplex
,UnitComplex * Transform
,Transform ×= UnitComplex
,Transform ÷= UnitComplex
. - Added
Reflection::bias()
to retrieve the bias of the reflection. - Added
Reflection1..Reflection6
aliases for 1D to 6D reflections. - Added implementation of
From
andInto
for converting betweennalgebra
types and types fromglam 0.16
andglam 0.17
. These can be enabled by enabling theconvert-glam016
, and/orconvert-glam017
cargo features.
- Implement
Hash
forTransform
. - Implement
Borrow
andBorrowMut
for contiguous slices.
- The
OPoint<T, D>
type has been added. It takes the dimension number as a type-level integer (e.g.Const<3>
) instead of a const-generic. The typePoint<T, const D: usize>
is now an alias forOPoint
. This changes doesn't affect any of the existing code usingPoint
. However, it will allow the useOPoint
in a generic context where the dimension cannot be easily expressed as a const-generic (because of the current limitation of const-generics in Rust). - Several clippy warnings were fixed. This results in some method signature changes (e.g. taking
self
instead of&self
) but this should not have any practical infulances on existing codebase. - The
Point::new
constructors are no longer const-fn. This is due to some limitations in const-fn not allowing custom trait-bounds. Use thepoint!
macro instead to build points in const environments. Dynamic::new
andUnit::new_unchecked
are now const-fn.- Methods returning
Result<(), ()>
now returnbool
instead.
- Fixed a potential unsoundess issue when converting a mutable slice to a
&mut[T]
.
- Fixed a bug in the conversion from
glam::Vec2
orglam::DVec2
toIsometry2
.
This removes the convert-glam
and convert-glam-unchecked
optional features.
Instead, this adds the convert-glam013
, convert-glam014
, and convert-glam015
optional features for
conversions targeting the versions 0.13, 0.14, and 0.15 of glam
.
- Add macros
matrix!
,dmatrix!
,vector!
,dvector!
,point!
for constructing matrices/vectors/points in a more convenient way. See #886 and #899. - Add
CooMatrix::reserve
tonalgebra-sparse
. - Add basic support for serialization using
rkyv
. Can be enabled with the featuresrkyv-serialize
orrkyv-serialize-no-std
.
- Fixed a potential unsoundness issue after deserializing an invalid
DVector
usingserde
.
- Conversion from an array
[T; D]
to an isometryIsometry<T, _, D>
(as a translation). - Conversion from a static vector
SVector<T; D>
to an isometryIsometry<T, _, D>
(as a translation). - Conversion from a point
Point<T; D>
to an isometryIsometry<T, _, D>
(as a translation). - Conversion of an array
[T; D]
from/to a translationTranslation<T, D>
. - Conversion of a point
Point<T, D>
to a translationTranslation<T, D>
. - Conversion of the tuple of glam types
(Vec3, Quat)
from/to anIsometry2
orIsometry3
. - Conversion of a glam type
Vec2/3/4
from/to aTranslation2/3/4
.
Fix a regression introduced in 0.26.0 preventing DVector
from being serialized with serde
.
This release integrates min-const-generics
to nalgebra. See
our blog post
for details about this release.
- Add type aliases for unit vector, e.g.,
UnitVector3
. - Add a
pow
andpow_mut
function to square matrices. - Add
Cholesky::determinant
to compute the determinant of a matrix decomposed with Cholesky. - Add the
serde-serialize-no-std
feature to enable serialization of static matrices/vectors with serde, but without requiringstd
.
- The
serde
crate isn't enabled by default now. Enable theserde-serialize
or theserde-serialize-no-std
features instead. - The
Const<const D: usize>
type has been introduced to represent dimensions known at compile-time. This replaces the type-level integers fromtypenum
as well as theU1, U2, ..., U127
types fromnalgebra
. TheseU1, U2, ..., U127
are now just aliases forConst<D>
, e.g.,type U2 = Const<2>
. - The
ArrayStorage
now uses a standard array[[T; R]; C]
instead of aGenericArray
. - Many trait bounds were changed to accommodate const-generics. Most of these changes should be transparent wrt. non-generic code.
- The
MatrixMN
alias has been deprecated. UseOMatrix
orSMatrix
instead. - The
MatrixN<T, D>
alias has been deprecated. UseOMatrix<T, D, D>
orSMatrix
instead. - The
VectorN<T, D>
alias has been deprecated. UseOVector
orSVector
instead. - The
Point
,Translation
,Isometry
,Similarity
, andTransformation
types now take an integer for their dimension (instead of a type-level integer). - The type parameter order of
Isometry
,Similarity
,Transformation
changed to put the integer dimensions in the last position (this is required by the compiler). - The
::new
constructors of translations, points, matrices, and vectors of dimensions<= 6
are nowconst fn
, making them usable to define constant globals. TheQuaternion::new
constructor is also aconst fn
now.
- Fix a compilation error when only the
serde-serialize
feature is enabled.
- The
Vector::simd_cap_magnitude
method to cap the magnitude of the vector with SIMD components.
- A
convert-glam
cargo feature to enable implementations ofFrom
traits to convert betweenglam
types andnalgebra
types. - A
convert-glam-unchecked
cargo feature to enable some extraglam
/nalgebra
conversions that may lead to unexpected results if used improperly. For example, this enables the conversion from aglam::Mat4
to ana::Isometry3
. This conversion will be cheap (without any check) but willlead to unexpected results if the glam matrix contains non-isometric components (like scaling for example). - A
cast
method has been added to most types. This can be used to change the type of the components of a given entity. Example:vector.cast::<f32>()
.
This release replaces the version 0.25.0 which has been yanked. The 0.25.0 version
added significant complication to build nalgebra
targeting a #[no-std]
platform
not supported by rand
.
The rand
dependency is now optional (and disabled by default). You may enable it with:
- The
rand-no-std
cargo feature when targeting a#[no-std]
environment. - The
rand
cargo feature when targeting astd
environment.
This updates all the dependencies of nalgebra to their latest version, including:
- rand 0.8
- proptest 1.0
- simba 0.4
Alongside this release of nalgebra
, we are releasing nalgebra-sparse
: a crate dedicated to sparse matrix
computation with nalgebra
. The sparse
module of nalgebra
itself still exists for backward compatibility,
but it will be deprecated soon in favor of the nalgebra-sparse
crate.
- Add
UnitDualQuaternion
, a dual-quaternion with unit magnitude which can be used as an isometry transformation. - Add
UDU::new()
andmatrix.udu()
to compute the UDU factorization of a matrix. - Add
ColPivQR::new()
andmatrix.col_piv_qr()
to compute the QR decomposition with column pivoting of a matrix. - Add
from_basis_unchecked
to all the rotation types. This builds a rotation from a set of basis vectors (representing the columns of the corresponding rotation matrix). - Add
Matrix::cap_magnitude
to cap the magnitude of a vector. - Add
UnitQuaternion::append_axisangle_linearized
to approximately append a rotation represented as an axis-angle to a rotation represented as an unit quaternion. - Mark the iterators on matrix components as
DoubleEndedIter
. - Re-export
simba::simd::SimdValue
at the root of thenalgebra
crate.
- The
DualQuaternion
type. It is still work-in-progress, but the basics are here: creation from its real and dual part, multiplication of two dual quaternions, and normalization.
- There is no blanket
impl<T> PartialEq for Unit<T>
anymore. Instead, it is implemented specifically forUnitComplex
,UnitQuaternion
andUnit<Vector>
.
In this release, we improved the documentation of some of the geometric types by applying changes similar to what we did in the version 0.23.1 for matrices.
- The
Isometry::inv_mul
method which is a more efficient way of doingisometry1.inverse() * isometry2
.
In this release we improved the documentation of the matrix and vector types by:
- Grouping
impl
bocks logically, adding a title comment to these impl blocks. - Reference these impl blocks docs at the top of the documentation page for
Matrix
. - Reduce the depth of type aliasing. Now all vector and matrix types are aliases of
Matrix
directly (instead of being aliases for other aliases).
- The
.inverse_transform_unit_vector(v)
was added toRotation2/3
,Isometry2/3
,UnitQuaternion
, andUnitComplex
. It applies the corresponding rotation to a unit vectorUnit<Vector2/3>
. - The
Point.map(f)
andPoint.apply(f)
to apply a function to each component of the point, similarly toVector.map(f)
andVector.apply(f)
. - The
Quaternion::from([N; 4])
conversion to build a quaternion from an array of four elements. - The
Isometry::from(Translation)
conversion to build an isometry from a translation. - The
Vector::ith_axis(i)
which build a unit vector, e.g.,Unit<Vector3<f32>>
with its i-th component set to 1.0, and the others set to zero. - The
Isometry.lerp_slerp
andIsometry.try_lerp_slerp
methods to interpolate between two isometries using linear interpolation for the translational part, and spherical interpolation for the rotational part. - The
Rotation2.slerp
,Rotation3.slerp
, andUnitQuaternion.slerp
method for spherical interpolation.
In this release, we are using the new version 0.2 of simba. One major change of that version is that the
use of libm
is now opt-in when building targeting no-std
environment. If you are using floating-point
operations with nalgebra in a no-std
environment, you will need to enable the new libm
feature
of nalgebra for your code to compile again.
- The
libm
feature that enableslibm
when building forno-std
environment. - The
libm-force
feature that enableslibm
even when building for a notno-std
environment. Cholesky::new_unchecked
which build a Cholesky decomposition without checking that its input is positive-definite. It can be used with SIMD types.- The
Default
trait is now implemented for matrices, and quaternions. They are all filled with zeros, except forUnitQuaternion
which is initialized with the identity. - Matrix exponential
matrix.exp()
. - The
Vector::ith(i, x)
that builds a vector filled with zeros except for thei
-th component set tox
.
In this release, we are no longer relying on traits from the alga crate for our generic code. Instead, we use traits from the new simba crate which are both simpler, and allow for significant optimizations like AoSoA SIMD.
Refer to the monthly dimforge blogpost for details about this switch and its benefits.
- It is now possible to use SIMD types like
simba::f32x4
as scalar types for nalgebra's matrices and geometric types.
- Use of traits like
alga::general::{RealField, ComplexField}
have now been replaced bysimba::scalar::{RealField, ComplexField}
. - The implementation of traits from the alga crate (and well as the dependency to alga_) are now
omitted unless the
alga
cargo feature is activated.
- The
Neg
unary operator is no longer implemented forUnitComplex
andUnitQuaternion
. This caused hard-to-track errors when we mistakenly write, e.g.,-q * v
instead of-(q * v)
. - The
na::convert_unchecked
is no longer marked as unsafe.
cholesky.rank_one_update(...)
which performs a rank-one update on the cholesky decomposition of a matrix.From<&Matrix>
is now implemented for matrix slices..try_set_magnitude(...)
which sets the magnitude of a vector, while keeping its direction.- Implementations of
From
andInto
for the conversion between matrix slices and standard (&[N]
&mut [N]
) slices.
- We started some major changes in order to allow non-Copy types to be used as scalar types inside of matrices/vectors.
.remove_rows_at
andremove_columns_at
which removes a set of rows or columns (specified by indices) from a matrix.- Several formatting traits have been implemented for all matrices/vectors:
LowerExp
,UpperExp
,Octal
,LowerHex
,UpperHex
,Binary
,Pointer
. UnitQuaternion::quaternions_mean(...)
which computes the mean rotation of a set of unit quaternions. This implements the algorithm from _Oshman, Yaakov, and Avishy Carmi, "Attitude estimation from vector observations using a genetic-algorithm-embedded quaternion particle filter."
- It is now possible to get the
min/max
element of unsigned integer matrices.
- Some infinite and reversed perspectives:
::infinite_perspective_rh_no
,::infinite_perspective_rh_zo
,::reversed_perspective_rh_zo
, and::reversed_infinite_perspective_rh_zo
.
This release adds full complex number support to nalgebra. This includes all common vector/matrix operations as well
as matrix decomposition. This excludes geometric type (like Isometry
, Rotation
, Translation
, etc.) from the
geometry
module.
- Add trigonometric functions for quaternions:
.cos, .sin, .tan, .acos, .asin, .atan, .cosh, .sinh, .tanh, .acosh, .asinh, .atanh
. - Add geometric algebra operations for quaternions:
.inner, .outer, .project, .rejection
- Add
.left_div, .right_div
for quaternions. - Add
.renormalize
toUnit<...>
andRotation3
to correct potential drift due to repeated operations. Those drifts could cause them not to be pure rotations anymore.
.convolve_full(kernel)
returns the convolution ofself
bykernel
..convolve_valid(kernel)
returns the convolution ofself
bykernel
after removal of all the elements relying on zero-padding..convolve_same(kernel)
returns the convolution ofself
bykernel
with a result of the same size asself
.
- Add the
::from_matrix
constructor too all rotation types to extract a rotation from a raw matrix. - Add the
::from_matrix_eps
constructor too all rotation types to extract a rotation from a raw matrix. This takes more argument than::from_matrix
to control the convergence of the underlying optimization algorithm. - Add
.camax()
which returns the matrix component with the greatest L1-norm. - Add
.camin()
which returns the matrix component with the smallest L1-norm. - Add
.ad_mul(b)
for matrix-multiplication ofself.adjoint() * b
. - Add
.ad_mul_to(b)
which is the same as.ad_mul
but with a provided matrix to be filled with the result of the multiplication. - Add BLAS operations involving complex conjugation (following similar names as the original BLAS spec):
.dotc(rhs)
equal toself.adjoint() * rhs
..gerc(alpha, x, y, beta)
equivalent toself = alpha * x * y.adjoint() + beta * self
.hegerc
which is likegerc
but for Hermitian matrices..syger
which is the new name of.ger_symm
which is equivalent toself = alpha * x * y.transpose() + beta * self
..sygemv
which is the new name of.gemv_symm
which is equivalent toself = alpha * a * x + beta * self
witha
symmetric..hegemv(alpha, a, x, beta)
which is like.sygemv
but witha
Hermitian..gemv_ad(alpha, a, x, beta)
which is equivalent toself = alpha * a.adjoint() * x + beta * self
..gemm_ad(alpha, a, b, beta)
which is equivalent toself = alpha * a.adjoint() * b + beta * self
..icamax()
which returns the index of the complex vector component with the greatest L1-norm.
Note that all the other BLAS operation will continue to work for all fields, including floats and complex numbers.
RealSchur
has been renamedSchur
because it can now work with complex matrices.
- Add swizzling up to dimension 3 for vectors. For example, you can do
v.zxy()
as an equivalent toVector3::new(v.z, v.x, v.y)
. - Add swizzling up to dimension 3 for points. For example, you can do
p.zxy()
as an equivalent toPoint3::new(p.z, p.x, p.y)
. - Add
.copy_from_slice
to copy matrix components from a slice in column-major order. - Add
.dot
to quaternions. - Add
.zip_zip_map
for iterating on three matrices simultaneously, and applying a closure to them. - Add
.slerp
and.try_slerp
to unit vectors. - Add
.lerp
to vectors. - Add
.to_projective
and.as_projective
toPerspective3
andOrthographic3
in order to use them asProjective3
structures. - Add
From/Into
impls to allow the conversion of any transformation type to a matrix. - Add
Into
impls to convert a matrix slice into an owned matrix. - Add
Point*::from_slice
to create a point from a slice. - Add
.map_with_location
to matrices to apply a map which passes the component indices to the user-defined closure alongside the component itself. - Add impl
From<Vector>
forPoint
. - Add impl
From<Vector4>
forQuaternion
. - Add impl
From<Vector>
forTranslation
. - Add the
::from_vec
constructor to construct a matrix from aVec
(aDMatrix
will reuse the originalVec
as-is for its storage). - Add
.to_homogeneous
to square matrices (and with dimensions higher than 1x1). This will increase their number of row and columns by 1. The new column and row are filled with 0, except for the diagonal element which is set to 1. - Implement
Extend<Vec>
for matrices with a dynamic storage. The providedVec
is assumed to represent a column-major matrix with the same number of rows as the one being extended. This will effectively append new columns on the right of the matrix being extended. - Implement
Extend<Vec>
for vectors with a dynamic storage. This will concatenate the vector with the givenVec
. - Implement
Extend<Matrix<...>>
for matrices with dynamic storage. This will concatenate the columns of both matrices. - Implement
Into<Vec>
for theMatrixVec
storage. - Implement
Hash
for all matrices. - Add a
.len()
method to retrieve the size of aMatrixVec
.
- The orthographic projection no longer require that
bottom < top
, thatleft < right
, and thatznear < zfar
. The only restriction now ith that they must not be equal (in which case the projection would be singular). - The
Point::from_coordinates
methods is deprecated. UsePoint::from
instead. - The
.transform_point
and.transform_vector
methods are now inherent methods for matrices so that the user does not have to explicitly import theTransform
trait from the alga crate. - Renamed the matrix storage types:
MatrixArray
->ArrayStorage
andMatrixVec
->VecStorage
. - Renamed
.unwrap()
to.into_inner()
for geometric types that wrap another type. This is for the case ofUnit
,Transform
,Orthographic3
,Perspective3
,Rotation
. - Deprecate several functions at the root of the crate (replaced by methods).
* Remove the `Deref` impl for `MatrixVec` as it could cause hard-to-understand compilation errors.
- Add several alternative projection computations, e.g.,
ortho_lh
,ortho_lh_no
,perspective_lh
, etc. - Add features matching those of nalgebra, in particular:
serde-serialize
,abmonation-serialize
, std` (enabled by default).
All dependencies have been updated to their latest versions.
- Adjust
UnitQuaternion
s,Rotation3
s, andRotation2
s generated from theStandard
distribution to be uniformly distributed.
- Add a feature
stdweb
to activate the dependency featurerand/stdweb
. - Add blas-like methods
.imin()
and.imax()
that return the index of the minimum and maximum entry of a vector. - Add construction of a
Point
from an array by implementing theFrom
trait. - Add support for generating uniformly distributed random unit column vectors using the
Standard
distribution.
The most notable change of this release is the support for using part of the library without the rust standard
library (i.e. it supports #![no_std]
). See the corresponding documentation.
- Rename the
core
module tobase
to avoid conflicts with thecore
crate implicitly imported when#![no_std]
is enabled. - Constructors of the
MatrixSlice*
types have been renamed fromnew_*
tofrom_slice_*
. This was necessary to avoid theincoherent_fundamental_impls
lint that is going to become a hard error.
- Add
UnitQuaternion
constructor::new_eps(...)
and::from_scaled_axis_eps(...)
that return the identity if the magnitude of the input axisangle is smaller than the epsilon provided. - Add methods
.rotation_between_axis(...)
and.scaled_rotation_between_axis(...)
toUnitComplex
to compute the rotation matrix between two 2D unit vectors. - Add methods
.axis_angle()
toUnitComplex
andUnitQuaternion
in order to retrieve both the unit rotation axis, and the rotation angle simultaneously. - Add functions to construct a random matrix with a user-defined distribution:
::from_distribution(...)
.
- Allow the
Isometry * Unit<Vector>
multiplication.
- Add blas-like operations:
.quadform(...)
and.quadform_tr(...)
to compute respectively the quadratic formsself = alpha * A.transpose() * B * A + beta * self
andalpha * A * B * A.transpose() + beta * self
. Here,A, B
are matrices withB
square, andalpha, beta
are reals. - Add blas-like operations:
.gemv_tr(...)
that behaves like.gemv
except that the provided matrix is assumed to be transposed. - Add blas-like operations:
cmpy, cdpy
for component-wise multiplications and division with scalar factors: -self <- alpha * self + beta * a * b
-self <- alpha * self + beta * a / b
.cross_matrix()
returns the cross-product matrix of a given 3D vector, i.e., the matrixM
such that for all vectorv
we haveM * v == self.cross(&v)
..iamin()
that returns the index of the vector entry with the smallest absolute value.- The
mint
feature that can be enabled in order to allow conversions from and to types of the mint crate. - Aliases for matrix and vector slices. Their are named by adding
Slice
before the dimension numbers, i.e., a 3x5 matrix slice with dimensions known at compile-time is calledMatrixSlice3x5
. A vector slice with dimensions unknown at compile-time is calledDVectorSlice
. - Add functions for constructing matrix slices from a slice
&[N]
, e.g.,MatrixSlice2::new(...)
andMatrixSlice2::new_with_strides(...)
. - The
::repeat(...)
constructor that is an alternative name to::from_element(...)
. UnitQuaternion::scaled_rotation_between_axis(...)
andUnitQuaternion::rotation_between_axis(...)
that take Unit vectors instead of Vector as arguments.
The nalgebra-lapack crate has been updated. This now includes a broad range matrix decompositions using LAPACK bindings.
This adds support for serialization using the abomonation crate.
- The implementation of slicing with steps now matches the documentation. Before, step identified the number to add to pass from one column/row index to the next one. This made 0 step invalid. Now (and on the documentation so far), the step is the number of ignored row/columns between each row/column. Thus, a step of 0 means that no row/column is ignored. For example, a step of, say, 3 on previous versions should now bet set to 2.
- The trait
Axpy
has been replaced by a method.axpy
. - The alias
MatrixNM
is now deprecated. UseMatrixMN
instead (we reordered M and N to be in alphabetical order). - In-place componentwise multiplication and division
.component_mul_mut(...)
and.component_div_mut(...)
have been deprecated for a future renaming. Use.component_mul_assign(...)
and.component_div_assign(...)
instead.
alga::general::Real
is now re-exported by nalgebra. elements.)::zeros(...)
that creates a matrix filled with zeroes.::from_partial_diagonal(...)
that creates a matrix from diagonal elements. The matrix can be rectangular. If not enough elements are provided, the rest of the diagonal is set to 0..conjugate_transpose()
computes the transposed conjugate of a complex matrix..conjugate_transpose_to(...)
computes the transposed conjugate of a complex matrix. The result written into a user-provided matrix..transpose_to(...)
is the same as.transpose()
but stores the result in the provided matrix..conjugate_transpose_to(...)
is the same as.conjugate_transpose()
but stores the result in the provided matrix.- Implements
IntoIterator
for&Matrix
,&mut Matrix
andMatrix
. .mul_to(...)
multiplies two matrices and stores the result to the given buffer..tr_mul_to(...)
left-multipliesself.transpose()
to another matrix and stores the result to the given buffer..add_scalar(...)
that adds a scalar to each component of a matrix..add_scalar_mut(...)
that adds in-place a scalar to each component of a matrix..kronecker(a, b)
computes the kronecker product (i.e. matrix tensor product) of two matrices..apply(f)
replaces each component of a matrix with the results of the closuref
called on each of them.
Pure Rust implementation of some Blas operations:
.iamax()
returns the index of the maximum value of a vector..axpy(...)
computesself = a * x + b * self
..gemv(...)
computesself = alpha * a * x + beta * self
with a matrix and vectora
andx
..ger(...)
computesself = alpha * x^t * y + beta * self
wherex
andy
are vectors..gemm(...)
computesself = alpha * a * b + beta * self
wherea
andb
are matrices..gemv_symm(...)
is the same as.gemv
except thatself
is assumed symmetric..ger_symm(...)
is the same as.ger
except thatself
is assumed symmetric.
New slicing methods:
.rows_range(...)
that retrieves a reference to a range of rows..rows_range_mut(...)
that retrieves a mutable reference to a range of rows..columns_range(...)
that retrieves a reference to a range of columns..columns_range_mut(...)
that retrieves a mutable reference to a range of columns.
Matrix decompositions implemented in pure Rust:
- Cholesky, SVD, LU, QR, Hessenberg, Schur, Symmetric eigendecompositions, Bidiagonal, Symmetric tridiagonal
- Computation of householder reflectors and givens rotations.
Matrix edition:
.upper_triangle()
extracts the upper triangle of a matrix, including the diagonal..lower_triangle()
extracts the lower triangle of a matrix, including the diagonal..fill(...)
fills the matrix with a single value..fill_with_identity(...)
fills the matrix with the identity..fill_diagonal(...)
fills the matrix diagonal with a single value..fill_row(...)
fills a selected matrix row with a single value..fill_column(...)
fills a selected matrix column with a single value..set_diagonal(...)
sets the matrix diagonal..set_row(...)
sets a selected row..set_column(...)
sets a selected column..fill_lower_triangle(...)
fills some sub-diagonals below the main diagonal with a value..fill_upper_triangle(...)
fills some sub-diagonals above the main diagonal with a value..swap_rows(...)
swaps two rows..swap_columns(...)
swaps two columns.
Column removal:
.remove_column(...)
removes one column..remove_fixed_columns<D>(...)
removesD
columns..remove_columns(...)
removes a number of columns known at run-time.
Row removal:
.remove_row(...)
removes one row..remove_fixed_rows<D>(...)
removesD
rows..remove_rows(...)
removes a number of rows known at run-time.
Column insertion:
.insert_column(...)
adds one column at the given position..insert_fixed_columns<D>(...)
addsD
columns at the given position..insert_columns(...)
adds at the given position a number of columns known at run-time.
Row insertion:
.insert_row(...)
adds one row at the given position..insert_fixed_rows<D>(...)
addsD
rows at the given position..insert_rows(...)
adds at the given position a number of rows known at run-time.
The main change of this release is the update of the dependency serde to 1.0.
.trace()
that computes the trace of a matrix (the sum of its diagonal elements.)
The website has been fully rewritten and gives a good overview of all the added/modified features.
This version is a major rewrite of the library. Major changes are:
- Algebraic traits are now defined by the alga crate.
All other mathematical traits, except
Axpy
have been removed from nalgebra. - Methods are now preferred to free functions because they do not require any trait to be used anymore.
- Most algebraic entities can be parametrized by type-level integers
to specify their dimensions. Using
Dynamic
instead of a type-level integer indicates that the dimension known at run-time only. - Statically-sized rectangular matrices.
- More transformation types have been added: unit-sized complex numbers (for
2D rotations), affine/projective/general transformations with
Affine2/3
,Projective2/3
, andTransform2/3
. - Serde serialization is now supported instead of
rustc_serialize
. Enable it with theserde-serialize
feature. - Matrix slices are now implemented.
Lots of features including rectangular matrices, slices, and Serde serialization. Refer to the brand new website for more details. The following free-functions have been added as well:
::id()
that returns the universal identity element of typeId
.::inf_sup()
that returns both the infimum and supremum of a value at the same time.::partial_sort2()
that attempts to sort two values in increasing order.::wrap()
that moves a value to the given interval by adding or removing the interval width to it.
::cast
->::convert
point.as_vector()
->point.coords
na::origin
->P::origin()
na::is_zero
->.is_zero()
(from num::Zero).transform
->.transform_point
/.transform_vector
.translate
->.translate_point
::dimension::<P>
->::dimension::<P::Vector>
::angle_between
->::angle
Componentwise multiplication and division has been replaced by methods:
- multiplication ->
.componentwise_mul
,.componentwise_mul_mut
. - division ->
.componentwise_div
,.componentwise_div_mut
.
The following free-functions are now replaced by methods (with the same names)
only:
::cross
, ::cholesky
, ::determinant
, ::diagonal
, ::eigen_qr
(becomes
.eig
), ::hessenberg
, ::qr
, ::to_homogeneous
, ::to_rotation_matrix
,
::transpose
, ::shape
.
The following free-functions are now replaced by static methods only:
::householder_matrix
under the name::new_householder_generic
::identity
::new_identity
under the name::identity
::from_homogeneous
::repeat
under the name::from_element
The following free-function are now replaced methods accessible through traits only:
::transform
-> methods.transform_point
and.transform_vector
of thealga::linear::Transformation
trait.::inverse_transform
-> methods.inverse_transform_point
and.inverse_transform_vector
of thealga::linear::ProjectiveTransformation
trait.::translate
,::inverse_translate
,::rotate
,::inverse_rotate
-> methods from thealga::linear::Similarity
trait instead. Those have the same names but end with_point
or_vector
, e.g.,.translate_point
and.translate_vector
.::orthonormal_subspace_basis
-> method with the same name fromalga::linear::FiniteDimInnerSpace
.::canonical_basis_element
and::canonical_basis
-> methods with the same names fromalga::linear::FiniteDimVectorSpace
.::rotation_between
-> method with the same name from thealga::linear::Rotation
trait.::is_zero
-> method with the same name fromnum::Zero
.
-
The free functions
::prepend_rotation
,::append_rotation
,::append_rotation_wrt_center
,::append_rotation_wrt_point
,::append_transformation
, and::append_translation
have been removed. Instead, create the rotation or translation object explicitly and use multiplication to compose it with anything else. -
The free function
::outer
has been removed. Use column-vector × row-vector multiplication instead. -
::approx_eq
,::approx_eq_eps
have been removed. Use therelative_eq!
macro from the approx crate instead. -
::covariance
has been removed. There is no replacement for now. -
::mean
has been removed. There is no replacement for now. -
::sample_sphere
has been removed. There is no replacement for now. -
::cross_matrix
has been removed. There is no replacement for now. -
::absolute_rotate
has been removed. There is no replacement for now. -
::rotation
,::transformation
,::translation
,::inverse_rotation
,::inverse_transformation
,::inverse_translation
have been removed. Use the appropriate methods/field of each transformation type, e.g.,rotation.angle()
androtation.axis()
.
Binary operations are now allowed between references as well. For example
Vector3<f32> + &Vector3<f32>
is now possible.
Removed unused parameters to methods from the ApproxEq
trait. Those were
required before rust 1.0 to help type inference. They are not needed any more
since it now allowed to write for a type T
that implements ApproxEq
:
<T as ApproxEq>::approx_epsilon()
. This replaces the old form:
ApproxEq::approx_epsilon(None::<T>)
.
- Renamed:
::from_col_vector
->::from_column_vector
::from_col_iter
->::from_column_iter
.col_slice
->.column_slice
.set_col
->.set_column
::canonical_basis_with_dim
->::canonical_basis_with_dimension
::from_elem
->::from_element
DiagMut
->DiagonalMut
UnitQuaternion::new
becomesUnitQuaternion::from_scaled_axis
orUnitQuaternion::from_axisangle
. The new::new
method now requires a not-normalized quaternion.
Method names starting with new_with_
now start with from_
. This is more
idiomatic in Rust.
The Norm
trait now uses an associated type instead of a type parameter.
Other similar trait changes are to be expected in the future, e.g., for the
Diagonal
trait.
Methods marked unsafe
for reasons unrelated to memory safety are no
longer unsafe. Instead, their name end with _unchecked
. In particular:
Rotation3::new_with_matrix
->Rotation3::from_matrix_unchecked
PerspectiveMatrix3::new_with_matrix
->PerspectiveMatrix3::from_matrix_unchecked
OrthographicMatrix3::new_with_matrix
->OrthographicMatrix3::from_matrix_unchecked
- A
Unit<T>
type that wraps normalized values. In particular,UnitQuaternion<N>
is now an alias forUnit<Quaternion<N>>
. .ln()
,.exp()
and.powf(..)
for quaternions and unit quaternions.::from_parts(...)
to build a quaternion from its scalar and vector parts.- The
Norm
trait now has atry_normalize()
that returnsNone
if the norm is too small. - The
BaseFloat
andFloatVector
traits now inherit fromApproxEq
as well. It is clear that performing computations with floats requires approximate equality.
Still WIP: add implementations of abstract algebra traits from the algebra
crate for vectors, rotations and points. To enable them, activate the
abstract_algebra
feature.
- Almost everything (types, methods, and traits) now use fulls names instead
of abbreviations (e.g.
Vec3
becomesVector3
). Most changes are obvious. Note however that:::sqnorm
becomes::norm_squared
.::sqdist
becomes::distance_squared
.::abs
,::min
, etc. did not change as this is a common name for absolute values on, e.g., the libc.- Dynamically sized structures keep the
D
prefix, e.g.,DMat
becomesDMatrix
.
- All files with abbreviated names have been renamed to their full version,
e.g.,
vec.rs
becomesvector.rs
.
- Added implementation of assignment operators (+=, -=, etc.) for everything.
- Points and vectors are now linked to each other with associated types (on the PointAsVector trait).
Announcement: a users forum has been created for nalgebra
, ncollide
, and nphysics
. See
you there!
- Added a dependency to generic-array. Feature-gated:
requires
features="generic_sizes"
. - Added statically sized vectors with user-defined sizes:
VectorN
. Feature-gated: requiresfeatures="generic_sizes"
. - Added similarity transformations (an uniform scale followed by a rotation followed by a
translation):
Similarity2
,Similarity3
.
- Removed zero-sized elements
Vector0
,Point0
. - Removed 4-dimensional transformations
Rotation4
andIsometry4
(which had an implementation too incomplete to be useful).
- Vectors are now multipliable with isometries. This will result into a pure rotation (this is how vectors differ from point semantically: they design directions, so they are not translatable).
{Isometry3, Rotation3}::look_at
reimplemented and renamed to::look_at_rh
and::look_at_lh
to agree with the computer graphics community (in particular, the GLM library). Use the::look_at_rh
variant to build a view matrix that may be successfully used withPersp
andOrtho
.- The old
{Isometry3, Rotation3}::look_at
implementations are now called::new_observer_frame
. - Rename every
fov
onPersp
tofovy
. - Fixed the perspective and orthographic projection matrices.