Fix descriptions of erfc and erfcf

As described in the second paragraph of the docs for these functions, they are
the complementary error function, not the error function.
This commit is contained in:
James D. Turner
2023-01-20 13:39:41 -05:00
parent dc82800163
commit 7e93ce9017
2 changed files with 2 additions and 2 deletions
+1 -1
View File
@@ -263,7 +263,7 @@ pub fn erf(x: f64) -> f64 {
} }
} }
/// Error function (f64) /// Complementary error function (f64)
/// ///
/// Calculates the complementary probability. /// Calculates the complementary probability.
/// Is `1 - erf(x)`. Is computed directly, so that you can use it to avoid /// Is `1 - erf(x)`. Is computed directly, so that you can use it to avoid
+1 -1
View File
@@ -174,7 +174,7 @@ pub fn erff(x: f32) -> f32 {
} }
} }
/// Error function (f32) /// Complementary error function (f32)
/// ///
/// Calculates the complementary probability. /// Calculates the complementary probability.
/// Is `1 - erf(x)`. Is computed directly, so that you can use it to avoid /// Is `1 - erf(x)`. Is computed directly, so that you can use it to avoid