Added missing docs

This commit is contained in:
Justin Ethier 2017-08-21 13:37:02 +00:00
parent 3b75d3ea16
commit 12ad893f5d

View file

@ -85,73 +85,218 @@ Semantically equivalent to `=`.
# fx<? # fx<?
(fx<? i j)
Semantically equivalent to `<`.
# fx>? # fx>?
(fx>? i j)
Semantically equivalent to `>`.
# fx<=? # fx<=?
(fx<=? i j)
Semantically equivalent to `<=`.
# fx>=? # fx>=?
(fx>=? i j)
Semantically equivalent to `>=`.
# fxzero? # fxzero?
(fxzero? i)
Semantically equivalent to `zero?`.
# fxpositive? # fxpositive?
(fxpostiive? i)
Semantically equivalent to `positive?`.
# fxnegative? # fxnegative?
(fxnegative? i)
Semantically equivalent to `negative?`.
# fxodd? # fxodd?
(fxodd? i)
Semantically equivalent to `odd?`.
# fxeven? # fxeven?
(fxeven? i)
Semantically equivalent to `even?`.
# fxmax # fxmax
(fxmax i j)
Semantically equivalent to `max`.
# fxmin # fxmin
(fxmin i j)
Semantically equivalent to `min`.
# fx+ # fx+
(fx+ i j)
Semantically equivalent to `+`, but accepts exactly two arguments.
# fx- # fx-
(fx- i j)
Semantically equivalent to `-`, but accepts exactly two arguments.
# fx* # fx*
(fx* i j)
Semantically equivalent to `*`, but accepts exactly two arguments.
# fxneg # fxneg
(fxneg i)
Semantically equivalent to `-`, but accepts exactly one argument.
# fxquotient # fxquotient
(fxquotient i j)
Semantically equivalent to `quotient`.
# fxremainder # fxremainder
(fxremainder i j)
Semantically equivalent to `remainder`.
# fxabs # fxabs
(fxabs i)
Semantically equivalent to `abs`.
# fxsquare # fxsquare
(fxsquare i)
Semantically equivalent to `square`.
# fxsqrt # fxsqrt
(fxsqrt i)
Semantically equivalent to `sqrt`.
# fxnot # fxnot
(fxnot i)
Semantically equivalent to `bitwise-not`.
# fxand # fxand
(fxand i j)
Semantically equivalent to `bitwise-and`.
# fxior # fxior
(fxior i j)
Semantically equivalent to `bitwise-ior`.
# fxxor # fxxor
(fxxor i j)
Semantically equivalent to `bitwise-xor`.
# fxarithmetic-shift # fxarithmetic-shift
(fxarithmetic-shift i count)
Semantically equivalent to `arithmetic-shift`, except that it is an error for the absolute value of count to exceed `w-1`.
# fxarithmetic-shift-left # fxarithmetic-shift-left
(fxarithmetic-shift-left i count)
The same as `fxarithmetic-shift` except that a negative value of count is an error. This is provided for additional efficiency.
# fxarithmetic-shift-right # fxarithmetic-shift-right
(fxarithmetic-shift-right i count)
The same as `fxarithmetic-shift` except that a non-negative value of count specifies the number of bits to shift right, and a negative value is an error. This is provided for additional efficiency.
# fxbit-count # fxbit-count
(fxbit-count i)
Semantically equivalent to SRFI 151 `bit-count`.
# fxlength # fxlength
(fxlength i)
Semantically equivalent to `integer-length`.
# fxif # fxif
(fxif mask i j)
Semantically equivalent to `bitwise-if`.
# fxbit-set? # fxbit-set?
(fxbit-set? index i)
Semantically equivalent to SRFI 151 `bit-set?`, except that it is an error for `index` to be larger than or equal to `fx-width`.
# fxcopy-bit # fxcopy-bit
(fxcopy-bit index i boolean)
Semantically equivalent to SRFI 151 `copy-bit`, except that it is an error for `index` to be larger than or equal to `fx-width`.
# fxfirst-set-bit # fxfirst-set-bit
(fxfirst-set-bit i)
Semantically equivalent to `first-set-bit`.
# fxbit-field # fxbit-field
(fxbit-field i start end)
Semantically equivalent to `bit-field`.
# fxbit-field-rotate # fxbit-field-rotate
(fxbit-field-rotate i count start end)
Semantically equivalent to SRFI 151 `bit-field-rotate`.
# fxbit-field-reverse # fxbit-field-reverse
(fxbit-field-reverse i start end)
Semantically equivalent to `bit-field-reverse`.