7 Streams
(require (planet krhari/pfds:1:3/stream)) |
Streams are nothing but lazy lists. They are similar to ordinary lists and they provide the same functionality as that of lists. The difference between Streams and lists is that they are lazy in nature and each cell of a Stream is suspended and is forced only when required. Streams have been used in some of the below mentioned data structures. Since each suspention comes with a little overhead, Streams should be used only when there is a good enough reason to do so.
(Stream A) |
Example: |
> (stream 1 2 3 4 5 6) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
In the above example, the stream obtained will be similar to lists but will lazy in nature. It will have 1 as its first element.
empty-stream : (Stream Nothing) |
(empty-stream? strm) → Boolean |
strm : (Stream A) |
Examples: |
> (empty-stream? (stream 1 2 3 4 5 6)) |
- : Boolean |
#f |
> (empty-stream? empty-stream) |
- : Boolean |
#t |
(stream-cons a strm) → (Stream A) |
a : A |
strm : (Stream A) |
Example: |
> (stream-cons 10 (stream 1 2 3 4 5 6)) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
In the above example, (stream-cons 10 (stream 1 2 3 4 5 6)) returns the stream (stream 10 1 2 3 4 5 6).
(stream-car strm) → A |
strm : (Stream A) |
Examples: |
> (stream-car (stream 1 2 3 4 5 6)) |
- : Positive-Fixnum |
1 |
> (stream-car empty-stream) |
stream-car: given stream is empty |
(stream-cdr strm) → (Stream A) |
strm : (Stream A) |
Examples: |
> (stream-cdr (stream 1 2 3 4 5 6)) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
> (stream-cdr empty-stream) |
stream-cdr: given stream is empty |
In the above example, (stream-cdr strm) returns (stream 2 3 4 5 6).
(stream-append strm1 strm2) → (Stream A) |
strm1 : (Stream A) |
strm2 : (Stream A) |
Examples: |
> (define strm1 (stream 1 2 3 4 5 6)) |
> (define strm2 (stream 51 32 42)) |
> (stream-append strm1 strm2) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
In the above example, (stream-append strm1 strm2) returns the stream, (stream 1 2 3 4 5 6 51 32 42).
(stream-reverse strm) → (Stream A) |
strm : (Stream A) |
Example: |
> (stream-reverse (stream 1 2 3 4 5 6)) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
In the above example, (stream-reverse (stream 1 2 3 4 5 6)) returns (stream 6 5 4 3 2 1).
(stream->list strm) → (Listof A) |
strm : (Stream A) |
Examples: |
> (stream->list (stream 1 2 3 4 5 6)) |
- : (Listof Positive-Fixnum) |
'(1 2 3 4 5 6) |
> (stream->list empty-stream) |
- : (Listof Nothing) |
'() |
Examples: |
> (drop 3 (stream 1 2 3 4 5 6)) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
> (drop 10 (stream 1 2 3 4 5 6)) |
drop: Not enough elements to drop |
In the above example, (drop 3 (stream 1 2 3 4 5 6)) returns (stream 4 5 6).
(take 5 (stream 1)) does not throw any error because of its lazy nature. take returns a suspension rather than finishing the whole computation.
Examples: |
> (take 3 (stream 1 2 3 4 5 6)) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
> (take 5 (stream 1)) |
- : #(struct:Promise ((U Mt (InStream Positive-Fixnum)))) |
#<promise> |
In the above example, (take 3 (stream 1 2 3 4 5 6)) returns (stream 1 2 3).