explain what a box is in the reference, and add cross references to the guide

svn: r10753
This commit is contained in:
Matthew Flatt 2008-07-14 00:05:37 +00:00
parent 7af044e2ce
commit 71a2648851
5 changed files with 12 additions and 1 deletions

View File

@ -3,7 +3,7 @@
scribble/eval scribble/eval
"guide-utils.ss") "guide-utils.ss")
@title{Pairs and Lists} @title[#:tag "pairs"]{Pairs and Lists}
A @deftech{pair} joins two arbitrary values. The @scheme[cons] A @deftech{pair} joins two arbitrary values. The @scheme[cons]
procedure constructs pairs, and the @scheme[car] and @scheme[cdr] procedure constructs pairs, and the @scheme[car] and @scheme[cdr]

View File

@ -133,6 +133,11 @@ for each pair of keywords is the same as using
@; ------------------------------------------------------------ @; ------------------------------------------------------------
@section[#:tag "boxes"]{Boxes} @section[#:tag "boxes"]{Boxes}
@guideintro["boxes"]{boxes}
A @deftech{box} is like a single-element vector, normally used as
minimal mutable storage.
@defproc[(box? [v any/c]) boolean?]{ @defproc[(box? [v any/c]) boolean?]{
Returns @scheme[#t] if @scheme[v] is a box, @scheme[#f] otherwise.} Returns @scheme[#t] if @scheme[v] is a box, @scheme[#f] otherwise.}

View File

@ -3,6 +3,8 @@
@title[#:tag "hashtables"]{Hash Tables} @title[#:tag "hashtables"]{Hash Tables}
@guideintro["hash-tables"]{hash tables}
A @deftech{hash table} (or simply @deftech{hash}) maps each of its A @deftech{hash table} (or simply @deftech{hash}) maps each of its
keys to a single value. For a given hash table, keys are equivalent keys to a single value. For a given hash table, keys are equivalent
via @scheme[equal?] or @scheme[eq?], and keys are retained either via @scheme[equal?] or @scheme[eq?], and keys are retained either

View File

@ -44,6 +44,8 @@
@title[#:tag "pairs"]{Pairs and Lists} @title[#:tag "pairs"]{Pairs and Lists}
@guideintro["pairs"]{pairs and lists}
@local-table-of-contents[] @local-table-of-contents[]
A @deftech{pair} combines exactly two values. The first value is A @deftech{pair} combines exactly two values. The first value is

View File

@ -3,6 +3,8 @@
@title[#:tag "vectors"]{Vectors} @title[#:tag "vectors"]{Vectors}
@guideintro["vectors"]{vectors}
A @deftech{vector} is a fixed-length array with constant-time access A @deftech{vector} is a fixed-length array with constant-time access
and update of the vector slots, which are numbered from @scheme[0] to and update of the vector slots, which are numbered from @scheme[0] to
one less than the number of slots in the vector. one less than the number of slots in the vector.