micromath.rs

Embedded Rust math library featuring fast, safe floating point approximations for common arithmetic operations, 2D and 3D vector types, and statistical analysis.

Documentation

Features

• f32 extension:
  • Fast approximations:
  • [ ] asin
  • [ ] acos
  • [ ] atan
  • [x] atan2
  • [ ] cos
  • [ ] hypot
  • [ ] invsqrt
  • [ ] ln
  • [ ] log
  • [ ] log2
  • [ ] log10
  • [ ] powf
  • [ ] sin
  • [x] sqrt
  • [ ] tan
  • std polyfills:
  • [x] abs
  • [ ] ceil
  • [ ] floor
  • [ ] round
  • [ ] trunc
• Algebraic vector types:
  • 2D:
  • [x] I8x2
  • [x] I16x2
  • [ ] I32x2
  • [x] U8x2
  • [x] U16x2
  • [ ] U32x2
  • [x] F32x2
  • 3D:
  • [x] I8x3
  • [x] I16x3
  • [ ] I32x3
  • [x] U8x3
  • [x] U16x3
  • [ ] U32x3
  • [x] F32x3
• Statistical analysis:
  • [x] mean
  • [x] variance
  • [x] stddev
• Quaternions
  • [ ] TBD

Comparisons with other Rust crates

libm crate

The [libm crate] contains a port of MUSL's libm to Rust, providing high-precision implementations of common arithmetic functions.

micromath trades precision for performance, instead using the best-available approximations of the same functions, implemented using safe conversions between f32 and u32.

The approximations are generally calculated using a combination of bit twiddling and magic constants, as opposed to the FPU-heavy approaches used by libm. These approaches are culled from recent academic research papers as well as older approaches which have been commonly used in games and other performance critical use cases where approximations are adequate.

vek crate

The [vek crate] provides a rich library for 2D and 3D vector types. Unfortunately, due to a number of issues including a transitive std dependency through the [approx crate], vek does not support no_std. According to the crate's author, the potential fixes are nontrivial (and involve addressing problems such as transcendantal functions causing overflow panics).

micromath has been written from the ground up to support no_std use cases. In fact, it doesn't even have a std feature!

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 NeoBirth 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)