nalgebra/README.md

61 lines
2.3 KiB
Markdown
Raw Normal View History

[![Build Status](https://travis-ci.org/sebcrozet/nalgebra.svg?branch=master)](https://travis-ci.org/sebcrozet/nalgebra)
nalgebra
========
2014-01-14 16:52:18 +08:00
**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.
2016-03-25 02:04:01 +08:00
An on-line version of this documentation is available [here](http://nalgebra.org/doc/nalgebra).
## Using **nalgebra**
2016-03-25 02:04:01 +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 performing
out-of-place operations.
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
2015-06-06 20:28:34 +08:00
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());
2015-06-06 20:28:34 +08:00
b.append_rotation_mut(&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
2015-06-06 20:28:34 +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 predefined static sizes: `Vec1`, `Vec2`, `Vec3`, `Vec4`, `Vec5`, `Vec6`.
* Vector with a user-defined static size: `VecN`.
2016-03-25 02:04:01 +08:00
* 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`
2014-10-15 04:24:10 +08:00
* Quaternions: `Quat`, `UnitQuat`.
2016-03-25 02:04:01 +08:00
* 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`.
2013-10-07 01:20:39 +08:00
* Almost one trait per functionality: useful for generic programming.