rs-measures 0.4.1

A library of Rust macros to encapsulate numbers in measures, provided with units of measurement, allowing any meaningful operation, but statically forbidding meaningless operations with them.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# rs-measures

[![Crates.io](https://img.shields.io/crates/v/rs-measures.svg)](https://crates.io/crates/rs-measures)
[![Docs.rs](https://docs.rs/rs-measures/badge.svg)](https://docs.rs/rs-measures)
[![CI](https://github.com/carlomilanesi/rs-measures/workflows/Continuous%20Integration/badge.svg)](https://github.com/carlomilanesi/rs-measures/actions)
[![Coverage Status](https://coveralls.io/repos/github/carlomilanesi/rs-measures/badge.svg?branch=master)](https://coveralls.io/github/carlomilanesi/rs-measures?branch=master)

**Remark:** Since the end of October 2025, this repo is in maintenance mode, because another similar crate is recommended instead of it: [**Measures-rs**](https://github.com/carlomilanesi/measures-rs).
That repo is definitely better for several reasons, among which:
* It uses only declarative macros, instead of procedural macros.
* It adds optional approximate measures, i.e. measures with an uncertainty. The operations with such measures propagate the uncertainty to the results.

## Description

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**](docs/Motivation.md): It describes the advantages of using these crates instead of other crates or naked numbers.
* [**Tutorial**](docs/Tutorial.md): It is a step-by-step course on the use of these crates.
* [**Architecture**](docs/Architecture.md): It explains the design choices of the crates.

There are several examples:
* [**`full`**](units-relation/examples/full.rs): Very long print of the provided examples of units of measures, and of the results of any supported operation.
* [**`bench`**](units-relation/examples/bench.rs), [**`bench2`**](rs-measures/examples/bench2.rs): Simple check of speed, compared with naked numbers or with the crate `nalgebra`.
* [**`base`**](units-relation/examples/base.rs), [**`mks`**](units-relation/examples/mks.rs), [**`si`**](units-relation/examples/si.rs), [**`unit`**](units-relation/examples/unit.rs): Translation for Rs-measures of the examples included in the crate `uom` version 0.35.0.
* [**`nbody-measures`**](units-relation/examples/nbody-measures.rs): It is put beside example [**`nbody-naked`**](units-relation/examples/nbody-naked.rs). 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 that `nbody-measures` takes 11% more time than `nbody-naked`.

## License

Licensed under either of

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

at your option.

## Contribution

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](CONTRIBUTING.md).