summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg J. Badros <gjb@cs.washington.edu>2000-03-01 20:21:24 +0000
committerGreg J. Badros <gjb@cs.washington.edu>2000-03-01 20:21:24 +0000
commited11b876c899dc2e0ac7702394ee16ef221e014e (patch)
tree28dfac6c6075d0d0266852b093b479fba31f1e9a
parentaf94609f1f652f25791701261a6ade55a2f134a4 (diff)
downloadguile-ed11b876c899dc2e0ac7702394ee16ef221e014e.tar.gz
* streams.scm: Doc patch from Richard Kim, using MIT Scheme as
source of the numerous very short changes.
-rw-r--r--ice-9/streams.scm12
1 files changed, 12 insertions, 0 deletions
diff --git a/ice-9/streams.scm b/ice-9/streams.scm
index bcca3ae15..d9fb763a1 100644
--- a/ice-9/streams.scm
+++ b/ice-9/streams.scm
@@ -94,15 +94,22 @@
'()))))
(define (stream-car stream)
+ "Returns the first element in STREAM. This is equivalent to `car'."
(car (force stream)))
(define (stream-cdr stream)
+ "Returns the first tail of STREAM. Equivalent to `(force (cdr STREAM))'."
(cdr (force stream)))
(define (stream-null? stream)
+ "Returns `#t' if STREAM is the end-of-stream marker; otherwise
+returns `#f'. This is equivalent to `null?', but should be used
+whenever testing for the end of a stream."
(null? (force stream)))
(define (list->stream l)
+ "Returns a newly allocated stream whose elements are the elements of
+LIST. Equivalent to `(apply stream LIST)'."
(make-stream
(lambda (l) l)
l))
@@ -132,6 +139,8 @@
(lambda (l len) (values (reverse! l) len))))
(define (stream->list stream)
+ "Returns a newly allocated list whose elements are the elements of STREAM.
+If STREAM has infinite length this procedure will not terminate."
(reverse! (stream->reversed-list stream)))
(define (stream->vector stream)
@@ -169,6 +178,9 @@
stream rest))
(define (stream-map f stream . rest)
+ "Returns a newly allocated stream, each element being the result of
+invoking F with the corresponding elements of the STREAMs
+as its arguments."
(if (null? rest) ;fast path
(make-stream (lambda (s)
(or (stream-null? s)