accurate 0.4.1

(more or less) accurate floating point algorithms
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

//! Summation traits

use std::ops::{Add, AddAssign};

use num_traits::Zero;

#[cfg(feature = "parallel")]
use rayon::iter::ParallelIterator;

pub use crate::sum::ifastsum::IFastSum;

#[cfg(feature = "parallel")]
use crate::sum::SumConsumer;

/// Accumulates terms of a sum
pub trait SumAccumulator<F>: Add<F, Output = Self> + AddAssign<F> + From<F> + Clone {
    /// Initial value for an accumulator
    fn zero() -> Self
    where
        F: Zero,
    {
        Self::from(F::zero())
    }

    /// The sum of all terms accumulated so far
    fn sum(self) -> F;

    /// Absorb the items of an iterator into the accumulator
    ///
    /// # Examples
    ///
    /// ```
    /// use accurate::traits::*;
    /// use accurate::sum::Sum2;
    ///
    /// let s = Sum2::zero().absorb(vec![1.0, 2.0, 3.0]);
    /// assert_eq!(6.0f64, s.sum())
    /// ```
    fn absorb<I>(self, it: I) -> Self
    where
        I: IntoIterator<Item = F>,
    {
        it.into_iter().fold(self, |acc, x| acc + x)
    }
}

/// Sums the items of an iterator
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum2;
///
/// let s = vec![1.0, 2.0, 3.0].sum_with_accumulator::<Sum2<_>>();
/// assert_eq!(6.0f64, s);
/// ```
pub trait SumWithAccumulator<F> {
    /// Sums the items of an iterator
    fn sum_with_accumulator<Acc>(self) -> F
    where
        Acc: SumAccumulator<F>,
        F: Zero;
}

impl<I, F> SumWithAccumulator<F> for I
where
    I: IntoIterator<Item = F>,
{
    fn sum_with_accumulator<Acc>(self) -> F
    where
        Acc: SumAccumulator<F>,
        F: Zero,
    {
        Acc::zero().absorb(self).sum()
    }
}

/// A `SumAccumulator` that can be used in parallel computations
#[cfg(feature = "parallel")]
pub trait ParallelSumAccumulator<F>:
    SumAccumulator<F> + Add<Self, Output = Self> + Send + Sized
{
    /// Turns an accumulator into a consumer
    #[inline]
    fn into_consumer(self) -> SumConsumer<Self> {
        SumConsumer(self)
    }
}

#[cfg(feature = "parallel")]
impl<Acc, F> ParallelSumAccumulator<F> for Acc where
    Acc: SumAccumulator<F> + Add<Acc, Output = Acc> + Send + Sized
{
}

/// Sums the items of an iterator, possibly in parallel
///
/// # Examples
///
/// ```
/// use rayon::prelude::*;
///
/// use accurate::traits::*;
/// use accurate::sum::OnlineExactSum;
///
/// # fn main() {
/// let s = vec![1.0, 2.0, 3.0].par_iter().map(|&x| x)
///     .parallel_sum_with_accumulator::<OnlineExactSum<_>>();
/// assert_eq!(6.0f64, s);
/// # }
/// ```
#[cfg(feature = "parallel")]
pub trait ParallelSumWithAccumulator<F>: ParallelIterator<Item = F>
where
    F: Send,
{
    /// Sums the items of an iterator, possibly in parallel
    fn parallel_sum_with_accumulator<Acc>(self) -> F
    where
        Acc: ParallelSumAccumulator<F>,
        F: Zero,
    {
        self.drive_unindexed(Acc::zero().into_consumer()).sum()
    }
}

#[cfg(feature = "parallel")]
impl<T, F> ParallelSumWithAccumulator<F> for T
where
    T: ParallelIterator<Item = F>,
    F: Zero + Send,
{
}