M-Labs
/
nalgebra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
nalgebra/README.md

72 lines
2.8 KiB
Markdown
Raw Normal View History

Make the link to the documentation more visible Fix #194
2016-08-10 03:50:21 +08:00
<p align="center">
<a href="https://crates.io/crates/nalgebra">
<img src="http://meritbadge.herokuapp.com/nalgebra?style=flat-square" alt="crates.io">
</a>
<a href="https://travis-ci.org/sebcrozet/nalgebra">
<img src="https://travis-ci.org/sebcrozet/nalgebra.svg?branch=master" alt="Build status">
</a>
</p>
<p align = "center">
<strong>
Fix README forum link.
2016-08-25 05:32:40 +08:00
<a href="http://nalgebra.org/doc/nalgebra">Documentation</a> | <a href="http://users.nphysics.org">Forum</a>
Make the link to the documentation more visible Fix #194
2016-08-10 03:50:21 +08:00
</strong>
</p>
Add Travis badge to the README. Fix #140.
2015-07-12 15:35:10 +08:00
nalgebra
========
Fix the example on the README.
2014-01-14 16:52:18 +08:00
Add 3D orthogonal and perspective projection structures. Fix #26.
2014-10-13 02:21:06 +08:00
**nalgebra** is a low-dimensional linear algebra library written for Rust targeting:
Huge api change! Everything changed, hopefully for the best. * everything is accessible from the `na` module. It re-export everything and provides free functions (i-e: na::dot(a, b) instead of a.dot(b)) for most functionalities. * matrix/vector adaptors (Rotmat, Transform) are replaced by plain types: Rot{2, 3, 4} for rotation matrices and Iso{2, 3, 4} for isometries (rotation + translation). This old adaptors system was to hard to understand and to document. * each file related to data structures moved to the `structs` folder. This makes the doc a lot more readable and make people prefer the `na` module instead of individual small modules. * Because `na` exists now, the modules `structs::vec` and `structs::mat` dont re-export anything now. As a side effect, this makes the documentation more readable.
2013-10-06 22:54:09 +08:00
Implement `*Assign` traits for everything. Fix #184.
2016-04-17 18:57:54 +08:00
* General-purpose linear algebra (still lacks a lot of features…)
* Real time computer graphics.
* Real time computer physics.
Huge api change! Everything changed, hopefully for the best. * everything is accessible from the `na` module. It re-export everything and provides free functions (i-e: na::dot(a, b) instead of a.dot(b)) for most functionalities. * matrix/vector adaptors (Rotmat, Transform) are replaced by plain types: Rot{2, 3, 4} for rotation matrices and Iso{2, 3, 4} for isometries (rotation + translation). This old adaptors system was to hard to understand and to document. * each file related to data structures moved to the `structs` folder. This makes the doc a lot more readable and make people prefer the `na` module instead of individual small modules. * Because `na` exists now, the modules `structs::vec` and `structs::mat` dont re-export anything now. As a side effect, this makes the documentation more readable.
2013-10-06 22:54:09 +08:00
Add the "nalgebra in use" part to the readme.
2013-10-07 01:32:31 +08:00
## Using **nalgebra**
Complete the documentation.
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.
Huge api change! Everything changed, hopefully for the best. * everything is accessible from the `na` module. It re-export everything and provides free functions (i-e: na::dot(a, b) instead of a.dot(b)) for most functionalities. * matrix/vector adaptors (Rotmat, Transform) are replaced by plain types: Rot{2, 3, 4} for rotation matrices and Iso{2, 3, 4} for isometries (rotation + translation). This old adaptors system was to hard to understand and to document. * each file related to data structures moved to the `structs` folder. This makes the doc a lot more readable and make people prefer the `na` module instead of individual small modules. * Because `na` exists now, the modules `structs::vec` and `structs::mat` dont re-export anything now. As a side effect, this makes the documentation more readable.
2013-10-06 22:54:09 +08:00
Use full names for everything. Note that `sqdist` becomes `distance_squared` and `sqnorm` becomes `norm_squared`. Fix #176.
2016-04-17 23:26:58 +08:00
Thus, you can import the whole prelude using:
Huge api change! Everything changed, hopefully for the best. * everything is accessible from the `na` module. It re-export everything and provides free functions (i-e: na::dot(a, b) instead of a.dot(b)) for most functionalities. * matrix/vector adaptors (Rotmat, Transform) are replaced by plain types: Rot{2, 3, 4} for rotation matrices and Iso{2, 3, 4} for isometries (rotation + translation). This old adaptors system was to hard to understand and to document. * each file related to data structures moved to the `structs` folder. This makes the doc a lot more readable and make people prefer the `na` module instead of individual small modules. * Because `na` exists now, the modules `structs::vec` and `structs::mat` dont re-export anything now. As a side effect, this makes the documentation more readable.
2013-10-06 22:54:09 +08:00
Add 3D orthogonal and perspective projection structures. Fix #26.
2014-10-13 02:21:06 +08:00
```.ignore
use nalgebra::*;
Huge api change! Everything changed, hopefully for the best. * everything is accessible from the `na` module. It re-export everything and provides free functions (i-e: na::dot(a, b) instead of a.dot(b)) for most functionalities. * matrix/vector adaptors (Rotmat, Transform) are replaced by plain types: Rot{2, 3, 4} for rotation matrices and Iso{2, 3, 4} for isometries (rotation + translation). This old adaptors system was to hard to understand and to document. * each file related to data structures moved to the `structs` folder. This makes the doc a lot more readable and make people prefer the `na` module instead of individual small modules. * Because `na` exists now, the modules `structs::vec` and `structs::mat` dont re-export anything now. As a side effect, this makes the documentation more readable.
2013-10-06 22:54:09 +08:00
```
Use full names for everything. Note that `sqdist` becomes `distance_squared` and `sqnorm` becomes `norm_squared`. Fix #176.
2016-04-17 23:26:58 +08:00
However, the recommended way to use **nalgebra** is to import types and traits
explicitly, and call free-functions using the `na::` prefix:
Remove free-functions alliasing structures constructors. Those constructors are not idiomatic. Use e.g. `Vec3::new(0, 0, 0)` instead.
2013-10-14 17:22:38 +08:00
```.rust
Fix the README examples.
2015-06-06 20:28:34 +08:00
extern crate nalgebra as na;
Use full names for everything. Note that `sqdist` becomes `distance_squared` and `sqnorm` becomes `norm_squared`. Fix #176.
2016-04-17 23:26:58 +08:00
use na::{Vector3, Rotation3, Rotation};
Remove free-functions alliasing structures constructors. Those constructors are not idiomatic. Use e.g. `Vec3::new(0, 0, 0)` instead.
2013-10-14 17:22:38 +08:00
fn main() {
Use full names for everything. Note that `sqdist` becomes `distance_squared` and `sqnorm` becomes `norm_squared`. Fix #176.
2016-04-17 23:26:58 +08:00
let a = Vector3::new(1.0f64, 1.0, 1.0);
let mut b = Rotation3::new(na::zero());
Remove free-functions alliasing structures constructors. Those constructors are not idiomatic. Use e.g. `Vec3::new(0, 0, 0)` instead.
2013-10-14 17:22:38 +08:00
Fix the README examples.
2015-06-06 20:28:34 +08:00
b.append_rotation_mut(&a);
Remove free-functions alliasing structures constructors. Those constructors are not idiomatic. Use e.g. `Vec3::new(0, 0, 0)` instead.
2013-10-14 17:22:38 +08:00
Fix the example on the README.
2014-01-14 16:52:18 +08:00
assert!(na::approx_eq(&na::rotation(&b), &a));
Remove free-functions alliasing structures constructors. Those constructors are not idiomatic. Use e.g. `Vec3::new(0, 0, 0)` instead.
2013-10-14 17:22:38 +08:00
}
```
Add compilation instructions.
2013-06-13 22:06:05 +08:00
Fix the README examples.
2015-06-06 20:28:34 +08:00
Improve the readme.
2013-09-28 06:12:18 +08:00
## Features
Fix typos.
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:
Add compilation instructions.
2013-06-13 22:06:05 +08:00
Use full names for everything. Note that `sqdist` becomes `distance_squared` and `sqnorm` becomes `norm_squared`. Fix #176.
2016-04-17 23:26:58 +08:00
* Vectors with predefined static sizes: `Vector1`, `Vector2`, `Vector3`, `Vector4`, `Vector5`, `Vector6`.
* Vector with a user-defined static size: `VectorN` (available only with the `generic_sizes` feature).
* Points with static sizes: `Point1`, `Point2`, `Point3`, `Point4`, `Point5`, `Point6`.
* Square matrices with static sizes: `Matrix1`, `Matrix2`, `Matrix3`, `Matrix4`, `Matrix5`, `Matrix6 `.
* Rotation matrices: `Rotation2`, `Rotation3`
Implement traits from the algebra crate.
2016-08-21 05:13:53 +08:00
* Quaternions: `Quaternion`, `Unit<Quaternion>`.
* Unit-sized values (unit vectors, unit quaternions, etc.): `Unit<T>`, e.g., `Unit<Vector3<f32>>`.
Replace "col" by "column". Related to #176.
2016-04-18 14:29:22 +08:00
* Isometries (translation ⨯ rotation): `Isometry2`, `Isometry3`
Use full names for everything. Note that `sqdist` becomes `distance_squared` and `sqnorm` becomes `norm_squared`. Fix #176.
2016-04-17 23:26:58 +08:00
* Similarity transformations (translation ⨯ rotation ⨯ uniform scale): `Similarity2`, `Similarity3`.
* 3D projections for computer graphics: `Persp3`, `PerspMatrix3`, `Ortho3`, `OrthoMatrix3`.
* Dynamically sized heap-allocated vector: `DVector`.
* Dynamically sized stack-allocated vectors with a maximum size: `DVector1` to `DVector6`.
* Dynamically sized heap-allocated (square or rectangular) matrix: `DMatrix`.
* Linear algebra and data analysis operators: `Covariance`, `Mean`, `qr`, `cholesky`.
Fix typos on the readme.
2013-10-07 01:20:39 +08:00
* Almost one trait per functionality: useful for generic programming.