nalgebra relies on the official Rust package manager
Cargo for dependency resolution and compilation. Therefore,
making nalgebra ready to be used by your project is simply a matter of
adding a new dependency to your
[dependencies] nalgebra = "0.14.0"
Until nalgebra reaches 1.0, it is strongly recommended to always use its
latest version, though you might encounter breaking changes from time to time.
Cargo.toml file is set up, the corresponding crate must be imported
by your project with the usual
extern crate directive. We recommend using the
na abbreviation for referencing the crate throughout your application.
extern crate nalgebra as na;
You may use this
Cargo.toml file to compile the downloadable examples of this
guide. Simply replace
example.rs by the actual example’s file name.
[package] name = "example-using-nalgebra" version = "0.0.0" authors = [ "You" ] [dependencies] nalgebra = "0.14.0" [[bin]] name = "example" path = "./example.rs"
Usage and cargo features§
nalgebra is a monolithic crate with all its functionalities exported at its
root. Data types, traits, and functions that do not take mutable inputs are
directly accessible behind the
nalgebra:: path (or
na:: if you use the
recommended alias). However, methods that perform in-place modifications
(normalization, appending a translation in-place, etc.) are not accessible as
free-functions. Instead, see the details of each data structure and the traits
Finally, two optional features can be enabled if needed: