diff --git a/docs/API.md b/docs/API.md index 7ac937f6..43becbf7 100644 --- a/docs/API.md +++ b/docs/API.md @@ -53,7 +53,6 @@ Cyclone supports the following [Scheme Requests for Implementation (SRFI)](http: - [`srfi 128`](api/srfi/128) - [Comparators](http://srfi.schemers.org/srfi-128/srfi-128.html) - [`srfi 132`](api/srfi/132) - [Sort libraries](http://srfi.schemers.org/srfi-132/srfi-132.html) - [`srfi 133`](api/srfi/133) - [Vector library (R7RS-compatible)](http://srfi.schemers.org/srfi-133/srfi-133.html) -- [`srfi 143`](api/srfi/143) - [Fixnums](http://srfi.schemers.org/srfi-143/srfi-143.html) # Cyclone Libraries @@ -212,13 +211,14 @@ This section is an alphabetic listing of all the functions, objects, and macros [`append`](api/scheme/base#append) [`apply `](api/primitives#apply) [`arithmetic-shift`](api/srfi/60#ash) -[`array-list`](api/scheme/cyclone/array-list#array-list) -[`array-list?`](api/scheme/cyclone/array-list#array-list1) [`array-list-delete!`](api/scheme/cyclone/array-list#array-list-delete) -[`array-list-empty?`](api/scheme/cyclone/array-list#array-list-empty) +[`array-list-empty?`](api/scheme/cyclone/array-list#array-list-empty) +[`array-list-insert!`](api/scheme/cyclone/array-list#array-list-insert) [`array-list-length`](api/scheme/cyclone/array-list#array-list-length) [`array-list-ref`](api/scheme/cyclone/array-list#array-list-ref) [`array-list-set!`](api/scheme/cyclone/array-list#array-list-set) +[`array-list?`](api/scheme/cyclone/array-list#array-list1) +[`array-list`](api/scheme/cyclone/array-list#array-list) [`ash`](api/srfi/60#ash) [`asin`](api/scheme/inexact#asin) [`assoc`](api/scheme/base#assoc) @@ -554,6 +554,7 @@ This section is an alphabetic listing of all the functions, objects, and macros [`finite?`](api/scheme/inexact#finite) [`first-set-bit`](api/srfi/60#first-set-bit) [`first`](api/srfi/1#first) +[`fixnum?`](api/srfi/143#fixnum) [`flatten `](api/scheme/cyclone/util#flatten) [`floor-quotient`](api/scheme/base#floor-quotient) [`floor-remainder`](api/scheme/base#floor-remainder ) @@ -570,6 +571,46 @@ This section is an alphabetic listing of all the functions, objects, and macros [`formals->list `](api/scheme/cyclone/util#formals-list) [`fourth`](api/srfi/1#fourth) [`free-vars `](api/scheme/cyclone/transforms#free-vars) +[`fx*`](api/srfi/143#fx-6) +[`fx+`](api/srfi/143#fx-5) +[`fx-`](api/srfi/143#fx-) +[`fx-greatest`](api/srfi/143#fx-greatest) +[`fx-least`](api/srfi/143#fx-least) +[`fx-width`](api/srfi/143#fx-width) +[`fx<=?`](api/srfi/143#fx-3) +[`fx=?`](api/srfi/143#fx-4) +[`fx>?`](api/srfi/143#fx-2) +[`fxabs`](api/srfi/143#fxabs) +[`fxand`](api/srfi/143#fxand) +[`fxarithmetic-shift-left`](api/srfi/143#fxarithmetic-shift-left) +[`fxarithmetic-shift-right`](api/srfi/143#fxarithmetic-shift-right) +[`fxarithmetic-shift`](api/srfi/143#fxarithmetic-shift) +[`fxbit-count`](api/srfi/143#fxbit-count) +[`fxbit-field-reverse`](api/srfi/143#fxbit-field-reverse) +[`fxbit-field-rotate`](api/srfi/143#fxbit-field-rotate) +[`fxbit-field`](api/srfi/143#fxbit-field) +[`fxbit-set?`](api/srfi/143#fxbit-set) +[`fxcopy-bit`](api/srfi/143#fxcopy-bit) +[`fxeven?`](api/srfi/143#fxeven) +[`fxfirst-set-bit`](api/srfi/143#fxfirst-set-bit) +[`fxif`](api/srfi/143#fxif) +[`fxior`](api/srfi/143#fxior) +[`fxlength`](api/srfi/143#fxlength) +[`fxmax`](api/srfi/143#fxmax) +[`fxmin`](api/srfi/143#fxmin) +[`fxneg`](api/srfi/143#fxneg) +[`fxnegative?`](api/srfi/143#fxnegative) +[`fxnot`](api/srfi/143#fxnot) +[`fxodd?`](api/srfi/143#fxodd) +[`fxpositive?`](api/srfi/143#fxpositive) +[`fxquotient`](api/srfi/143#fxquotient) +[`fxremainder`](api/srfi/143#fxremainder) +[`fxsqrt`](api/srfi/143#fxsqrt) +[`fxsquare`](api/srfi/143#fxsquare) +[`fxxor`](api/srfi/143#fxxor) +[`fxzero?`](api/srfi/143#fxzero) - - - [`gappend`](api/srfi/121#gappend) @@ -1210,6 +1251,7 @@ This section is an alphabetic listing of all the functions, objects, and macros [`warning`](api/scheme/cyclone/test#warning) [`when`](api/scheme/base#when) [`with-exception-handler`](api/scheme/base#with-exception-handler) +[`with-handler`](api/scheme/base#with-handler) [`with-input-from-file`](api/scheme/file#with-input-from-file) [`with-output-to-file`](api/scheme/file#with-output-to-file) [`wrap-mutables `](api/scheme/cyclone/transforms#wrap-mutables) diff --git a/docs/api/srfi/143.md b/docs/api/srfi/143.md index 506596ab..0f52b6a1 100644 --- a/docs/api/srfi/143.md +++ b/docs/api/srfi/143.md @@ -90,73 +90,218 @@ Semantically equivalent to `=`. # fx? + (fx>? i j) + +Semantically equivalent to `>`. + # fx<=? + (fx<=? i j) + +Semantically equivalent to `<=`. + # fx>=? + (fx>=? i j) + +Semantically equivalent to `>=`. + # fxzero? + (fxzero? i) + +Semantically equivalent to `zero?`. + # fxpositive? + (fxpostiive? i) + +Semantically equivalent to `positive?`. + # fxnegative? + (fxnegative? i) + +Semantically equivalent to `negative?`. + # fxodd? + (fxodd? i) + +Semantically equivalent to `odd?`. + # fxeven? + (fxeven? i) + +Semantically equivalent to `even?`. + # fxmax + (fxmax i j) + +Semantically equivalent to `max`. + # fxmin + (fxmin i j) + +Semantically equivalent to `min`. + # fx+ + (fx+ i j) + +Semantically equivalent to `+`, but accepts exactly two arguments. + # fx- + (fx- i j) + +Semantically equivalent to `-`, but accepts exactly two arguments. + # fx* + (fx* i j) + +Semantically equivalent to `*`, but accepts exactly two arguments. + # fxneg + (fxneg i) + +Semantically equivalent to `-`, but accepts exactly one argument. + # fxquotient + (fxquotient i j) + +Semantically equivalent to `quotient`. + # fxremainder + (fxremainder i j) + +Semantically equivalent to `remainder`. + # fxabs + (fxabs i) + +Semantically equivalent to `abs`. + # fxsquare + (fxsquare i) + +Semantically equivalent to `square`. + # fxsqrt + (fxsqrt i) + +Semantically equivalent to `sqrt`. + # fxnot + (fxnot i) + +Semantically equivalent to `bitwise-not`. + # fxand + (fxand i j) + +Semantically equivalent to `bitwise-and`. + # fxior + (fxior i j) + +Semantically equivalent to `bitwise-ior`. + # fxxor + (fxxor i j) + +Semantically equivalent to `bitwise-xor`. + # 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 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 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 i) + +Semantically equivalent to SRFI 151 `bit-count`. + # fxlength + (fxlength i) + +Semantically equivalent to `integer-length`. + # fxif + (fxif mask i j) + +Semantically equivalent to `bitwise-if`. + + # 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 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 i) + +Semantically equivalent to `first-set-bit`. + # fxbit-field + (fxbit-field i start end) + +Semantically equivalent to `bit-field`. + # fxbit-field-rotate + (fxbit-field-rotate i count start end) + +Semantically equivalent to SRFI 151 `bit-field-rotate`. + # fxbit-field-reverse + (fxbit-field-reverse i start end) + +Semantically equivalent to `bit-field-reverse`. +