From a27f3422083fafc3b6cb7016ea3fcda1a4ee5ed4 Mon Sep 17 00:00:00 2001 From: Justin Ethier Date: Wed, 12 Oct 2016 17:42:53 -0400 Subject: [PATCH] Added SRFI 128 --- docs/API.md | 1 + docs/api/srfi/128.md | 117 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 118 insertions(+) create mode 100644 docs/api/srfi/128.md diff --git a/docs/API.md b/docs/API.md index 7fcd0dd7..fb7696f5 100644 --- a/docs/API.md +++ b/docs/API.md @@ -45,6 +45,7 @@ Cyclone supports the following [Scheme Requests for Implementation (SRFI)](http: - [`srfi 106`](api/srfi/106) - [Basic socket interface](http://srfi.schemers.org/srfi-106/srfi-106.html) - [`srfi 111`](api/srfi/111) - [Boxes](http://srfi.schemers.org/srfi-111/srfi-111.html) - [`srfi 117`](api/srfi/117) - [Mutable queues](http://srfi.schemers.org/srfi-117/srfi-117.html) +- [`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) diff --git a/docs/api/srfi/128.md b/docs/api/srfi/128.md new file mode 100644 index 00000000..1bedcce9 --- /dev/null +++ b/docs/api/srfi/128.md @@ -0,0 +1,117 @@ +--- +layout: main +title: API +--- + +# SRFI 128 - Comparators + +The `(srfi 128)` provides comparators, which bundle a type test predicate, an equality predicate, an ordering predicate, and a hash function into a single Scheme object. By packaging these procedures together, they can be treated as a single item for use in the implementation of data structures. + +See the [SRFI document](http://srfi.schemers.org/srfi-128/srfi-128.html) for more information. + +- [`comparator? `](#comparator) +- [`comparator-ordered? `](#comparator-ordered) +- [`comparator-hashable? `](#comparator-hashable) +- [`make-comparator `](#make-comparator) +- [`make-pair-comparator `](#make-pair-comparator) +- [`make-list-comparator `](#make-list-comparator) +- [`make-vector-comparator `](#make-vector-comparator) +- [`make-eq-comparator `](#make-eq-comparator) +- [`make-eqv-comparator `](#make-eqv-comparator) +- [`make-equal-comparator `](#make-equal-comparator) +- [`boolean-hash `](#boolean-hash) +- [`char-hash `](#char-hash) +- [`char-ci-hash `](#char-ci-hash) +- [`string-hash `](#string-hash) +- [`string-ci-hash `](#string-ci-hash) +- [`symbol-hash `](#symbol-hash) +- [`number-hash `](#number-hash) +- [`make-default-comparator `](#make-default-comparator) +- [`default-hash `](#default-hash) +- [`comparator-register-default! `](#comparator-register-default) +- [`comparator-type-test-predicate`](#comparator-type-test-predicate) +- [`comparator-equality-predicate `](#comparator-equality-predicate) +- [`comparator-ordering-predicate `](#comparator-ordering-predicate) +- [`comparator-hash-function `](#comparator-hash-function) +- [`comparator-test-type `](#comparator-test-type) +- [`comparator-check-type `](#comparator-check-type) +- [`comparator-hash `](#comparator-hash) +- [`hash-bound `](#hash-bound) +- [`hash-salt `](#hash-salt) +- [`=? `](#) +- [`? `](#-2) +- [`<=? `](#-3) +- [`>=? `](#-4) +- [`comparator-if<=> `](#comparator-if) + +#comparator? + +#comparator-ordered? + +#comparator-hashable? + +#make-comparator + +#make-pair-comparator + +#make-list-comparator + +#make-vector-comparator + +#make-eq-comparator + +#make-eqv-comparator + +#make-equal-comparator + +#boolean-hash + +#char-hash + +#char-ci-hash + +#string-hash + +#string-ci-hash + +#symbol-hash + +#number-hash + +#make-default-comparator + +#default-hash + +#comparator-register-default! + +#comparator-type-test-predicate + +#comparator-equality-predicate + +#comparator-ordering-predicate + +#comparator-hash-function + +#comparator-test-type + +#comparator-check-type + +#comparator-hash + +#hash-bound + +#hash-salt + +#=? + +#? + +#<=? + +#>=? + +#comparator-if<=> +