fsum 0.1.3

The library to calculate accurate sum of floats.
Documentation
  • Coverage
  • 100%
    10 out of 10 items documented8 out of 10 items with examples
  • Size
  • Source code size: 10.11 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.57 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 14s Average build duration of successful builds.
  • all releases: 11s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • beling/bsuccinct-rs
    156 15 3
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • beling

fsum is the Rust library by Piotr Beling to calculate accurate sum of floats.

Example

use fsum::FSum;

assert_eq!(FSum::new().add(1e100).add(1.0).add(-1e100).value(), 1.0);
assert_eq!(FSum::with_all((0..10).map(|_| 0.1)).value(), 1.0);
assert_eq!(FSum::with_all(&[1e100, 1.0, -1e100]).value(), 1.0);

let mut s = FSum::new();
assert_eq!(s.value(), 0.0);
s += 3.0;
assert_eq!(s.value(), 3.0);
s -= 1.0;
assert_eq!(s.value(), 2.0);

Complexity

The complexities of summing n numbers are:

  • time: from O(n) (optimistic) to O(n²) (pessimistic)
  • memory: from O(1) (optimistic) to O(n) (pessimistic)

Usually the complexities are close to optimistic.

References

Calculation code bases on (is mostly copied from) sum method of test::stats::Stats implementation for f64 (which probably reimplements math.fsum from Python's library) and source of CPython. See also:

The method sacrifices performance at the altar of accuracy Depends on IEEE-754 arithmetic guarantees. See proof of the correctness in Adaptive Precision Floating-Point Arithmetic and Fast Robust Geometric Predicates