This repository contains the source code and the documentation of two Rust-language crates: rs-measures and units-relation.
Their purpose is to improve the readability and correctness of applications using numeric values having units of measurement. These can be the ones used in physics or in geometry, but also the ones commonly used in industry.
This purpose is achieved by encapsulating such numbers into objects whose type represents their unit of measurement, and providing for such types only the operations which make sense.
The documentation is in these files:
- Motivation: It describes the advantages of using these crates instead of other crates or naked numbers.
- Tutorial: It is a step-by-step course on the use of these crates.
- Architecture: It explains the design choices of the crates.
There are several examples:
full: Very long print of the provided examples of units of measures, and of the results of any supported operation.bench,bench2: Simple check of speed, compared with naked numbers or with the cratenalgebra.base,mks,si,unit: Translation for Rs-measures of the examples included in the crateuomversion 0.35.0.nbody-measures: It is put beside examplenbody-naked. The latter is a benchmark program not using any external libraries, nor units of measurement, taken from The Computer Language Benchmarks Game. The former is a translation to a version using this library. At the beginning of both files, it is explained how to use them. In a specific setting, it appears thatnbody-measurestakes 11% more time thannbody-naked.
Licensed under 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)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
See CONTRIBUTING.md.