Skip to content

Commit 62a0ebb

Browse files
authored
Fix docs and miri tests (#1523)
* Fixes some broken references in the docs * Raise allowable epsilon errors on logspace and geomspace For some reason, when Miri runs, we get higher floating point error on these methods.
1 parent 3ce0134 commit 62a0ebb

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

src/geomspace.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,16 +117,16 @@ mod tests
117117
use approx::assert_abs_diff_eq;
118118

119119
let array: Array1<_> = geomspace(1e0, 1e3, 4).unwrap().collect();
120-
assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]), epsilon = 1e-12);
120+
assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]), epsilon = 1e-11);
121121

122122
let array: Array1<_> = geomspace(1e3, 1e0, 4).unwrap().collect();
123-
assert_abs_diff_eq!(array, arr1(&[1e3, 1e2, 1e1, 1e0]), epsilon = 1e-12);
123+
assert_abs_diff_eq!(array, arr1(&[1e3, 1e2, 1e1, 1e0]), epsilon = 1e-11);
124124

125125
let array: Array1<_> = geomspace(-1e3, -1e0, 4).unwrap().collect();
126-
assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]), epsilon = 1e-12);
126+
assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]), epsilon = 1e-11);
127127

128128
let array: Array1<_> = geomspace(-1e0, -1e3, 4).unwrap().collect();
129-
assert_abs_diff_eq!(array, arr1(&[-1e0, -1e1, -1e2, -1e3]), epsilon = 1e-12);
129+
assert_abs_diff_eq!(array, arr1(&[-1e0, -1e1, -1e2, -1e3]), epsilon = 1e-11);
130130
}
131131

132132
#[test]

src/impl_constructors.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,10 @@ where S: DataOwned<Elem = A>
140140
/// use ndarray::{Array, arr1};
141141
///
142142
/// let array = Array::logspace(10.0, 0.0, 3.0, 4);
143-
/// assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]));
143+
/// assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]), epsilon = 1e-12);
144144
///
145145
/// let array = Array::logspace(-10.0, 3.0, 0.0, 4);
146-
/// assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]));
146+
/// assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]), epsilon = 1e-12);
147147
/// # }
148148
/// ```
149149
#[cfg(feature = "std")]
@@ -171,10 +171,10 @@ where S: DataOwned<Elem = A>
171171
/// use ndarray::{Array, arr1};
172172
///
173173
/// let array = Array::geomspace(1e0, 1e3, 4)?;
174-
/// assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]), epsilon = 1e-12);
174+
/// assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]), epsilon = 1e-11);
175175
///
176176
/// let array = Array::geomspace(-1e3, -1e0, 4)?;
177-
/// assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]), epsilon = 1e-12);
177+
/// assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]), epsilon = 1e-11);
178178
/// # }
179179
/// # Some(())
180180
/// # }

src/impl_methods.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1435,7 +1435,7 @@ impl<A, D: Dimension> ArrayRef<A, D>
14351435
/// The windows are all distinct overlapping views of size `window_size`
14361436
/// that fit into the array's shape.
14371437
///
1438-
/// This is essentially equivalent to [`.windows_with_stride()`] with unit stride.
1438+
/// This is essentially equivalent to [`ArrayRef::windows_with_stride()`] with unit stride.
14391439
#[track_caller]
14401440
pub fn windows<E>(&self, window_size: E) -> Windows<'_, A, D>
14411441
where E: IntoDimension<Dim = D>
@@ -2170,7 +2170,7 @@ where
21702170
/// **Panics** if shapes are incompatible.
21712171
///
21722172
/// *This method is obsolete, because it is inflexible in how logical order
2173-
/// of the array is handled. See [`.to_shape()`].*
2173+
/// of the array is handled. See [`ArrayRef::to_shape()`].*
21742174
///
21752175
/// ```
21762176
/// use ndarray::{rcarr1, rcarr2};

src/logspace.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,16 @@ mod tests
111111
use approx::assert_abs_diff_eq;
112112

113113
let array: Array1<_> = logspace(10.0, 0.0, 3.0, 4).collect();
114-
assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]));
114+
assert_abs_diff_eq!(array, arr1(&[1e0, 1e1, 1e2, 1e3]), epsilon = 1e-12);
115115

116116
let array: Array1<_> = logspace(10.0, 3.0, 0.0, 4).collect();
117-
assert_abs_diff_eq!(array, arr1(&[1e3, 1e2, 1e1, 1e0]));
117+
assert_abs_diff_eq!(array, arr1(&[1e3, 1e2, 1e1, 1e0]), epsilon = 1e-12);
118118

119119
let array: Array1<_> = logspace(-10.0, 3.0, 0.0, 4).collect();
120-
assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]));
120+
assert_abs_diff_eq!(array, arr1(&[-1e3, -1e2, -1e1, -1e0]), epsilon = 1e-12);
121121

122122
let array: Array1<_> = logspace(-10.0, 0.0, 3.0, 4).collect();
123-
assert_abs_diff_eq!(array, arr1(&[-1e0, -1e1, -1e2, -1e3]));
123+
assert_abs_diff_eq!(array, arr1(&[-1e0, -1e1, -1e2, -1e3]), epsilon = 1e-12);
124124
}
125125

126126
#[test]

0 commit comments

Comments
 (0)