Linear algebra library for Rust.
Go to file
Eduard Bopp 1103996b83 Implement Arbitrary for (almost) all types
Rot4 and Iso4 had to be left out, since Rot4 apparently lacks a working
constructor.

Thereby (almost) all types in nalgebra can now be used for quickcheck-style
testing.

"arbitrary" is now a conditionally compiled feature that contains these impls
adding a dependency on quickcheck.
2015-01-10 01:36:13 +01:00
benches Fix tests and benches. 2015-01-09 22:58:17 +01:00
src Implement Arbitrary for (almost) all types 2015-01-10 01:36:13 +01:00
tests Implement Arbitrary for (almost) all types 2015-01-10 01:36:13 +01:00
.gitignore Add points. 2014-10-10 11:45:20 +02:00
.travis.yml Update .travis.yml. 2014-08-23 19:37:14 +02:00
Cargo.toml Implement Arbitrary for (almost) all types 2015-01-10 01:36:13 +01:00
LICENSE Initial commit. 2013-05-14 11:34:28 +00:00
Makefile Fix warnings. 2014-11-07 19:23:46 +01:00
README.md Do not mantion the double-dispatch on the doc. 2014-11-26 14:36:50 +01:00

README.md

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(&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 static sizes: Vec0, Vec1, Vec2, Vec3, Vec4, Vec5, Vec6.
  • Points with static sizes: Pnt0, Pnt1, Pnt2, Pnt3, Pnt4, Pnt5, Pnt6.
  • Square matrices with static sizes: Mat1, Mat2, Mat3, Mat4, Mat5, Mat6 .
  • Rotation matrices: Rot2, Rot3, Rot4.
  • Quaternions: Quat, UnitQuat.
  • Isometries: Iso2, Iso3, Iso4.
  • 3D projections for computer graphics: Persp3, PerspMat3, Ortho3, OrthoMat3.
  • Dynamically sized vector: DVec.
  • Dynamically sized (square or rectangular) matrix: DMat.
  • A few methods for data analysis: Cov, Mean.
  • Almost one trait per functionality: useful for generic programming.
  • Operator overloading using multidispatch.