Documentation
¶
Overview ¶
Package GLaM Math provides fast float32 math functions.
Index ¶
- Constants
- func Abs(x float32) float32
- func Cos(x float32) float32
- func FastCos(x float32) float32
- func FastFloor(x float32) int32
- func FastSin(x float32) float32
- func Float32bits(f float32) uint32
- func Float32frombits(b uint32) float32
- func Float64bits(f float64) uint64
- func Float64frombits(b uint64) float64
- func Floor(x float32) float32
- func Inf(sign int) float32
- func IsAlmostEqual(a, b float32, ulps uint32) bool
- func IsInf(f float32, sign int) bool
- func IsNaN(f float32) (is bool)
- func IsNearlyEqual(a, b float32, epsilon float32) bool
- func IsRoughlyEqual(a, b float32, epsilon float32) bool
- func Mix(x, y float32, a float32) float32
- func NaN() float32
- func Normalized(x float32) (y float32, exp int)
- func Round(x float32) int32
- func Sin(x float32) float32
- func Sqrt(x float32) float32
- func Tan(x float32) float32
Constants ¶
const ( E = float32(2.71828182845904523536028747135266249775724709369995957496696763) // A001113 Pi = float32(3.14159265358979323846264338327950288419716939937510582097494459) // A000796 Phi = float32(1.61803398874989484820458683436563811772030917980576286213544862) // A001622 Sqrt2 = float32(1.41421356237309504880168872420969807856967187537694807317667974) // A002193 SqrtE = float32(1.64872127070012814684865078781416357165377610071014801157507931) // A019774 SqrtPi = float32(1.77245385090551602729816748334114518279754945612238712821380779) // A002161 SqrtPhi = float32(1.27201964951406896425242246173749149171560804184009624861664038) // A139339 Ln2 = float32(0.693147180559945309417232121458176568075500134360255254120680009) // A002162 Log2E = float32(1 / Ln2) Ln10 = float32(2.30258509299404568401799145468436420760110148862877297603332790) // A002392 Log10E = float32(1 / Ln10) )
Mathematical constants. Reference: http://oeis.org/Axxxxxx
const ( MaxFloat32 = float32(3.40282346638528859811704183484516925440e+38) // 2**127 * (2**24 - 1) / 2**23 SmallestNormalFloat32 = float32(1.17549435082229e-38) // 1 / 2**(127 - 1) EpsilonFloat32 = float32(1.19209290e-07) // 1 / 2**23 SmallestNonzeroFloat32 = float32(1.401298464324817070923729583289916131280e-45) // 1 / 2**(127 - 1 + 23) MaxFloat64 = 1.797693134862315708145274237317043567981e+308 // 2**1023 * (2**53 - 1) / 2**52 SmallestNormalFloat64 = 2.2250738585072014e-308 // 1 / 2**(1023 - 1) EpsilonFloat64 = 2.2204460492503131e-16 // 1 / 2**52 SmallestNonzeroFloat64 = 4.940656458412465441765687928682213723651e-324 // 1 / 2**(1023 - 1 + 52) )
Floating-point limit values. `Max` is the largest finite value representable by the type. `SmallestNormal` is the smallest normal value representable by the type. `Epsilon` is the smallest value that, when added to one, yields a result different from one. `SmallestNonzero` is the smallest positive, non-zero value representable by the type.
const ( MaxInt8 = 1<<7 - 1 MinInt8 = -1 << 7 MaxInt16 = 1<<15 - 1 MinInt16 = -1 << 15 MaxInt32 = 1<<31 - 1 MinInt32 = -1 << 31 MaxInt64 = 1<<63 - 1 MinInt64 = -1 << 63 MaxUint8 = 1<<8 - 1 MaxUint16 = 1<<16 - 1 MaxUint32 = 1<<32 - 1 MaxUint64 = 1<<64 - 1 )
Integer limit values.
Variables ¶
This section is empty.
Functions ¶
func FastCos ¶
`FastCos` returns an approximation of `sin(x)`.
Max absolute error in range [-Pi, Pi]: less than 1e-3
Faster than `Cos`.
func FastSin ¶
`FastSin` returns an approximation of `sin(x)`.
Max absolute error in range [-Pi, Pi]: less than 1e-3
Faster than `Sin`.
func Float32bits ¶
`Float32bits` returns the IEEE 754 binary representation of `f`.
func Float32frombits ¶
`Float32frombits` returns the floating point number corresponding to the IEEE 754 binary representation `b`.
func Float64bits ¶
`Float64bits` returns the IEEE 754 binary representation of `f`.
func Float64frombits ¶
`Float64frombits` returns the floating point number corresponding the IEEE 754 binary representation `b`.
func IsAlmostEqual ¶
`IsAlmostEqual` returns true if the difference between `a` and `b` in ULPs (Unit in the Last Place) is less than `ulps`.
Handle special cases: zero, infinites, denormals.
See also `IsNearlyEqual` and `IsRoughlyEqual`.
func IsInf ¶
`IsInf` returns whether `f` is an infinity, according to `sign`. If `sign` > 0, `IsInf` returns whether `f` is positive infinity. If `sign` < 0, `IsInf` returns whether `f` is negative infinity. If `sign` == 0, `IsInf` returns whether `f` is either infinity.
func IsNearlyEqual ¶
`IsNearlyEqual` Returns true if the relative error between `a` and `b` is less than `epsilon`.
Handles special cases: zero, infinites, denormals.
See also `IsAlmostEqual` and `IsRoughlyEqual`.
func IsRoughlyEqual ¶
`IsRoughlyEqual` Returns true if the absolute error between `a` and `b` is less than `epsilon`.
See also `IsNearlyEqual` and `IsAlmostEqual`.
func Mix ¶
`Mix` returns the linear interpolation between `x` and `y` using `a` to weight between them. The value is computed as follows: `x*(1-a) + y*a`
func Normalized ¶
`Normalized` returns a normal number `y` and exponent `exp` satisfying `x == y × 2**exp`. It assumes `x` is finite and non-zero.
Types ¶
This section is empty.
Source Files