Lab 12: Macros, Streams
Due by 11:59pm on Wednesday, August 5.
Starter Files
Download lab12.zip. Inside the archive, you will find starter files for the questions in this lab, along with a copy of the Ok autograder.
Submission
By the end of this lab, you should have submitted the lab with
python3 ok --submit
. You may submit more than once before the
deadline; only the final submission will be graded.
Check that you have successfully submitted your code on
okpy.org.
Topics
Consult this section if you need a refresher on the material for this lab. It's okay to skip directly to the questions and refer back here should you get stuck.
So far we've been able to define our own procedures in Scheme using the
define
special form. When we call these procedures, we have to follow
the rules for evaluating call expressions, which involve evaluating all the
operands.
We know that special form expressions do not follow the evaluation rules of call expressions. Instead, each special form has its own rules of evaluation, which may include not evaluating all the operands. Wouldn't it be cool if we could define our own special forms where we decide which operands are evaluated? Consider the following example where we attempt to write a function that evaluates a given expression twice:
scm> (define (twice f) (begin f f))
twice
scm> (twice (print 'woof))
woof
Since twice
is a regular procedure, a call to twice
will
follow the same rules of evaluation as regular call expressions; first we
evaluate the operator and then we evaluate the operands. That means that
woof
was printed when we evaluated the operand (print 'woof)
.
Inside the body of twice
, the name f
is bound to the value
undefined
, so the expression (begin f f)
does nothing at all!
The problem here is clear: we need to prevent the given expression from
evaluating until we're inside the body of the procedure. This is where the
define-macro
special form, which has identical syntax to the regular
define
form, comes in:
scm> (define-macro (twice f) (list 'begin f f))
twice
define-macro
allows us to define what's known as a macro
,
which is simply a way for us to combine unevaluated input expressions together
into another expression. When we call macros, the operands are not evaluated,
but rather are treated as Scheme data. This means that any operands that are
call expressions or special form expression are treated like lists.
If we call (twice (print 'woof))
, f
will actually be bound to
the list (print 'woof)
instead of the value undefined
.
Inside the body of define-macro
, we can insert these expressions into
a larger Scheme expression. In our case, we would want a begin
expression that looks like the following:
(begin (print 'woof) (print 'woof))
As Scheme data, this expression is really just a list containing three
elements: begin
and (print 'woof)
twice, which is exactly
what (list 'begin f f)
returns. Now, when we call twice
,
this list is evaluated as an expression and (print 'woof)
is evaluated
twice.
scm> (twice (print 'woof))
woof
woof
To recap, macros are called similarly to regular procedures, but the rules for evaluating them are different. We evaluated lambda procedures in the following way:
- Evaluate operator
- Evaluate operands
- Apply operator to operands, evaluating the body of the procedure
However, the rules for evaluating calls to macro procedures are:
- Evaluate operator
- Apply operator to unevaluated operands
- Evaluate the expression returned by the macro in the frame it was called in.
Recall that the quote
special form prevents the Scheme interpreter
from executing a following expression. We saw that this helps us create complex
lists more easily than repeatedly calling cons
or trying to get the
structure right with list
. It seems like this form would come in handy
if we are trying to construct complex Scheme expressions with many nested
lists.
Consider that we rewrite the twice
macro as follows:
(define-macro (twice f)
'(begin f f))
This seems like it would have the same effect, but since the quote
form prevents any evaluation, the resulting expression we create would actually
be (begin f f)
, which is not what we want.
The quasiquote allows us to construct literal lists in a similar way as quote, but also lets us specify if any sub-expression within the list should be evaluated.
At first glance, the quasiquote (which can be invoked with the backtick `
or
the quasiquote
special form) behaves exactly the same as '
or
quote
. However, using quasiquotes gives you the ability to
unquote (which can be invoked with the comma ,
or the
unquote
special form). This removes an expression from the quoted
context, evaluates it, and places it back in.
By combining quasiquotes and unquoting, we can often save ourselves a lot of trouble when building macro expressions.
Here is how we could use quasiquoting to rewrite our previous example:
(define-macro (twice f)
`(begin ,f ,f))
Important Note: quasiquoting isn't necessarily related to macros, in fact it can be used in any situation where you want to build lists non-recursively and you know the structure ahead of time. For example, instead of writing
(list x y z)
you can write`(,x ,y ,z)
for 100% equivalent behavior
Because a stream is simply a lazy list, the rest of a stream is also a stream
(just like the rest of a list is also a list). In addition, nil
can also
serve as an empty stream. To check if a stream is empty, we can use the
built-in procedure null?
.
The procedures involved for working with streams are as follows:
(cons-stream first rest)
: A special form that constructs a stream by evaluating the first operandfirst
and storing its value as the first element in the stream, and storing the second operandrest
, unevaluated, to be evaluated later.(car s)
: A procedure that works on streams the same way it does on lists. It returns the first element of the stream, which had already been computed on construction of the stream.(cdr-stream s)
: A procedure that returns the rest of the stream by evaluating therest
expression that was stored on construction of the stream. It then stores the value of this expression so that on subsequent calls tocdr-stream
on this stream,rest
no longer has to be evaluated.
Now we are ready to look at a simple example. This stream is an infinite stream where each element is 1.
scm> (define ones (cons-stream 1 ones))
ones
scm> (car ones)
1
scm> (cdr-stream ones)
(1 . #[promise (forced)])
The reason we are able to recursively reference this object without causing an
error is because the second operand to cons-stream
is not evaluated. Instead,
it is stored until cdr-stream
is called, at which point the expression will
be evaluated and the resulting value will be stored.
Next, here's one way to build a stream of the natural numbers starting at n
.
scm> (define (naturals (n))
(cons-stream n (naturals (+ n 1))))
naturals
scm> (define nat (naturals 0))
nat
scm> (car nat)
0
scm> (car (cdr-stream nat))
1
scm> (car (cdr-stream (cdr-stream nat)))
2
Here, the expression that is stored is a recursive call to naturals
. When we
evaluate this call, we get another stream whose first element is one greater
than the previous number in the sequence. The second element of this stream is
uncomputed until cdr-stream
is called on it, which will activate yet another
call to naturals
. Hence, we effectively get an infinite stream of integers,
where each integer is computed one at a time. This is almost like infinite
recursion, but one which can be viewed one step at a time, so it does not
crash.
Required Questions
What Would Scheme Display?
Q1: WWSD: Macros
One thing to keep in mind when doing this question, builtins get rendered as such:
scm> +
#[+]
scm> list
#[list]
If evaluating an expression causes an error, type
SchemeError
. If nothing is displayed, typeNothing
.Use Ok to test your knowledge with the following "What Would Scheme Display?" questions:
python3 ok -q wwsd-macros -u
scm> +
______#[+]
scm> list
______#[list]
scm> (define-macro (f x) (car x))
______f
scm> (f (2 3 4)) ; type SchemeError for error, or Nothing for nothing
______2
scm> (f (+ 2 3))
______#[+]
scm> (define x 2000)
______x
scm> (f (x y z))
______2000
scm> (f (list 2 3 4))
______#[list]
scm> (f (quote (2 3 4)))
______SchemeError
scm> (define quote 7000)
______quote
scm> (f (quote (2 3 4)))
______7000
scm> (define-macro (g x) (+ x 2))
______g
scm> (g 2)
______4
scm> (g (+ 2 3))
______SchemeError
scm> (define-macro (h x) (list '+ x 2))
______h
scm> (h (+ 2 3))
______7
scm> (define-macro (if-else-5 condition consequent) `(if ,condition ,consequent 5))
______if-else-5
scm> (if-else-5 #t 2)
______2
scm> (if-else-5 #f 3)
______5
scm> (if-else-5 #t (/ 1 0))
______SchemeError
scm> (if-else-5 #f (/ 1 0))
______5
scm> (if-else-5 (= 1 1) 2)
______2
Q2: WWSD: Quasiquote
Use Ok to test your knowledge with the following "What Would Scheme Display?" questions:
python3 ok -q wwsd-quasiquote -u
scm> '(1 x 3)
______(1 x 3)
scm> (define x 2)
______x
scm> `(1 x 3)
______(1 x 3)
scm> `(1 ,x 3)
______(1 2 3)
scm> '(1 ,x 3)
______(1 (unquote x) 3)
scm> `(,1 x 3)
______(1 x 3)
scm> `,(+ 1 x 3)
______6
scm> `(1 (,x) 3)
______(1 (2) 3)
scm> `(1 ,(+ x 2) 3)
______(1 4 3)
scm> (define y 3)
______y
scm> `(x ,(* y x) y)
______(x 6 y)
scm> `(1 ,(cons x (list y 4)) 5)
______(1 (2 3 4) 5)
Macros
Q3: Scheme def
Implement def
, which simulates a python def
statement, allowing you to write code like
(def f(x y) (+ x y))
.
The above expression should create a function with parameters x
and y
, and
body (+ x y)
, then bind it to the name f
in the current frame.
Note: the previous is equivalent to
(def f (x y) (+ x y))
.Hint: We strongly suggest doing the WWPD questions on macros first as understanding the rules of macro evaluation is key in writing macros.
(define-macro (def func args body)
'YOUR-CODE-HERE)
Use Ok to test your code:
python3 ok -q scheme-def
Streams
Q4: Multiples of 3
Define implicitly an infinite stream all-three-multiples
that contains
all the multiples of 3, starting at 3. For example, the first 5 elements should be:
(3 6 9 12 15)
You may use the map-stream
function defined below. map-stream
takes in
a one-argument function f
and a stream s
and returns a new stream containing
the elements of s
with f
applied.
(define (map-stream f s)
(if (null? s)
nil
(cons-stream (f (car s)) (map-stream f (cdr-stream s)))))
Do not define any other helper functions.
(define (map-stream f s)
(if (null? s)
nil
(cons-stream (f (car s)) (map-stream f (cdr-stream s)))))
(define all-three-multiples
'YOUR-CODE-HERE
)
Use Ok to test your code:
python3 ok -q multiples_3
Submit
Make sure to submit this assignment by running:
python3 ok --submit
Optional Questions
Scheme Basics
Q5: Compose All
Implement compose-all
, which takes a list of one-argument functions and
returns a one-argument function that applies each function in that list in turn
to its argument. For example, if func
is the result of calling compose-all
on a list of functions (f g h)
, then (func x)
should be equivalent to the
result of calling (h (g (f x)))
.
scm> (define (square x) (* x x))
square
scm> (define (add-one x) (+ x 1))
add-one
scm> (define (double x) (* x 2))
double
scm> (define composed (compose-all (list double square add-one)))
composed
scm> (composed 1)
5
scm> (composed 2)
17
(define (compose-all funcs)
'YOUR-CODE-HERE
)
Use Ok to test your code:
python3 ok -q compose-all
Streams
Q6: Partial sums
Define a function partial-sums
, which takes in a stream with elements
a1, a2, a3, ...
and outputs the stream
a1, a1 + a2, a1 + a2 + a3, ...
If the input is a finite stream of length n, the output should be a finite stream of length n. If the input is an infinite stream, the output should also be an infinite stream.
(define (partial-sums stream)
'YOUR-CODE-HERE
(helper 0 stream)
)
Use Ok to test your code:
python3 ok -q partial-sums