Embedded-friendly (i.e. no_std) Rust math library featuring fast, safe floating point approximations for common arithmetic operations, trigonometry, 2D/3D vector types, statistical analysis, and quaternions.

Optimizes for performance and small code size at the cost of precision.

Documentation

Minimum Supported Rust Version

Requires Rust 1.36 or newer.

Semver Policy

In the future, we reserve the right to change the following:

• Minimum Supported Rust Version
• generic-array version (presently ^0.14)

i.e. these are explicitly out of scope for the SemVer guarantees this crate provides.

However, when we change either of these things, we will accompany them with a minor version bump.

Features

• [f32 extension]:

  • Fast approximations:
  • [asin]
  • [acos]
  • [atan]
  • [atan2]
  • [cos]
  • [hypot]
  • [inv]
  • [invsqrt]
  • [ln]
  • [log]
  • [log2]
  • [log10]
  • [powf]
  • [exp]
  • [sin]
  • [sqrt]
  • [tan]
  • std polyfills:
  • [abs]
  • [ceil]
  • [floor]
  • [round]
  • [trunc]
  • [fract]
  • [copysign]

• [Algebraic vector types]:

  • 2D:
  • [I8x2]
  • [I16x2]
  • [I32x2]
  • [U8x2]
  • [U16x2]
  • [U32x2]
  • [F32x2]
  • 3D:
  • [I8x3]
  • [I16x3]
  • [I32x3]
  • [U8x3]
  • [U16x3]
  • [U32x3]
  • [F32x3]
• [Statistical analysis]:
  • [mean]
  • [stddev]
  • [trim]
  • [variance]
• [Quaternions]

Code of Conduct

We abide by the Contributor Covenant and ask that you do as well.

For more information, please see [CODEOFCONDUCT.md].

License

Copyright © 2019-2021 tarcieri Developers

Dual licensed under your choice of either of:

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Incorporates portions of some tests from the [libm crate]. Copyright © 2018 Jorge Aparicio and also dual licensed under the Apache 2.0 and MIT licenses.