diff options
Diffstat (limited to 'api/nums.yaml')
| -rw-r--r-- | api/nums.yaml | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/api/nums.yaml b/api/nums.yaml index 2c18fac5..bae87a5b 100644 --- a/api/nums.yaml +++ b/api/nums.yaml @@ -14,7 +14,7 @@ Num.abs: example: | >> (-3.5).abs() = 3.5 - + Num.acos: short: arc cosine description: > @@ -31,7 +31,7 @@ Num.acos: example: | >> (0.0).acos() // -> (π/2) = 1.5708 - + Num.acosh: short: arc hyperbolic cosine description: > @@ -48,7 +48,7 @@ Num.acosh: example: | >> (1.0).acosh() = 0 - + Num.asin: short: arc sine description: > @@ -65,7 +65,7 @@ Num.asin: example: | >> (0.5).asin() // -> (π/6) = 0.5236 - + Num.asinh: short: arc hyperbolic sine description: > @@ -82,7 +82,7 @@ Num.asinh: example: | >> (0.0).asinh() = 0 - + Num.atan: short: arc tangent description: > @@ -99,7 +99,7 @@ Num.atan: example: | >> (1.0).atan() // -> (π/4) = 0.7854 - + Num.atan2: short: arc tangent from 2 variables description: > @@ -120,7 +120,7 @@ Num.atan2: example: | >> Num.atan2(1, 1) // -> (π/4) = 0.7854 - + Num.atanh: short: arc hyperbolic tangent. description: > @@ -137,7 +137,7 @@ Num.atanh: example: | >> (0.5).atanh() = 0.5493 - + Num.cbrt: short: cube root description: > @@ -154,7 +154,7 @@ Num.cbrt: example: | >> (27.0).cbrt() = 3 - + Num.ceil: short: ceiling function description: > @@ -171,7 +171,7 @@ Num.ceil: example: | >> (3.2).ceil() = 4 - + Num.clamped: short: clamp a number description: > @@ -197,7 +197,7 @@ Num.clamped: example: | >> (2.5).clamped(5.5, 10.5) = 5.5 - + Num.copysign: short: copy a number's sign description: > @@ -218,7 +218,7 @@ Num.copysign: example: | >> (3.0).copysign(-1) = -3 - + Num.cos: short: cosine description: > @@ -235,7 +235,7 @@ Num.cos: example: | >> (0.0).cos() = 1 - + Num.cosh: short: hyperbolic cosine description: > @@ -252,7 +252,7 @@ Num.cosh: example: | >> (0.0).cosh() = 1 - + Num.erf: short: error function description: > @@ -269,7 +269,7 @@ Num.erf: example: | >> (0.0).erf() = 0 - + Num.erfc: short: complimentary error function description: > @@ -286,7 +286,7 @@ Num.erfc: example: | >> (0.0).erfc() = 1 - + Num.exp: short: base-e exponentiation description: > @@ -303,7 +303,7 @@ Num.exp: example: | >> (1.0).exp() = 2.7183 - + Num.exp2: short: base-2 exponentiation description: > @@ -320,7 +320,7 @@ Num.exp2: example: | >> (3.0).exp2() = 8 - + Num.expm1: short: base-e exponential minus 1 description: > @@ -337,7 +337,7 @@ Num.expm1: example: | >> (1.0).expm1() = 1.7183 - + Num.fdim: short: positive difference description: > @@ -357,10 +357,10 @@ Num.fdim: The second number. example: | fd - + >> (5.0).fdim(3) = 2 - + Num.floor: short: floor function description: > @@ -377,7 +377,7 @@ Num.floor: example: | >> (3.7).floor() = 3 - + Num.hypot: short: Euclidean distance function description: > @@ -398,7 +398,7 @@ Num.hypot: example: | >> Num.hypot(3, 4) = 5 - + Num.isfinite: short: check for finite number description: > @@ -417,7 +417,7 @@ Num.isfinite: = yes >> Num.INF.isfinite() = no - + Num.is_between: short: check if a number is in a range description: > @@ -446,7 +446,7 @@ Num.is_between: = no >> (7.5).is_between(1, 7.5) = yes - + Num.isinf: short: check for infinite number description: > @@ -465,7 +465,7 @@ Num.isinf: = yes >> (1.0).isinf() = no - + Num.j0: short: Bessel function description: > @@ -482,7 +482,7 @@ Num.j0: example: | >> (0.0).j0() = 1 - + Num.j1: short: Bessel function description: > @@ -499,7 +499,7 @@ Num.j1: example: | >> (0.0).j1() = 0 - + Num.log: short: natural logarithm description: > @@ -516,7 +516,7 @@ Num.log: example: | >> Num.E.log() = 1 - + Num.log10: short: logarithm base-10 description: > @@ -533,7 +533,7 @@ Num.log10: example: | >> (100.0).log10() = 2 - + Num.log1p: short: logarithm of 1 plus x description: > @@ -550,7 +550,7 @@ Num.log1p: example: | >> (1.0).log1p() = 0.6931 - + Num.log2: short: logarithm base-2 description: > @@ -567,7 +567,7 @@ Num.log2: example: | >> (8.0).log2() = 3 - + Num.logb: short: exponent of a floating point value description: > @@ -584,7 +584,7 @@ Num.logb: example: | >> (8.0).logb() = 3 - + Num.mix: short: mix two numbers by an amount description: > @@ -611,7 +611,7 @@ Num.mix: = 15 >> (0.25).mix(10, 20) = 12.5 - + Num.near: short: check if two numbers are near each other description: > @@ -644,13 +644,13 @@ Num.near: example: | >> (1.0).near(1.000000001) = yes - + >> (100.0).near(110, ratio=0.1) = yes - + >> (5.0).near(5.1, min_epsilon=0.1) = yes - + Num.nextafter: short: next floating point number description: > @@ -671,7 +671,7 @@ Num.nextafter: example: | >> (1.0).nextafter(1.1) = 1.0000000000000002 - + Num.parse: short: convert text to number description: > @@ -705,7 +705,7 @@ Num.parse: = 1.5 : Num? >> remainder = "junk" - + Num.percent: short: format as a percentage description: > @@ -758,7 +758,7 @@ Num.with_precision: = 123500 >> (1234567.).with_precision(5) = 1234565 - + Num.rint: short: round to nearest integer description: > @@ -777,7 +777,7 @@ Num.rint: = 4 >> (2.5).rint() = 2 - + Num.round: short: round to nearest integer description: > @@ -796,7 +796,7 @@ Num.round: = 2 >> (2.7).round() = 3 - + Num.significand: short: get mantissa description: > @@ -813,7 +813,7 @@ Num.significand: example: | >> (1234.567).significand() = 0.1234567 - + Num.sin: short: sine description: > @@ -830,7 +830,7 @@ Num.sin: example: | >> (0.0).sin() = 0 - + Num.sinh: short: hyperbolic sine description: > @@ -847,7 +847,7 @@ Num.sinh: example: | >> (0.0).sinh() = 0 - + Num.sqrt: short: square root description: > @@ -864,7 +864,7 @@ Num.sqrt: example: | >> (16.0).sqrt() = 4 - + Num.tan: short: tangent description: > @@ -881,7 +881,7 @@ Num.tan: example: | >> (0.0).tan() = 0 - + Num.tanh: short: hyperbolic tangent description: > @@ -898,7 +898,7 @@ Num.tanh: example: | >> (0.0).tanh() = 0 - + Num.tgamma: short: "true gamma function" description: > @@ -915,7 +915,7 @@ Num.tgamma: example: | >> (1.0).tgamma() = 1 - + Num.trunc: short: truncate a number description: > @@ -934,7 +934,7 @@ Num.trunc: = 3 >> (-3.7).trunc() = -3 - + Num.y0: short: Bessel function description: > @@ -951,7 +951,7 @@ Num.y0: example: | >> (1.0).y0() = -0.7652 - + Num.y1: short: Bessel function description: > @@ -968,7 +968,7 @@ Num.y1: example: | >> (1.0).y1() = 0.4401 - + Num.1_PI: short: 1/pi |