suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add some cross-references to sequence defns

Browse Source 
svn: r16280
This commit is contained in:
Matthew Flatt 2009-10-08 12:25:24 +00:00
parent 75dc35602c
commit d39cbf9c57
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
collects/scribblings/reference/sequences.scrbl
View File

@ -17,6 +17,9 @@
(the-eval '(require scheme/generator)) (the-eval '(require scheme/generator))
the-eval))) the-eval)))
@(define (info-on-seq where what)
@margin-note{See @secref[where] for information on using @|what| as sequences.})
@title[#:tag "sequences"]{Sequences} @title[#:tag "sequences"]{Sequences}
@guideintro["sequences"]{sequences} @guideintro["sequences"]{sequences}
@ -85,6 +88,7 @@ element. @speed[in-naturals "integer"]}
@defproc[(in-list [lst list?]) sequence?]{ @defproc[(in-list [lst list?]) sequence?]{
Returns a sequence equivalent to @scheme[lst]. Returns a sequence equivalent to @scheme[lst].
@info-on-seq["pairs" "lists"]
@speed[in-list "list"]} @speed[in-list "list"]}
@defproc[(in-vector [vec vector?] @defproc[(in-vector [vec vector?]
@ -96,6 +100,8 @@ Returns a sequence equivalent to @scheme[lst].
Returns a sequence equivalent to @scheme[vec] when no optional Returns a sequence equivalent to @scheme[vec] when no optional
arguments are supplied. arguments are supplied.
@info-on-seq["vectors" "vectors"]
The optional arguments @scheme[start], @scheme[stop], and The optional arguments @scheme[start], @scheme[stop], and
@scheme[step] are analogous to @scheme[in-range], except that a @scheme[step] are analogous to @scheme[in-range], except that a
@scheme[#f] value for @scheme[stop] is equivalent to @scheme[#f] value for @scheme[stop] is equivalent to
@ -124,6 +130,8 @@ demanded from the sequence.
Returns a sequence equivalent to @scheme[str] when no optional Returns a sequence equivalent to @scheme[str] when no optional
arguments are supplied. arguments are supplied.
@info-on-seq["strings" "strings"]
The optional arguments @scheme[start], @scheme[stop], and The optional arguments @scheme[start], @scheme[stop], and
@scheme[step] are as in @scheme[in-vector]. @scheme[step] are as in @scheme[in-vector].
@ -137,6 +145,8 @@ The optional arguments @scheme[start], @scheme[stop], and
Returns a sequence equivalent to @scheme[bstr] when no optional Returns a sequence equivalent to @scheme[bstr] when no optional
arguments are supplied. arguments are supplied.
@info-on-seq["bytestrings" "byte strings"]
The optional arguments @scheme[start], @scheme[stop], and The optional arguments @scheme[start], @scheme[stop], and
@scheme[step] are as in @scheme[in-vector]. @scheme[step] are as in @scheme[in-vector].
@ -159,7 +169,9 @@ mode is @scheme['any], whereas the default mode of @scheme[read-line]
is @scheme['linefeed].} is @scheme['linefeed].}
@defproc[(in-hash [hash hash?]) sequence?]{ @defproc[(in-hash [hash hash?]) sequence?]{
Returns a sequence equivalent to @scheme[hash].} Returns a sequence equivalent to @scheme[hash].
@info-on-seq["hashtables" "hash tables"]}
@defproc[(in-hash-keys [hash hash?]) sequence?]{ @defproc[(in-hash-keys [hash hash?]) sequence?]{
Returns a sequence whose elements are the keys of @scheme[hash].} Returns a sequence whose elements are the keys of @scheme[hash].}