0% found this document useful (0 votes)
37 views28 pages

01-Contracts c0

This document summarizes a lecture on contracts in imperative programming. It discusses using contracts like loop invariants and function pre/postconditions to prove that programs are correct and terminate properly. It walks through analyzing a mysterious function to determine it computes x to the power of y by finding the loop invariant is xy, which remains constant in each iteration. This helps prove the function returns the correct result xy when the loop terminates with y=1.

Uploaded by

rb
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
37 views28 pages

01-Contracts c0

This document summarizes a lecture on contracts in imperative programming. It discusses using contracts like loop invariants and function pre/postconditions to prove that programs are correct and terminate properly. It walks through analyzing a mysterious function to determine it computes x to the power of y by finding the loop invariant is xy, which remains constant in each iteration. This helps prove the function returns the correct result xy when the loop terminates with y=1.

Uploaded by

rb
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 28

Lecture 1

Contracts
15-122: Principles of Imperative Computation (Spring 2018)
Frank Pfenning

In these notes we review contracts, which we use to collectively denote


function contracts, loop invariants, and other assertions about a program.
Contracts will play a central role in this class, since they represent the key
to connect algorithmic ideas to imperative programs. We do this through
an example, developing annotations for a given program that express the
contracts, thereby making the program understandable (and allowing us to
find a bug).
In term of our learning goals, this lecture addresses:
Computational Thinking: Developing contracts (preconditions, postcon-
ditions, assertions, and loop invariants) that establish the safety and
correctness of imperative programs.
Developing proofs of the safety and correctness of code with con-
tracts.
Developing informal termination arguments for programs with loops
and recursion.
Identifying the difference between specification and implementation.
Algorithms and Data Structures: Integer algorithms (fast power).
Programming: Identifying, describing, and effectively using while-loops
and contracts (in C0).
We invite you to read this section by section to see how much of the
story you can figure out on your own before moving on to the next section.

1 A Mysterious Program
You are a new employee in a company, and a colleague comes to you with
the following program, written by your predecessor who was summarily

L ECTURE N OTES c Carnegie Mellon University 2018


Lecture 1: Contracts 2

fired for being a poor programmer. Your colleague claims he has tracked a
bug in a larger project to this function. It is your job to find and correct this
bug.
1 int f (int x, int y) {
2 int r = 1;
3 while (y > 1) {
4 if (y % 2 == 1) {
5 r = x * r;
6 }
7 x = x * x;
8 y = y / 2;
9 }
10 return r * x;
11 }
Before you read on, you might examine this program for a while to try
to determine what it does, or is supposed to do, and see if you can spot the
problem.
Lecture 1: Contracts 3

2 Forming a Conjecture
The first step is to execute the program on some input values to see its
results. The code is in a file called mystery.c0 so we invoke the coin in-
terpreter to let us experiment with code.
% coin mystery.c0
C0 interpreter (coin) 0.3.3 ’Nickel’
Type ‘#help’ for help or ‘#quit’ to exit.
-->
At this point we can type in statements and they will be executed. One
form of statement is an expression, in which case coin will show its value.
For example:
--> 3+8;
11 (int)
-->
We can also use the functions in the files that we loaded when we
started coin. In this case, the mystery function is called f, so we can eval-
uate it on some arguments.
--> f(2,3);
8 (int)
--> f(2,4);
16 (int)
--> f(1,7);
1 (int)
--> f(3,2);
9 (int)
-->
Can you form a conjecture from these values?
Lecture 1: Contracts 4

From these and similar examples, you might form the conjecture that
f (x, y) = xy , that is, x to the power y. One can confirm that with a few
more values, such as
--> f(-2,3);
-8 (int)
--> f(2,8);
256 (int)
--> f(2,10);
1024 (int)
-->
It seems to work out! Our next task is to see why this function actually
computes the power function. Understanding this is necessary so we can
try to find the error and correct it.
Lecture 1: Contracts 5

3 Finding a Loop Invariant


Now we start to look inside the function and see how it computes.
1 int f (int x, int y) {
2 int r = 1;
3 while (y > 1) {
4 if (y % 2 == 1) {
5 r = x * r;
6 }
7 x = x * x;
8 y = y / 2;
9 }
10 return r * x;
11 }
We notice the conditional
4 if (y % 2 == 1) {
5 r = x * r;
6 }
The condition tests if y modulo 2 is 1. For positive y, this is true if y is odd.
We also observe that in the loop body, y must indeed be positive so this is
a correct test for whether y is odd.
Each time around the loop we divide y by 2, using integer division
(which rounds towards 0). It is exact division if y is even. If y starts as
a power of 2, it will remain even throughout the iteration. In this case r
will remain 1 throughout the execution of the function. Let’s tabulate how
the loop works for x = 2 and y = 8. But at which point in the program do
we tabulate the values? It turns out generally the best place for a loop is just
before the exit condition is tested. By iteration 0 we mean when we enter the
loop the first time and test the condition; iteration 1 is after the loop body
has been traversed once and we are looking again at the exit condition, etc.

iteration x y r
0 2 8 1
1 4 4 1
2 16 2 1
3 256 1 1

After 3 iterations, x = 256 and y = 1, so the loop condition y > 1 becomes


false and we exit the loop. We return r ∗ x = 256.
Lecture 1: Contracts 6

To understand why this loop works we need to find a so-called loop in-
variant: a quantity that does not change throughout the loop. In this exam-
ple, when y is a power of 2 then r is a loop invariant. Can you find a loop
invariant involving just x and y?
Lecture 1: Contracts 7

Going back to our earlier conjecture, we are trying to show that this
function computes xy . Interestingly, after every iteration of the loop, this
quantity is exactly the same! Before the first iteration it is 28 = 256. After
the first iteration it is 44 = 256. After the second iteration it is 162 = 256.
After the third iteration, it is 2561 = 256. Let’s note it down in the table.

iteration x y r xy
0 2 8 1 256
1 4 4 1 256
2 16 2 1 256
3 256 1 1 256

Still concentrating on this special case where y is a power of 2, let’s see


if we can use the invariant to show that the function is correct.
Lecture 1: Contracts 8

4 Proving the Loop Invariant


To show that the quantity xy is a loop invariant, we have to prove that if
we execute the loop body once, xy before executing the body will be equal
to xy after executing the body. We cannot write this as xy = xy , because
that is of course always true, speaking mathematically. Mathematics does
not understand the idea of assigning a new value to a variable. The general
convention we follow is to add a prime (0 ) to the name of a variable to
denote its value after an iteration.
So assume we have x and y, and y is a power of 2. After one iteration
we have x0 = x ∗ x and y 0 = y/2. To show that xy is loop invariant, we have
0
to show that xy = x0 y . So let’s calculate:
0
x0 y = (x ∗ x)y/2 By definition of x0 and y 0
= (x2 )y/2 Since a ∗ a = a2
= x2∗(y/2) Since (ab )c = ab∗c
= xy Since 2 ∗ (a/2) = a when a is even

Moreover, if y is a power of 2, then y 0 = y/2 is also a power of 2 (subtracting


1 from the exponent).
We have confirmed that xy is a loop invariant if y is a power of 2. Does
this help us to ascertain that the function is correct when y is a power of
two?
Lecture 1: Contracts 9

5 Loop Invariant Implies Postcondition


The postcondition of a function is usually a statement about the result it re-
turns. Here, the postcondition is that f (x, y) = xy . Let’s recall the function:
1 int f (int x, int y) {
2 int r = 1;
3 while (y > 1) {
4 if (y % 2 == 1) {
5 r = x * r;
6 }
7 x = x * x;
8 y = y / 2;
9 }
10 return r * x;
11 }
If y is a power of 2, then the quantity xy never changes in the loop (as we
have just shown). Also, in that case r never changes, remaining equal to 1.
When we exit the loop, y = 1 because y starts out as some (positive) power
of 2 and is divided by 2 every time around loop. So then

r ∗ x = 1 ∗ x = x = x1 = xy

so we return the correct result, xy !


By using two loop invariant expressions (r and xy ) we were able to
show that the function returns the correct answer if it does return an an-
swer. Does the loop always terminate?
Lecture 1: Contracts 10

6 Termination
In this case it is easy to see that the loop always terminates. To show that
a loop always terminates, we need to define some quantity that always gets
strictly smaller during any arbitrary iteration of the loop, and that can never
become negative. This means that the loop can only run a finite number of
times.
The quantity y/2 is always less than y when y > 0, so on any arbitrary
iteration of the loop, y gets strictly smaller and it can never become nega-
tive. Therefore, we know the loop has to terminate.
(By the same token, we could identify any lower bound, not just zero,
and a quantity that strictly decreases and never passes that lower bound,
or we could identify an upper bound and a quantity that strictly increases
but never passes that upper bound!)
Lecture 1: Contracts 11

7 A Counterexample
We don’t have to look at y being a power of 2 — we already know the func-
tion works correctly there. Some of the earlier examples were not powers
of two, and the function still worked:
--> f(2,3);
8 (int)
--> f(-2,3);
-8 (int)
--> f(2,1);
2 (int)
-->
What about 0, or negative exponents?
--> f(2,0);
2 (int)
--> f(2,-1);
2 (int)
-->
It looks like we have found at least two problems. 20 = 1, so the answer
2 is definitely incorrect. 2−1 = 1/2 so one might argue it should return
0. Or one might argue in the absence of fractions (we are working with
integers), a negative exponent does not make sense. In any case, f (2, −1)
should certainly not return 2.
Lecture 1: Contracts 12

8 Imposing a Precondition
Let’s go back to a mathematical definition of the power function xy on inte-
gers x and y. We define:
 0
x = 1
xy+1 = x ∗ xy for y ≥ 0

In this form it remains undefined for negative exponents. In programming,


this is captured as a precondition: we require that the second argument to
f not be negative. Preconditions are written as //@requires and come
before the body of the function.
1 int f (int x, int y)
2 //@requires y >= 0;
3 {
4 int r = 1;
5 while (y > 1) {
6 if (y % 2 == 1) {
7 r = x * r;
8 }
9 x = x * x;
10 y = y / 2;
11 }
12 return r * x;
13 }
This is the first part of what we call the function contract. It expresses what
the function requires of any client that calls it, namely that the second ar-
gument be non-negative. It is an error to call it with a negative argument;
no promises are made about what the function might return in such case.
It might even abort the computation due to a contract violation.
But a contract usually has two sides. What does f promise? We know it
promises to compute the exponential function, so this should be formally
expressed.
Lecture 1: Contracts 13

9 Promising a Postcondition
The C0 language does not have a built-in power function. So we need to
write it explicitly ourselves. But wait! Isn’t that what f is supposed to do?
The idea in this and many other examples is to capture a specification in the
simplest possible form, even if it may not be computationally efficient, and
then promise in the postcondition to satisfy this simple specification. Here,
we can transcribe the mathematical definition into a recursive function.
int POW (int x, int y)
//@requires y >= 0;
{
if (y == 0)
return 1;
else
return x * POW(x, y-1);
}
In the rest of the lecture we often silently go back and forth between xy
and POW(x,y). Now we incorporate POW into a formal postcondition for
the function. Postconditions have the form //@ensures e;, where e is a
boolean expression. They are also written before the function body, by con-
vention after the preconditions. Postconditions can use a special variable
\result to refer to the value returned by the function.
1 int f (int x, int y)
2 //@requires y >= 0;
3 //@ensures \result == POW(x,y);
4 {
5 int r = 1;
6 while (y > 1) {
7 if (y % 2 == 1) {
8 r = x * r;
9 }
10 x = x * x;
11 y = y / 2;
12 }
13 return r * x;
14 }
Note that as far as the function f is concerned, if we are considering calling
it we do not need to look at its body at all. Just looking at the pre- and
Lecture 1: Contracts 14

post-conditions (the @requires and @ensures clauses) tells us everything


we need to know. As long as we adhere to our contract and pass f a non-
negative y, then f will adhere to its contract and return xy .
Lecture 1: Contracts 15

10 Dynamically Checking Contracts


During the program development phase, we can instruct the C0 compiler
or interpreter to check adherence to contracts. This is done with the -d flag
on the command line, which stands for dynamic checking. Let’s see how the
implementation now reacts to correct and incorrect inputs, assuming we
have added POW as well as pre- and postconditions as shown above.
% coin mystery2b.c0 -d
mystery2b.c0:20.5-20.6:error:cannot assign to variable ’x’
used in @ensures annotation
x = x * x;
~
Unable to load files, exiting...
%
The error is that we are changing the value of x in the body of the loop,
while the postcondition refers to x. If it were allowed, it would violate the
principle that we need to look only at the contract when calling the func-
tion, because assignments to x change the meaning of the postcondition.
We want \result == POW(x,y) for the original x and y we passed as argu-
ments to f and not the values x and y might hold at the end of the function.
We therefore change the function body, creating auxiliary variables b
(for base) and e (for exponent) to replace x and y, which we leave un-
changed.
1 int f (int x, int y)
2 //@requires y >= 0;
3 //@ensures \result == POW(x,y);
4 {
5 int r = 1;
6 int b = x; /* base */
7 int e = y; /* exponent */
8 while (e > 1) {
9 if (e % 2 == 1) {
10 r = b * r;
11 }
12 b = b * b;
13 e = e / 2;
14 }
15 return r * b;
16 }
Lecture 1: Contracts 16

Now invoking the interpreter with -d works correctly when we return


the right answer, but raises an exception if we give it arguments where we
know the function to be incorrect, or arguments that violate the precondi-
tion to the function.
# coin mystery2c.c0 -d
C0 interpreter (coin) 0.3.3 ’Nickel’
Type ‘#help’ for help or ‘#quit’ to exit.
--> f(3,2);
9 (int)
--> f(3,-1);
mystery2c.c0:11.4-11.20: @requires annotation failed

Last position: mystery2c.c0:11.4-11.20


f from <stdio>:1.1-1.8
--> f(2,0);
mystery2c.c0:12.4-12.32: @ensures annotation failed
Last position: mystery2c.c0:12.4-12.32
f from <stdio>:1.1-1.7
-->
The fact that @requires annotation fails in the second example call means
that our call is to blame, not f . The fact that the @ensures annotation fails
in the third example call means the function f does not satisfy its contract
and is therefore to blame.
Lecture 1: Contracts 17

11 Generalizing the Loop Invariant


Before fixing the bug with an exponent of 0, let’s figure out why the func-
tion apparently works when the exponent is odd. Our loop invariant so far
only works when y is a power of 2. It uses the basic law that b2∗c = (b2 )c =
(b ∗ b)c in the case where the exponent e = 2 ∗ c is even.
What about the case where the exponent is odd? Then we are trying
to compute b2∗c+1 . With analogous reasoning to above we obtain b2∗c+1 =
b ∗ b2∗c = b ∗ (b ∗ b)c . This means there is an additional factor of b in the
answer. We see that we exactly multiply r by b in the case that e is odd!
1 int f (int x, int y)
2 //@requires y >= 0;
3 //@ensures \result == POW(x,y);
4 {
5 int r = 1;
6 int b = x; /* base */
7 int e = y; /* exponent */
8 while (e > 1) {
9 if (e % 2 == 1) {
10 r = b * r;
11 }
12 b = b * b;
13 e = e / 2;
14 }
15 return r * b;
16 }
What quantity remains invariant now, throughout the loop? Try to form a
conjecture for a more general loop invariant before reading on.
Lecture 1: Contracts 18

Let’s make a table again, this time to trace a call when the exponent is
not a power of two, say, while computing 27 by calling f (2, 7).

iteration b e r be r ∗ be
0 2 7 1 128 128
1 4 3 2 64 128
2 16 1 8 16 128

As we can see, be is not invariant, but r ∗ be = 128 is! The extra factor from
the equation on the previous page is absorbed into r.
We now express this proposed invariant formally in C0. This requires
the @loop_invariant annotation. It must come immediately before the
loop body, but it is checked just before the loop exit condition. We would
like to say that the expression r * POW(b,e) is invariant, but this is not
possible directly.
Loop invariants in C0 are boolean expressions which must be either true
or false. We can achieve this by stating that r * POW(b,e) == POW(x,y).
Observe that x and y do not change in the loop, so this guarantees that
r * POW(b,e) never changes either. But it says a little more, stating what
the invariant quantity is in terms of the original function parameters.
1 int f (int x, int y)
2 //@requires y >= 0;
3 //@ensures \result == POW(x,y);
4 {
5 int r = 1;
6 int b = x; /* base */
7 int e = y; /* exponent */
8 while (e > 1)
9 //@loop_invariant r * POW(b,e) == POW(x,y);
10 {
11 if (e % 2 == 1) {
12 r = b * r;
13 }
14 b = b * b;
15 e = e / 2;
16 }
17 return r * b;
18 }
Lecture 1: Contracts 19

12 Fixing the Function


The bug we have discovered so far was for y = 0. In that case, e = 0
so we never go through the loop. If we exit the loop and e = 1, then the
loop invariant implies the function postcondition. To see this, note that we
return r ∗ b and r ∗ b = r ∗ b1 = r ∗ be = xy , where the last equation is the
loop invariant. When y (and therefore e) is 0, however, this reasoning does
not apply because we exit the loop and e = 0, not 1: x0 = 1 but r ∗ b = x
since r = 1 and b = x.
Think about how you might fix the function and its annotations before
reading on.
Lecture 1: Contracts 20

We can fix it by carrying on with the while loop until e = 0. On the


last iteration e is 1, which is odd, so we set r0 = b ∗ r. This means we now
should return r0 (the new r) after the one additional iteration of the loop,
and not r ∗ b.
1 int f (int x, int y)
2 //@requires y >= 0;
3 //@ensures \result == POW(x,y);
4 {
5 int r = 1;
6 int b = x; /* base */
7 int e = y; /* exponent */
8 while (e > 0)
9 //@loop_invariant r * POW(b,e) == POW(x,y);
10 {
11 if (e % 2 == 1) {
12 r = b * r;
13 }
14 b = b * b;
15 e = e / 2;
16 }
17 return r;
18 }
Now when the exponent y = 0 we skip the loop body and return r = 1,
which is the right answer for x0 ! Indeed:
% coin mystery2e.c0 -d
C0 interpreter (coin) 0.3.3 ’Nickel’
Type ‘#help’ for help or ‘#quit’ to exit.
--> f(2,0);
1 (int)
-->
Lecture 1: Contracts 21

13 Strengthening the Loop Invariant Again


We would now like to show that the improved function is correct. That
requires two steps: one is that the loop invariant implies the postcondition;
another is that the proposed loop invariant is indeed a loop invariant. The
loop invariant, r ∗ be = xy implies that the result r = xy if we know that
e = 0 (since b0 = 1).
But how do we know that e = 0 when we exit the loop? Actually,
we don’t: the loop invariant is too weak to prove that. The negation of
the exit condition only tells us that e ≤ 0. However, if we add another
loop invariant, namely that e ≥ 0, then we know e = 0 when the loop is
exited and the postcondition follows. For clarity, we also add a (redundant)
assertion to this effect after the loop and before the return statement.
1 int f (int x, int y)
2 //@requires y >= 0;
3 //@ensures \result == POW(x,y);
4 {
5 int r = 1;
6 int b = x; /* base */
7 int e = y; /* exponent */
8 while (e > 0)
9 //@loop_invariant e >= 0;
10 //@loop_invariant r * POW(b,e) == POW(x,y);
11 {
12 if (e % 2 == 1) {
13 r = b * r;
14 }
15 b = b * b;
16 e = e / 2;
17 }
18 //@assert e == 0;
19 return r;
20 }
The @assert annotation can be used to verify an expression that should
be true. If it is not, our reasoning must have been faulty somewhere else.
@assert is a useful debugging tool and sometimes helps the reader under-
stand better what the code author intended.
Lecture 1: Contracts 22

14 Verifying the Loop Invariants


It seems like we have beaten this example to death: we have added pre- and
post-conditions, stated loop invariants, fixed the original bug and shown
that the loop invariants imply the postcondition. But we have not yet veri-
fied that the loop invariant actually holds! Ouch! Let’s do it.
We begin with the invariant //@loop_invariant e >= 0;, which we
write in the mathematical form e ≥ 0 for convenience. We have to demon-
strate two properties.

Init: The invariant holds initially. When we enter the loop, e = y and y ≥ 0
by the precondition of the function. Done.

Preservation: Assume the invariant holds just before the exit condition is
checked. We have to show that it is true again when we reach the exit
condition after one iteration of the loop.

Assumption: e ≥ 0.
To show: e0 ≥ 0 where e0 = e/2, with integer division. This clearly
holds.

Next, we look at the invariant //@loop_invariant r * POW(b,e) == POW(x,y);,


again written in its mathematical form as r ∗ be = xy for clarity.

Init: The invariant holds initially, because when entering the loop we have
r = 1, b = x and e = y.

Preservation: We show that the invariant is preserved on every iteration.


For this, we distinguish two cases: e is even and e is odd.

Assumption: r ∗ be = xy .
0
To show: r0 ∗ b0 e = xy , where r0 , b0 , and e0 are the values of r, b, and e
after one iteration.
Case e is even, so that e = 2 ∗ n for some positive n:
Then r0 = r, b0 = b ∗ b and e0 = e/2 = 2 ∗ n/2 = n, and we reason:
0
r0 ∗ b0 e = r ∗ (b ∗ b)n
= r ∗ b2∗n Since (a2 )c = a2∗c
= r∗b e Because we set e = 2 ∗ n
= xy By assumption
Lecture 1: Contracts 23

Case e is odd, thus e = 2 ∗ n + 1 for some non-negative n:


Then r0 = b ∗ r, b0 = b ∗ b and e0 = (e − 1)/2 = (2 ∗ n + 1 − 1)/2 = n
and we reason:
0
r0 ∗ b0 e = (b ∗ r) ∗ (b ∗ b)n
= (b ∗ r) ∗ b2∗n Since (a2 )c = a2∗c
= r ∗ b2∗n+1 Since a ∗ (ac ) = ac+1
= r ∗ be Because we set e = 2 ∗ n + 1
= xy By assumption

This shows that both loop invariants hold on every iteration.


Lecture 1: Contracts 24

15 Termination
The previous argument for termination still holds. By loop invariant, we
know that e ≥ 0. When we enter the body of the loop, the condition must
be true so e > 0. Now we just use that e/2 < e for e > 0, so the value
of e is strictly decreasing and positive, which, as an integer, means it must
eventually become 0, upon which we exit the loop and return from the
function after one additional step.
Lecture 1: Contracts 25

16 A Surprise
Now, let’s try our function on some larger numbers, computing some pow-
ers of 2.
% coin mystery2f.c0 -d
C0 interpreter (coin) 0.3.3 ’Nickel’
Type ‘#help’ for help or ‘#quit’ to exit.
--> f(2,30);
1073741824 (int)
--> f(2,31);
-2147483648 (int)
--> f(2,32);
0 (int)
-->
230 looks plausible, but how could 231 be negative or 232 be zero? We
claimed we just proved it correct!
The reason is that the values of type int in C0 or C and many other
languages actually do not represent arbitrarily large integers, but have a
fixed-size representation. In mathematical terms, this means that we are
dealing with modular arithmetic. The fact that 232 = 0 provides a clue that
integers in C0 have 32 bits, and arithmetic operations implement arithmetic
modulo 232 .
In this light, the results above are actually correct. We examine modular
arithmetic in detail in the next lecture.
Lecture 1: Contracts 26

17 Summary: Contracts, and Why They are Important


We have introduced contracts, using the example of an algorithm for integer
exponentiation.
Contracts are expressed in form of annotations, started with //@. These
annotations are checked when the program is executed if it is compiled or
interpreted with the -d flag. Otherwise, they are ignored.
The forms of contracts, and how they are checked, are:

@requires: A precondition to a function. This is checked just before the


function body executes.

@ensures: A postcondition for a function. This is checked just after the


function body has been executed. We use \result to refer to the
value returned by the function to impose a condition on it.

@loop_invariant: A loop invariant. This is checked every time just before


the loop exit condition is tested.

@assert: An assertion. This is like a statement and is checked every time


it is encountered during execution.

Contracts are important for two purposes.

Testing: Contracts represent a kind of generic test of a function. Rather


than stating specific inputs (like f(2,8) and testing the answer 256),
contracts talk about expected properties for arbitrary values. On the
other hand, contracts are only useful in this regard if we have a good
set of test cases, because contracts that are not executed with values
that cause them to fail cannot cause execution to abort.

Reasoning: Contracts express properties of programs so we can prove them.


Ultimately, this can mathematically verify program correctness. Since
correctness is the most important concern about programs, this is a
crucial aspect of program development. Different forms of contracts
have different roles, reviewed below.

The proof obligations for contracts are as follows:

@requires: At the call sites we have to prove that the precondition for the
function is satisfied for the given arguments. We can then assume it
when reasoning in the body of the function.
Lecture 1: Contracts 27

@ensures: At the return sites inside a function we have to prove that the
postcondition is satisfied for the given return value. We can then as-
sume it at the call site.

@loop_invariant: We have to show:

Init: The loop invariant is satisfied initially, when the loop is first
encountered.
Preservation: Assuming the loop invariant is satisfied at the begin-
ning of the loop (just before the exit test), we have to show it still
holds when the beginning of the loop is reached again, after one
iteration of the loop.

We are then allowed to assume that the loop invariant holds after the
loop exits, together with the exit condition.

@assert: We have to show that an assertion is satisfied when it is reached


during program execution. We can then assume it for subsequent
statements.

Contracts are crucial for reasoning since (a) they express what needs to
be proved in the first place (give the program’s specification), and (b) they
localize reasoning: from a big program to the conditions on the individual
functions, from the inside of a big function to each loop invariant or asser-
tion.
Lecture 1: Contracts 28

Exercises
Exercise 1. Rewrite first POW and then f so that it signals an error in case of
an overflow rather than silently working in modular arithmetic. You can use the
statement error("Overflow"); to signal an overflow.

Exercise 2. Find an input for f that fails our first guess of a loop invariant:
//@loop_invariant POW(b,e) == POW(x,y);

You might also like