/cgmath

A linear algebra and mathematics library for computer graphics.
rust linear-algebra matrix vector computer-graphics simd simd-vector mathematics-library
  1. Rust 100.0%
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@bors[bot] @mathstuf
bors[bot] and mathstuf Merge #438 
438: Angle: add the normalize_zero method r=kvark a=mathstuf

This method is like `normalize` except that it normalizes to have an
absolute value of no more than `turn_div_2`.

---
This is useful for making sure that an angle is no more than some offset from a target angle (e.g., implementing maximum turn rates in games).

Co-authored-by: Ben Boeckel <mathstuf@gmail.com>
Latest commit 8bc3af4 Jan 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benches Fixed warnings Jun 8, 2018
src Angle: add the normalize_signed method Jan 16, 2019
tests tests: add tests for Angle::normalize Jan 16, 2019
.gitignore Build benchmarks on travis Aug 11, 2014
.travis.yml Mint flavour Jun 6, 2017
CHANGELOG.md [breaking] Move lerp() from InnerSpace to VectorSpace Nov 22, 2018
Cargo.toml Update some dependencies and bump version Dec 28, 2018
LICENSE Add license/copyright notices to source files May 31, 2013
README.md Update README to describe the new swizzling feature Oct 1, 2017
build.rs Put the swizzle operators behind a feature flag "swizzle" to avoid in… Oct 1, 2017

README.md

cgmath-rs

Build Status Documentation Version License Downloads Gitter

A linear algebra and mathematics library for computer graphics.

The library provides:

  • vectors: Vector2, Vector3, Vector4
  • square matrices: Matrix2, Matrix3, Matrix4
  • a quaternion type: Quaternion
  • rotation matrices: Basis2, Basis3
  • angle units: Rad, Deg
  • points: Point2, Point3
  • perspective projections: Perspective, PerspectiveFov, Ortho
  • spatial transformations: AffineMatrix3, Transform3

Not all of the functionality has been implemented yet, and the existing code is not fully covered by the testsuite. If you encounter any mistakes or omissions please let me know by posting an issue, or even better: send me a pull request with a fix.

Conventions

cgmath interprets its vectors as column matrices (also known as "column vectors"), meaning when transforming a vector with a matrix, the matrix goes on the left. This is reflected in the fact that cgmath implements the multiplication operator for Matrix * Vector, but not Vector * Matrix.

Features

Swizzling

This library offers an optional feature called "swizzling" widely familiar to GPU programmers. To enable swizzle operators, pass the --features="swizzle" option to cargo. Enabling this feature will increase the size of the cgmath library by approximately 0.6MB. This isn't an issue if the library is linked in the "normal" way by adding cgmath as a dependency in Cargo.toml, which will link cgmath statically so all unused swizzle operators will be optimized away by the compiler in release mode.

Example

If we have

let v = Vector3::new(1.0, 2.0, 3.0);

then v.xyxz() produces a

Vector4 { x: 1.0, y: 2.0, z: 1.0, w: 3.0 }

and v.zy() produces a

Vector2 { x: 3.0, y: 2.0 }

Limitations

cgmath is not an n-dimensional library and is aimed at computer graphics applications rather than general linear algebra. It only offers the 2, 3, and 4 dimensional structures that are more than enough for most computer graphics applications. This design decision was made in order to simplify the implementation (Rust cannot parameterize over constants at compile time), and to make dimension-specific optimisations easier in the future.

Contributing

Pull requests are most welcome, especially in the realm of performance enhancements and fixing any mistakes I may have made along the way. Unit tests and benchmarks are also required, so help on that front would be most appreciated.

Support

Contact bjz on irc.mozilla.org #rust and #rust-gamedev, or post an issue on Github.