diff options
Diffstat (limited to 'stdlib/source/documentation/lux/math/number')
10 files changed, 67 insertions, 67 deletions
diff --git a/stdlib/source/documentation/lux/math/number/complex.lux b/stdlib/source/documentation/lux/math/number/complex.lux index c615842f2..5063568a9 100644 --- a/stdlib/source/documentation/lux/math/number/complex.lux +++ b/stdlib/source/documentation/lux/math/number/complex.lux @@ -49,10 +49,10 @@ ($.default /.roots) ($.default /.approximately?) - ($.documentation /.Complex + ($.definition /.Complex "A complex number.") - ($.documentation /.complex + ($.definition /.complex "Complex literals." [(complex real imaginary)] ["The imaginary part can be omitted if it's +0.0." diff --git a/stdlib/source/documentation/lux/math/number/frac.lux b/stdlib/source/documentation/lux/math/number/frac.lux index 0b27d0b0f..c6fe1ce19 100644 --- a/stdlib/source/documentation/lux/math/number/frac.lux +++ b/stdlib/source/documentation/lux/math/number/frac.lux @@ -66,28 +66,28 @@ ($.default /.asech) ($.default /.acsch) - ($.documentation /.= + ($.definition /.= "Frac(tion) equivalence." [(= reference sample)]) - ($.documentation /.< + ($.definition /.< "Frac(tion) less-than." [(< reference sample)]) - ($.documentation /.<= + ($.definition /.<= "Frac(tion) less-than or equal." [(<= reference sample)]) - ($.documentation /.> + ($.definition /.> "Frac(tion) greater-than." [(> reference sample)]) - ($.documentation /.>= + ($.definition /.>= "Frac(tion) greater-than or equal." [(>= reference sample)]) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.+ "Frac(tion) addition."] @@ -97,12 +97,12 @@ [/.% "Frac(tion) remainder."] )) - ($.documentation /./% + ($.definition /./% "" [(/% param subject)]) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.min "Frac(tion) minimum."] @@ -110,7 +110,7 @@ )) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.not_a_number "Not a number."] @@ -118,36 +118,36 @@ [/.negative_infinity "Negative infinity."] )) - ($.documentation /.not_a_number? + ($.definition /.not_a_number? "Tests whether a frac is actually not-a-number." [(not_a_number? it)]) - ($.documentation /.approximately? + ($.definition /.approximately? "" [(approximately? margin_of_error standard value)]) - ($.documentation /.mod + ($.definition /.mod "" [(mod divisor dividend)]) - ($.documentation /.e + ($.definition /.e "The base of the natural logarithm.") - ($.documentation /.pi + ($.definition /.pi "The ratio of a circle's circumference to its diameter.") - ($.documentation /.tau + ($.definition /.tau "The ratio of a circle's circumference to its radius.") - ($.documentation /.pow + ($.definition /.pow "" [(pow param subject)]) - ($.documentation /.atan_2 + ($.definition /.atan_2 "" [(atan_2 x y)]) - ($.documentation /.log_by + ($.definition /.log_by "" [(log_by base it)])] []))) diff --git a/stdlib/source/documentation/lux/math/number/i16.lux b/stdlib/source/documentation/lux/math/number/i16.lux index 8f0caf9b7..aebc72982 100644 --- a/stdlib/source/documentation/lux/math/number/i16.lux +++ b/stdlib/source/documentation/lux/math/number/i16.lux @@ -17,6 +17,6 @@ ($.default /.i16) ($.default /.i64) - ($.documentation /.I16 + ($.definition /.I16 "A 16-bit integer.")] [])) diff --git a/stdlib/source/documentation/lux/math/number/i32.lux b/stdlib/source/documentation/lux/math/number/i32.lux index 726301ba6..ecf4fdc3d 100644 --- a/stdlib/source/documentation/lux/math/number/i32.lux +++ b/stdlib/source/documentation/lux/math/number/i32.lux @@ -17,6 +17,6 @@ ($.default /.i32) ($.default /.i64) - ($.documentation /.I32 + ($.definition /.I32 "A 32-bit integer.")] [])) diff --git a/stdlib/source/documentation/lux/math/number/i64.lux b/stdlib/source/documentation/lux/math/number/i64.lux index 1481ef25b..bdbd334db 100644 --- a/stdlib/source/documentation/lux/math/number/i64.lux +++ b/stdlib/source/documentation/lux/math/number/i64.lux @@ -26,7 +26,7 @@ ($.default /.right_rotated) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.or "Bitwise or."] @@ -37,29 +37,29 @@ [/.right_shifted "Unsigned/logic bitwise right-shift."] )) - ($.documentation /.Mask + ($.definition /.Mask "A pattern of bits that can be imposed on I64 values.") - ($.documentation /.bit + ($.definition /.bit "A mask with only a specific bit set." [(bit position)]) - ($.documentation /.sign + ($.definition /.sign "A mask for the sign bit of ints.") - ($.documentation /.not + ($.definition /.not "Bitwise negation.") - ($.documentation /.mask + ($.definition /.mask "Mask a block of bits of the specified size." [(mask amount_of_bits)]) - ($.documentation /.ones + ($.definition /.ones "Count the number of 1s in a bit-map." [(ones it)]) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.zero "Clear bit at the given index."] @@ -67,22 +67,22 @@ [/.flipped "Flip bit at given index."] )) - ($.documentation /.one? + ($.definition /.one? "" [(one? index input)]) - ($.documentation /.zero? + ($.definition /.zero? "" [(zero? index input)]) - ($.documentation /.region + ($.definition /.region "A mask for a block of bits of the given size, starting at the given offset." [(region offset size)]) - ($.documentation (/.Sub width) + ($.definition (/.Sub width) "A sub-space of I64 with a reduce amount of bits.") - ($.documentation /.sub + ($.definition /.sub "Given a width in the interval (0,64), yields an implementation for integers of that width." [(sub width)])] []))) diff --git a/stdlib/source/documentation/lux/math/number/i8.lux b/stdlib/source/documentation/lux/math/number/i8.lux index 5e8e3c870..8ddcecb84 100644 --- a/stdlib/source/documentation/lux/math/number/i8.lux +++ b/stdlib/source/documentation/lux/math/number/i8.lux @@ -17,6 +17,6 @@ ($.default /.i8) ($.default /.i64) - ($.documentation /.I8 + ($.definition /.I8 "A 8-bit integer.")] [])) diff --git a/stdlib/source/documentation/lux/math/number/int.lux b/stdlib/source/documentation/lux/math/number/int.lux index e1494b9ba..b840ff34e 100644 --- a/stdlib/source/documentation/lux/math/number/int.lux +++ b/stdlib/source/documentation/lux/math/number/int.lux @@ -33,28 +33,28 @@ ($.default /.hex) ($.default /.hash) - ($.documentation /.= + ($.definition /.= "Int(eger) equivalence." [(= reference sample)]) - ($.documentation /.< + ($.definition /.< "Int(eger) less-than." [(< reference sample)]) - ($.documentation /.<= + ($.definition /.<= "Int(eger) less-than or equal." [(<= reference sample)]) - ($.documentation /.> + ($.definition /.> "Int(eger) greater-than." [(> reference sample)]) - ($.documentation /.>= + ($.definition /.>= "Int(eger) greater-than or equal." [(>= reference sample)]) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.min "Int(eger) minimum."] @@ -62,7 +62,7 @@ )) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.+ "Int(eger) addition."] @@ -73,30 +73,30 @@ [/./% "Int(eger) [division remainder]."] )) - ($.documentation /.opposite + ($.definition /.opposite "A value of equal magnitude and opposite sign.") - ($.documentation /.abs + ($.definition /.abs "A value of equal magnitude and positive sign.") - ($.documentation /.signum + ($.definition /.signum "A value (either -1, 0 or +0) which represents the sign.") - ($.documentation /.mod + ($.definition /.mod (format "Integer modulo." \n "Note: The modulo and the remainder are not the same.") [(mod divisor dividend)]) - ($.documentation /.gcd + ($.definition /.gcd "Greatest Common Divisor.") - ($.documentation /.extended_gcd + ($.definition /.extended_gcd "Extended euclidean algorithm.") - ($.documentation /.lcm + ($.definition /.lcm "Least Common Multiple.") - ($.documentation /.right_shifted + ($.definition /.right_shifted "Signed/arithmetic bitwise right-shift." [(right_shifted parameter subject)])] []))) diff --git a/stdlib/source/documentation/lux/math/number/nat.lux b/stdlib/source/documentation/lux/math/number/nat.lux index ac7c6aa10..c1ae8d81c 100644 --- a/stdlib/source/documentation/lux/math/number/nat.lux +++ b/stdlib/source/documentation/lux/math/number/nat.lux @@ -31,7 +31,7 @@ ($.default /.hash) (,, (with_template [<name> <documentation>] - [($.documentation <name> + [($.definition <name> <documentation>)] [/.= "Nat(ural) equivalence."] @@ -48,16 +48,16 @@ )) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.min "Nat(ural) minimum."] [/.max "Nat(ural) maximum."] )) - ($.documentation /.gcd + ($.definition /.gcd "Greatest Common Divisor.") - ($.documentation /.lcm + ($.definition /.lcm "Least Common Multiple.")] []))) diff --git a/stdlib/source/documentation/lux/math/number/ratio.lux b/stdlib/source/documentation/lux/math/number/ratio.lux index 7cc00373b..a5c2b8473 100644 --- a/stdlib/source/documentation/lux/math/number/ratio.lux +++ b/stdlib/source/documentation/lux/math/number/ratio.lux @@ -30,10 +30,10 @@ ($.default /.addition) ($.default /.multiplication) - ($.documentation /.Ratio + ($.definition /.Ratio "An unsigned ratio of numbers.") - ($.documentation /.ratio + ($.definition /.ratio "Rational literals." [(ratio numerator denominator)] ["The denominator can be omitted if it is 1." diff --git a/stdlib/source/documentation/lux/math/number/rev.lux b/stdlib/source/documentation/lux/math/number/rev.lux index 1d4c746d6..e0ea88432 100644 --- a/stdlib/source/documentation/lux/math/number/rev.lux +++ b/stdlib/source/documentation/lux/math/number/rev.lux @@ -40,28 +40,28 @@ ($.default /.hex) ($.default /.decimal) - ($.documentation /.= + ($.definition /.= "Rev(olution) equivalence." [(= reference sample)]) - ($.documentation /.< + ($.definition /.< "Rev(olution) less-than." [(< reference sample)]) - ($.documentation /.<= + ($.definition /.<= "Rev(olution) less-than or equal." [(<= reference sample)]) - ($.documentation /.> + ($.definition /.> "Rev(olution) greater-than." [(> reference sample)]) - ($.documentation /.>= + ($.definition /.>= "Rev(olution) greater-than or equal." [(>= reference sample)]) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.min "Rev(olution) minimum."] @@ -69,7 +69,7 @@ )) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.+ "Rev(olution) addition."] @@ -80,15 +80,15 @@ [/.ratio "Ratio between two rev(olution)s."] )) - ($.documentation /.up + ($.definition /.up "" [(up scale subject)]) - ($.documentation /.down + ($.definition /.down "" [(down scale subject)]) - ($.documentation /.reciprocal + ($.definition /.reciprocal "Rev(olution) reciprocal of a Nat(ural)." [(reciprocal numerator)])] []))) |