Explain why to use saturation

workingjubilee · workingjubilee · commit 331230fabff2 · 2021-04-02T09:11:27.000-07:00
diff --git a/crates/core_simd/src/math.rs b/crates/core_simd/src/math.rs
@@ -80,6 +80,7 @@ macro_rules! impl_int_arith {
             }
 
             /// Lanewise saturating absolute value, implemented in Rust.
+            /// As abs(), except the MIN value becomes MAX instead of itself.
             ///
             /// # Examples
             /// # use core_simd::*;
@@ -99,6 +100,7 @@ macro_rules! impl_int_arith {
             }
 
             /// Lanewise saturating negation, implemented in Rust.
+            /// As neg(), except the MIN value becomes MAX instead of itself.
             ///
             /// # Examples
             /// # use core_simd::*;

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@ macro_rules! impl_int_arith {`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`/// Lanewise saturating absolute value, implemented in Rust.`
	`83`	`+ /// As abs(), except the MIN value becomes MAX instead of itself.`
`83`	`84`	`///`
`84`	`85`	`/// # Examples`
`85`	`86`	`/// # use core_simd::*;`
`@@ -99,6 +100,7 @@ macro_rules! impl_int_arith {`
`99`	`100`	`}`
`100`	`101`
`101`	`102`	`/// Lanewise saturating negation, implemented in Rust.`
	`103`	`+ /// As neg(), except the MIN value becomes MAX instead of itself.`
`102`	`104`	`///`
`103`	`105`	`/// # Examples`
`104`	`106`	`/// # use core_simd::*;`