[go: up one dir, main page]

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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

//! The `SumK` algorithm

#[cfg(doc)]
use embed_doc_image::embed_doc_image;

use crate::sum::cascaded::Cascaded;
use crate::sum::NaiveSum;
use crate::util::Knuth;

/// Calculates a sum using cascaded accumulators for the remainder terms
///
/// See also `Sum2`... `Sum9`.
///
/// ![][SumK]
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type SumK<F, C> = Cascaded<F, C, Knuth>;

/// `SumK` with two cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum2;
///
/// let s = Sum2::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum2<F> = SumK<F, NaiveSum<F>>;

/// `SumK` with three cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum3;
///
/// let s = Sum3::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum3<F> = SumK<F, Sum2<F>>;

/// `SumK` with four cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum4;
///
/// let s = Sum4::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum4<F> = SumK<F, Sum3<F>>;

/// `SumK` with five cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum5;
///
/// let s = Sum5::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum5<F> = SumK<F, Sum4<F>>;

/// `SumK` with six cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum6;
///
/// let s = Sum6::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum6<F> = SumK<F, Sum5<F>>;

/// `SumK` with seven cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum7;
///
/// let s = Sum7::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum7<F> = SumK<F, Sum6<F>>;

/// `SumK` with eight cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum8;
///
/// let s = Sum8::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum8<F> = SumK<F, Sum7<F>>;

/// `SumK` with nine cascaded accumulators
///
/// ![][SumK]
///
/// # Examples
///
/// ```
/// use accurate::traits::*;
/// use accurate::sum::Sum9;
///
/// let s = Sum9::zero() + 1.0 + 2.0 + 3.0;
/// assert_eq!(6.0f64, s.sum());
/// ```
///
/// # References
///
/// Based on [Ogita, Rump and Oishi 05](http://dx.doi.org/10.1137/030601818)
#[cfg_attr(doc, embed_doc_image("SumK", "images/SumK.svg"))]
pub type Sum9<F> = SumK<F, Sum8<F>>;