nalgebra/README.md

55 lines
1.9 KiB
Markdown
Raw Normal View History

2014-01-14 16:52:18 +08:00
# 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](http://nalgebra.org).
## Using **nalgebra**
2014-10-13 14:46:39 +08:00
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.
2014-01-14 16:52:18 +08:00
* You can import the whole prelude using:
```.ignore
use nalgebra::*;
```
2014-01-14 16:52:18 +08:00
The preferred way to use **nalgebra** is to import types and traits explicitly, and call
free-functions using the `na::` prefix:
```.rust
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);
2014-01-14 16:52:18 +08:00
assert!(na::approx_eq(&na::rotation(&b), &a));
}
```
2013-06-13 22:06:05 +08:00
2013-09-28 06:12:18 +08:00
## Features
2014-10-13 14:46:39 +08:00
**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:
2013-06-13 22:06:05 +08:00
* 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`.
2014-10-15 04:24:10 +08:00
* Quaternions: `Quat`, `UnitQuat`.
* Isometries: `Iso2`, `Iso3`, `Iso4`.
* 3D projections for computer graphics: `Persp3`, `PerspMat3`, `Ortho3`, `OrthoMat3`.
2013-09-28 06:15:44 +08:00
* Dynamically sized vector: `DVec`.
* Dynamically sized (square or rectangular) matrix: `DMat`.
* A few methods for data analysis: `Cov`, `Mean`.
2013-10-07 01:20:39 +08:00
* Almost one trait per functionality: useful for generic programming.
* Operator overloading using multidispatch.