1
0
mirror of https://github.com/golang/go synced 2024-11-19 14:54:43 -07:00

math: make function documentation more regular

R=rsc, golang-dev
CC=golang-dev
https://golang.org/cl/5994043
This commit is contained in:
Charles L. Dorian 2012-04-06 14:01:12 -04:00 committed by Russ Cox
parent 559c191b89
commit f27348776f
10 changed files with 12 additions and 12 deletions

View File

@ -33,7 +33,7 @@ package math
// acosh(NaN) is NaN without signal.
//
// Acosh(x) calculates the inverse hyperbolic cosine of x.
// Acosh returns the inverse hyperbolic cosine of x.
//
// Special cases are:
// Acosh(+Inf) = +Inf

View File

@ -30,7 +30,7 @@ package math
// := sign(x)*log1p(|x| + x**2/(1 + sqrt(1+x**2)))
//
// Asinh(x) calculates the inverse hyperbolic sine of x.
// Asinh returns the inverse hyperbolic sine of x.
//
// Special cases are:
// Asinh(±0) = ±0

View File

@ -36,7 +36,7 @@ package math
// atanh(+-1) is +-INF with signal.
//
// Atanh(x) calculates the inverse hyperbolic tangent of x.
// Atanh returns the inverse hyperbolic tangent of x.
//
// Special cases are:
// Atanh(1) = +Inf

View File

@ -12,7 +12,7 @@ package math
(http://www.jstor.org/stable/2006387?seq=9, accessed 11-Feb-2010)
*/
// Cbrt returns the cube root of its argument.
// Cbrt returns the cube root of x.
//
// Special cases are:
// Cbrt(±0) = ±0

View File

@ -4,7 +4,7 @@
package math
// Copysign(x, y) returns a value with the magnitude
// Copysign returns a value with the magnitude
// of x and the sign of y.
func Copysign(x, y float64) float64 {
const sign = 1 << 63

View File

@ -179,7 +179,7 @@ const (
sb7 = -2.24409524465858183362e+01 // 0xC03670E242712D62
)
// Erf(x) returns the error function of x.
// Erf returns the error function of x.
//
// Special cases are:
// Erf(+Inf) = 1
@ -256,7 +256,7 @@ func Erf(x float64) float64 {
return 1 - r/x
}
// Erfc(x) returns the complementary error function of x.
// Erfc returns the complementary error function of x.
//
// Special cases are:
// Erfc(+Inf) = 0

View File

@ -110,7 +110,7 @@ func stirling(x float64) float64 {
return y
}
// Gamma(x) returns the Gamma function of x.
// Gamma returns the Gamma function of x.
//
// Special cases are:
// Gamma(+Inf) = +Inf

View File

@ -8,7 +8,7 @@ package math
Hypot -- sqrt(p*p + q*q), but overflows only if the result does.
*/
// Hypot computes Sqrt(p*p + q*q), taking care to avoid
// Hypot returns Sqrt(p*p + q*q), taking care to avoid
// unnecessary overflow and underflow.
//
// Special cases are:

View File

@ -4,7 +4,7 @@
package math
// Logb(x) returns the binary exponent of x.
// Logb returns the binary exponent of x.
//
// Special cases are:
// Logb(±Inf) = +Inf
@ -23,7 +23,7 @@ func Logb(x float64) float64 {
return float64(ilogb(x))
}
// Ilogb(x) returns the binary exponent of x as an integer.
// Ilogb returns the binary exponent of x as an integer.
//
// Special cases are:
// Ilogb(±Inf) = MaxInt32

View File

@ -6,7 +6,7 @@ package math
// Coefficients _sin[] and _cos[] are found in pkg/math/sin.go.
// Sincos(x) returns Sin(x), Cos(x).
// Sincos returns Sin(x), Cos(x).
//
// Special cases are:
// Sincos(±0) = ±0, 1