You can edit this page using wiki syntax for markup.

Article contents:== Outdated egg! This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for [[/eggref/5/tuples|the CHICKEN 5 version of this egg]], if it exists. If it does not exist, there may be equivalent functionality provided by another egg; have a look at the [[https://wiki.call-cc.org/chicken-projects/egg-index-5.html|egg index]]. Otherwise, please consider porting this egg to the current version of CHICKEN. [[tags: egg]] [[toc:]] == tuples Tuples are a datatype which has much in common with vectors. Namely they store a finite number of items with random access and make them available via (tuple-ref tup n). But contrary to vectors, the items can only by accessed but not assigned to. If you want to change a particular item, you must package it into a box or a single, which is a special tuple storing exactly one item, which can be changed via single-set! without changing the identity of the single object itself. singles are the only tuples, which can assign to their content. Other special tuples are couples and triples. They are all packaged in their own modules, and all of them use another module, %tuples, which contains the basic implementations without any checks. The unchecked routines are all prefixed with a %. Note, that couples can be used instead of pairs to implement immutable lists. == Documentation In this implementation tuples and their relatives (except %tuples) are implemented in the Design by Contract style, i.e. using the dbc egg. A corollary of this is, that the documentation is included in each of these modules in form of a procedure with the module's name. Called without any argument, the list of exported symbols is shown, with such a symbol as argument, the symbol's documentation is shown, and with a string argument, some wiki-like documentation is printed to a file, which you can inspect below. === module tuples ==== list->tuple <procedure>(list->tuple lst)</procedure> function (result) <enscript highlight=scheme> (list->tuple lst) requires (list? lst) ensures (and (%tuple? result) (= (length lst) (%tuple-length result))) </enscript> ==== tuple <procedure>(tuple . args)</procedure> function (result) <enscript highlight=scheme> (tuple . args) requires #t ensures (%tuple? result) </enscript> ==== tuple->list <procedure>(tuple->list tup)</procedure> function (result) <enscript highlight=scheme> (tuple->list tup) requires (%tuple? tup) ensures (list? result) </enscript> ==== tuple->vector <procedure>(tuple->vector tup)</procedure> function (result) <enscript highlight=scheme> (tuple->vector tup) requires (%tuple? tup) ensures (vector? result) </enscript> ==== tuple-append <procedure>(tuple-append . tups)</procedure> function (result) <enscript highlight=scheme> (tuple-append . tups) requires ((list-of? %tuple?) tups) ensures (and (%tuple? result) (= (tuple-length result) (apply + (map tuple-length tups)))) </enscript> ==== tuple-butleft <procedure>(tuple-butleft tup)</procedure> function (result) <enscript highlight=scheme> (tuple-butleft tup) requires (and (%tuple? tup) (positive? (%tuple-length tup))) ensures (and (%tuple result) (= (%tuple-length result) (- (%tuple-length tup) 1))) </enscript> ==== tuple-butright <procedure>(tuple-butright tup)</procedure> function (result) <enscript highlight=scheme> (tuple-butright tup) requires (and (%tuple? tup) (positive? (%tuple-length tup))) ensures (and (%tuple result) (= (%tuple-length result) (- (%tuple-length tup) 1))) </enscript> ==== tuple-cons-left <procedure>(tuple-cons-left arg tup)</procedure> function (result) <enscript highlight=scheme> (tuple-cons-left arg tup) requires (%tuple? tup) ensures (and (%tuple result) (= (%tuple-length result) (+ (%tuple-length tup) 1))) </enscript> ==== tuple-cons-right <procedure>(tuple-cons-right arg tup)</procedure> function (result) <enscript highlight=scheme> (tuple-cons-right arg tup) requires (%tuple? tup) ensures (and (%tuple result) (= (%tuple-length result) (+ (%tuple-length tup) 1))) </enscript> ==== tuple-copy <procedure>(tuple-copy tup)</procedure> function (result) <enscript highlight=scheme> (tuple-copy tup) requires (%tuple tup) ensures (%tuple result) </enscript> ==== tuple-empty? <procedure>(tuple-empty? xpr)</procedure> function (result) <enscript highlight=scheme> (tuple-empty? xpr) requires #t ensures (boolean? result) </enscript> ==== tuple-eq? <procedure>(tuple-eq? tup0 tup1)</procedure> function (result) <enscript highlight=scheme> (tuple-eq? tup0 tup1) requires (and (%tuple? tup0) (%tuple? tup1)) ensures (boolean? result) </enscript> ==== tuple-eql? <procedure>(tuple-eql? eql? tup0 tup1)</procedure> function (result) <enscript highlight=scheme> (tuple-eql? eql? tup0 tup1) requires (and (procedure? eql?) (%tuple? tup0) (%tuple? tup1)) ensures (boolean? result) </enscript> ==== tuple-equal? <procedure>(tuple-equal? tup0 tup1)</procedure> function (result) <enscript highlight=scheme> (tuple-equal? tup0 tup1) requires (and (%tuple? tup0) (%tuple? tup1)) ensures (boolean? result) </enscript> ==== tuple-eqv? <procedure>(tuple-eqv? tup0 tup1)</procedure> function (result) <enscript highlight=scheme> (tuple-eqv? tup0 tup1) requires (and (%tuple? tup0) (%tuple? tup1)) ensures (boolean? result) </enscript> ==== tuple-find <procedure>(tuple-find ok? tup)</procedure> function (result) <enscript highlight=scheme> (tuple-find ok? tup) requires (and (procedure? ok?) (%tuple? tup)) ensures (or (not result) (and (cardinal? result) (< result (%tuple-length tup)) "index of found item")) </enscript> ==== tuple-for-each <procedure>(tuple-for-each proc tup . tups)</procedure> command ((old new (lambda (proc tup . tups) #t))) <enscript highlight=scheme> (tuple-for-each proc tup . tups) requires (and (procedure? proc) (%tuple tup) ((list-of? %tuple?) tups) (apply = (%tuple-length tup) (map %tuple-length tups))) ensures "proc applied to each item" </enscript> ==== tuple-from-upto <procedure>(tuple-from-upto tup . interval)</procedure> function (result) <enscript highlight=scheme> (tuple-from-upto tup . interval) requires (and (%tuple tup) ((list-of? (lambda (x) (and (cardinal? x) (<= x (%tuple-length tup))))) interval) (<= (length interval) 2) (apply <= 0 interval)) ensures (and (%tuple? result) (= (%tuple-length result) (case (length interval) ((0) (%tuple-length tup)) ((1) (- (%tuple-length tup) (car interval))) ((2) (- (cadr interval) (car interval)))))) </enscript> ==== tuple-head <procedure>(tuple-head tup n)</procedure> function (result) <enscript highlight=scheme> (tuple-head tup n) requires (and (%tuple? tup) (<= n (%tuple-length tup))) ensures (and (%tuple result) (= (%tuple-length result) n)) </enscript> ==== tuple-left <procedure>(tuple-left tup)</procedure> function (result) <enscript highlight=scheme> (tuple-left tup) requires (and (%tuple? tup) (positive? (%tuple-length tup))) ensures "tup's leftmost item" </enscript> ==== tuple-length <procedure>(tuple-length tup)</procedure> function (result) <enscript highlight=scheme> (tuple-length tup) requires (%tuple? tup) ensures (cardinal? result) </enscript> ==== tuple-map <procedure>(tuple-map fn tup . tups)</procedure> function (result) <enscript highlight=scheme> (tuple-map fn tup . tups) requires (and (procedure? fn) (%tuple? tup) ((list-of? %tuple?) tups) (apply = (%tuple-length tup) (map %tuple-length tups))) ensures (and (%tuple? result) (= (%tuple-length tup) (%tuple-length result))) </enscript> ==== tuple-of? <procedure>(tuple-of? ok?)</procedure> function (result) <enscript highlight=scheme> (tuple-of? ok?) requires (procedure? ok?) ensures (procedure? result) </enscript> ==== tuple-ref <procedure>(tuple-ref tup n)</procedure> function (result) <enscript highlight=scheme> (tuple-ref tup n) requires (and (%tuple? tup) (cardinal? n) (< -1 n (%tuple-length tup))) ensures "tup's nth item" </enscript> ==== tuple-reverse <procedure>(tuple-reverse tup)</procedure> function (result) <enscript highlight=scheme> (tuple-reverse tup) requires (%tuple? tup) ensures (and (%tuple result) (= (%tuple-length result) (%tuple-length tup))) </enscript> ==== tuple-right <procedure>(tuple-right tup)</procedure> function (result) <enscript highlight=scheme> (tuple-right tup) requires (and (%tuple? tup) (positive? (%tuple-length tup))) ensures "tup's rightmost item" </enscript> ==== tuple-split <procedure>(tuple-split tup at)</procedure> function (head tail) <enscript highlight=scheme> (tuple-split tup at) requires (and (%tuple? tup) (cardinal? at) (< at (%tuple-length tup))) ensures (and (%tuple? head) (%tuple? tail) (%tuple-eql? equal? tup (%tuple-append head tail))))) </enscript> ==== tuple-tail <procedure>(tuple-tail tup n)</procedure> function (result) <enscript highlight=scheme> (tuple-tail tup n) requires (and (%tuple? tup) (<= n (%tuple-length tup))) ensures (and (%tuple result) (= (%tuple-length result) (- (%tuple-length tup) n))) </enscript> ==== tuple? <procedure>(tuple? xpr)</procedure> function (result) <enscript highlight=scheme> (tuple? xpr) requires #t ensures (boolean? result) </enscript> ==== vector->tuple <procedure>(vector->tuple vec)</procedure> function (result) <enscript highlight=scheme> (vector->tuple vec) requires (vector? vec) ensures (and (%tuple? result) (= (%tuple-length result) (vector-length vec))) </enscript> === Module triples ==== triple <procedure>(triple x y z)</procedure> function (result) <enscript highlight=scheme> (triple x y z) requires #t ensures (%triple? result) </enscript> ==== triple->tuple <procedure>(triple->tuple trp)</procedure> function (result) <enscript highlight=scheme> (triple->tuple trp) requires (%triple? trp) ensures (and (%tuple? result) (= (%tuple-length result) 3)) </enscript> ==== triple-eq? <procedure>(triple-eq? trp0 trp1)</procedure> function (result) <enscript highlight=scheme> (triple-eq? trp0 trp1) requires (and (%triple? trp0) (%triple? trp1)) ensures (boolean? result) </enscript> ==== triple-eql? <procedure>(triple-eql? eql? trp0 trp1)</procedure> function (result) <enscript highlight=scheme> (triple-eql? eql? trp0 trp1) requires (and (procedure? eql?) (%triple? trp0) (%triple? trp1)) ensures (boolean? result) </enscript> ==== triple-equal? <procedure>(triple-equal? trp0 trp1)</procedure> function (result) <enscript highlight=scheme> (triple-equal? trp0 trp1) requires (and (%triple? trp0) (%triple? trp1)) ensures (boolean? result) </enscript> ==== triple-eqv? <procedure>(triple-eqv? trp0 trp1)</procedure> function (result) <enscript highlight=scheme> (triple-eqv? trp0 trp1) requires (and (%triple? trp0) (%triple? trp1)) ensures (boolean? result) </enscript> ==== triple-left <procedure>(triple-left trp)</procedure> function (result) <enscript highlight=scheme> (triple-left trp) requires (%triple? trp) ensures "leftmost item" </enscript> ==== triple-middle <procedure>(triple-middle trp)</procedure> function (result) <enscript highlight=scheme> (triple-middle trp) requires (%triple? trp) ensures "item in the middle" </enscript> ==== triple-right <procedure>(triple-right trp)</procedure> function (result) <enscript highlight=scheme> (triple-right trp) requires (%triple? trp) ensures "rightmost item" </enscript> ==== triple? <procedure>(triple? x)</procedure> function (result) <enscript highlight=scheme> (triple? x) requires #t ensures (boolean? result) </enscript> === Module couples ==== couple <procedure>(couple x y)</procedure> function (result) <enscript highlight=scheme> (couple x y) requires #t ensures (%couple? result) </enscript> ==== couple->tuple <procedure>(couple->tuple cpl)</procedure> function (result) <enscript highlight=scheme> (couple->tuple cpl) requires (%couple? cpl) ensures (and (%tuple? result) (= (%tuple-length result) 2)) </enscript> ==== couple-eq? <procedure>(couple-eq? cpl0 cpl1)</procedure> function (result) <enscript highlight=scheme> (couple-eq? cpl0 cpl1) requires (and (%couple? cpl0) (%couple? cpl1)) ensures (boolean? result) </enscript> ==== couple-eql? <procedure>(couple-eql? eql? cpl0 cpl1)</procedure> function (result) <enscript highlight=scheme> (couple-eql? eql? cpl0 cpl1) requires (and (procedure? eql?) (%couple? cpl0) (%couple? cpl1)) ensures (boolean? result) </enscript> ==== couple-equal? <procedure>(couple-equal? cpl0 cpl1)</procedure> function (result) <enscript highlight=scheme> (couple-equal? cpl0 cpl1) requires (and (%couple? cpl0) (%couple? cpl1)) ensures (boolean? result) </enscript> ==== couple-eqv? <procedure>(couple-eqv? cpl0 cpl1)</procedure> function (result) <enscript highlight=scheme> (couple-eqv? cpl0 cpl1) requires (and (%couple? cpl0) (%couple? cpl1)) ensures (boolean? result) </enscript> ==== couple-left <procedure>(couple-left cpl)</procedure> function (result) <enscript highlight=scheme> (couple-left cpl) requires (%couple? cpl) ensures "leftmost item" </enscript> ==== couple-right <procedure>(couple-right cpl)</procedure> function (result) <enscript highlight=scheme> (couple-right cpl) requires (%couple? cpl) ensures "rightmost item" </enscript> ==== couple? <procedure>(couple? x)</procedure> function (result) <enscript highlight=scheme> (couple? x) requires #t ensures (boolean? result) </enscript> === Module singles ==== single <procedure>(single x)</procedure> function (result) <enscript highlight=scheme> (single x) requires #t ensures (%single? result) </enscript> ==== single-eq? <procedure>(single-eq? sgl0 sgl1)</procedure> function (result) <enscript highlight=scheme> (single-eq? sgl0 sgl1) requires (and (%single? sgl0) (%single? sgl1)) ensures (boolean? result) </enscript> ==== single-eql? <procedure>(single-eql? eql? sgl0 sgl1)</procedure> function (result) <enscript highlight=scheme> (single-eql? eql? sgl0 sgl1) requires (and (procedure? eql?) (%single? sgl0) (%single? sgl1)) ensures (boolean? result) </enscript> ==== single-equal? <procedure>(single-equal? sgl0 sgl1)</procedure> function (result) <enscript highlight=scheme> (single-equal? sgl0 sgl1) requires (and (%single? sgl0) (%single? sgl1)) ensures (boolean? result) </enscript> ==== single-eqv? <procedure>(single-eqv? sgl0 sgl1)</procedure> function (result) <enscript highlight=scheme> (single-eqv? sgl0 sgl1) requires (and (%single? sgl0) (%single? sgl1)) ensures (boolean? result) </enscript> ==== single-ref <procedure>(single-ref sg)</procedure> function (result) <enscript highlight=scheme> (single-ref sg) requires (%single? sg) ensures "sg's stored item" </enscript> ==== single-set! <procedure>(single-set! sg x)</procedure> command ((old new (lambda (sg x) (%single-ref sg)))) <enscript highlight=scheme> (single-set! sg x) requires (%single? sg) ensures (equal? new x) </enscript> ==== single? <procedure>(single? x)</procedure> function (result) <enscript highlight=scheme> (single? x) requires #t ensures (boolean? result) </enscript> == Requirements [[dbc]] == Last update Feb 11, 2014 == Author [[/users/juergen-lorenz|Juergen Lorenz]] == License Copyright (c) 2012-2014, Juergen Lorenz All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. == Version History ; 1.2 : tests with define-test instead of simple-test ; 1.1 : implementation-module renamed, tests with simple-tests, tuple-split added ; 1.0 : dependency on contracts changed to dbc, modules further split, addition routines ; 0.8 : code split into two modules ; 0.7 : single-state and single-state! renamed to single-ref and single-set! ; 0.6 : contracts rewritten ; 0.5 : code maintenance ; 0.4 : added copyright notice ; 0.3 : updated for using contracts 1.0 ; 0.2 : added tuple-copy, tuple-left, tuple-right ; 0.1 : initial import Description of your changes:

I would like to authenticate

Spam control

What do you get when you add 16 to 13?