bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #136710 - JakenHerman:jaken/iterator-docs, r=workingjubilee

Browse source 
Document `Sum::sum` returns additive identities for `[]`

Because the neutral element of `<fNN as iter::Sum>` was changed to `neg_zero`, the documentation needed to be updated, as it was reporting inadequate information about what should be expected from the return.

Relevant Commit: 4908188518
Relevant Pull Request: https://github.com/rust-lang/rust/pull/129321

---

The referenced commit causes unintended side effects on presentation layer applications like using Tera templates, for example. I'm not sure what the motivation was behind the original change, but it seems like more discussion should be put into this issue and potentially have that change reverted.
This commit is contained in:
Jubilee 2025-02-08 20:41:21 -08:00 • committed by GitHub
commit c30908979f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
library/core/src/iter/traits/iterator.rs
View file

@ -3493,7 +3493,8 @@ pub trait Iterator {
///
/// Takes each element, adds them together, and returns the result.
///
/// An empty iterator returns the zero value of the type.
/// An empty iterator returns the *additive identity* ("zero") of the type,
/// which is `0` for integers and `-0.0` for floats.
///
/// `sum()` can be used to sum any type implementing [`Sum`][`core::iter::Sum`],
/// including [`Option`][`Option::sum`] and [`Result`][`Result::sum`].
@ -3511,6 +3512,10 @@ pub trait Iterator {
/// let sum: i32 = a.iter().sum();
///
/// assert_eq!(sum, 6);
///
/// let b: Vec<f32> = vec![];
/// let sum: f32 = b.iter().sum();
/// assert_eq!(sum, -0.0_f32);
/// ```
#[stable(feature = "iter_arith", since = "1.11.0")]
fn sum<S>(self) -> S