Linear algebra library for Rust.
Go to file
Sébastien Crozet 87a80c2de6 Fix tests. 2016-03-24 19:44:08 +01:00
benches Add vector perametrizable by their sizes. 2016-03-24 19:03:29 +01:00
src Fix tests. 2016-03-24 19:44:08 +01:00
tests Fix tests. 2016-03-24 19:44:08 +01:00
.gitignore Add points. 2014-10-10 11:45:20 +02:00
.travis.yml Don't run benchmarks on travis. 2015-06-19 23:48:27 +02:00
CHANGELOG Add a changelog (at last!) 2016-03-24 19:44:08 +01:00
Cargo.toml Add vector perametrizable by their sizes. 2016-03-24 19:03:29 +01:00
LICENSE Initial commit. 2013-05-14 11:34:28 +00:00
Makefile Remove implementations of `Rotation`, `Translation` and `Transformation` for the `Identity` type. 2015-07-07 22:40:14 +02:00
README.md Remove useless or incomplete structs: `Vec0`, `Pnt0`, `Iso4`, `Rot4`. 2016-03-24 19:43:50 +01:00

README.md

Build Status

nalgebra

nalgebra is a low-dimensional linear algebra library written for Rust targeting:

  • general-purpose linear algebra (still lacks a lot of features…).
  • real time computer graphics.
  • real time computer physics.

An on-line version of this documentation is available here.

Using nalgebra

All the functionality of nalgebra is grouped in one place: the root module nalgebra::. This module re-exports everything and includes free functions for all traits methods doing out-of-place modifications.

  • You can import the whole prelude using:
use nalgebra::*;

The preferred way to use nalgebra is to import types and traits explicitly, and call free-functions using the na:: prefix:

extern crate nalgebra as na;
use na::{Vec3, Rot3, Rotation};

fn main() {
    let     a = Vec3::new(1.0f64, 1.0, 1.0);
    let mut b = Rot3::new(na::zero());

    b.append_rotation_mut(&a);

    assert!(na::approx_eq(&na::rotation(&b), &a));
}

Features

nalgebra is meant to be a general-purpose, low-dimensional, linear algebra library, with an optimized set of tools for computer graphics and physics. Those features include:

  • Vectors with predefined static sizes: Vec1, Vec2, Vec3, Vec4, Vec5, Vec6.
  • Vector with a user-defined static size: VecN.
  • Points with static sizes: ``Pnt1, Pnt2, Pnt3, Pnt4, Pnt5, Pnt6`.
  • Square matrices with static sizes: Mat1, Mat2, Mat3, Mat4, Mat5, Mat6 .
  • Rotation matrices: Rot2, Rot3
  • Quaternions: Quat, UnitQuat.
  • Isometries (translation * rotation): Iso2, Iso3
  • Similarity transformations (translation * rotation * uniform scale): Sim2, Sim3.
  • 3D projections for computer graphics: Persp3, PerspMat3, Ortho3, OrthoMat3.
  • Dynamically sized heap-allocated vector: DVec.
  • Dynamically sized stack-allocated vectors with a maximum size: DVec1 to DVec6.
  • Dynamically sized heap-allocated (square or rectangular) matrix: DMat.
  • Linear algebra and data analysis operators: Cov, Mean, qr, cholesky.
  • Almost one trait per functionality: useful for generic programming.