on ef93607 help sign in
Idris-dev/tutorial/provisional.tex
316 lines 8.9 kB history raw
1\section{Provisional Definitions}
3Sometimes when programming with dependent types, the type required by the type
4checker and the type of the program we have written will be different (in that
5they do not have the same normal form), but nevertheless provably equal. For
6example, recall the \texttt{parity} function:
8\begin{SaveVerbatim}{pardecl}
10data Parity : Nat -> Type where
11 even : Parity (n + n)
12 odd : Parity (S (n + n))
14parity : (n:Nat) -> Parity n
16\end{SaveVerbatim}
17\useverb{pardecl}
19\noindent
20We'd like to implement this as follows:
22\begin{SaveVerbatim}{parfail}
24parity : (n:Nat) -> Parity n
25parity Z = even {n=Z}
26parity (S Z) = odd {n=Z}
27parity (S (S k)) with (parity k)
28 parity (S (S (j + j))) | even = even {n=S j}
29 parity (S (S (S (j + j)))) | odd = odd {n=S j}
31\end{SaveVerbatim}
32\useverb{parfail}
34\noindent
35This simply states that zero is even, one is odd, and recursively, the parity
36of \texttt{k+2} is the same as the parity of \texttt{k}.
37Explicitly marking the value of \texttt{n} in
38even and odd is necessary to help type inference. Unfortunately, the type
39checker rejects this:
41\begin{SaveVerbatim}{parerror}
43views.idr:12:Can't unify Parity (plus (S j) (S j)) with
44Parity (S (S (plus j j)))
46\end{SaveVerbatim}
47\useverb{parerror}
49\noindent
50The type checker
51is telling us that \texttt{(j+1)+(j+1)} and \texttt{2+j+j}
52do not normalise to the same value.
53This is because \texttt{plus} is defined by recursion on its first argument, and in the
54second value, there is a successor symbol on the second argument, so this will
55not help with reduction. These values are obviously equal --- how can we rewrite
56the program to fix this problem?
58\subsection{Provisional definitions}
60\emph{Provisional definitions} help with this problem by allowing us to defer the
61proof details until a later point. There are two main reasons why they are
62useful.
64\begin{itemize}
65\item When \emph{prototyping}, it is useful to be able to test programs before
66finishing all the details of proofs.
67\item When \emph{reading} a program, it is often much clearer to defer the proof
68details so that they do not distract the reader from the underlying algorithm.
69\end{itemize}
71\noindent
72Provisional definitions are written in the same way as ordinary definitions,
73except that they introduce the right hand side with a \texttt{?=} rathar than
74\texttt{=}. We define
75\texttt{parity} as follows:
77\begin{SaveVerbatim}{paritypro}
79parity : (n:Nat) -> Parity n
80parity Z = even {n=Z}
81parity (S Z) = odd {n=Z}
82parity (S (S k)) with (parity k)
83 parity (S (S (j + j))) | even ?= even {n=S j}
84 parity (S (S (S (j + j)))) | odd ?= odd {n=S j}
86\end{SaveVerbatim}
87\useverb{paritypro}
89\noindent
90When written in this form, instead of reporting a type error, \Idris{} will insert
91a metavariable standing for a theorem which will correct the type error. \Idris{}
92tells us we have two proof obligations, with names generated from the module and
93function names:
95\begin{SaveVerbatim}{prometas}
97*views> :m
98Global metavariables:
99 [views.parity_lemma_2,views.parity_lemma_1]
101\end{SaveVerbatim}
102\useverb{prometas}
104\noindent
105The first of these has the following type:
107\begin{SaveVerbatim}{prolem1}
109*views> :p views.parity_lemma_1
111---------------------------------- (views.parity_lemma_1) --------
112{hole0} : (j : Nat) -> (Parity (plus (S j) (S j))) -> Parity (S (S (plus j j)))
114-views.parity_lemma_1>
116\end{SaveVerbatim}
117\useverb{prolem1}
119\noindent
120The two arguments are \texttt{j}, the variable in scope from the pattern match,
121and \texttt{value}, which is the value we gave in the right hand side of the
122provisional definition. Our goal is to rewrite the type so that we can use
123this value.
124We can achieve this using the following theorem from
125the prelude:
127\begin{SaveVerbatim}{plusnsm}
129plusSuccRightSucc : (left : Nat) -> (right : Nat) ->
130 S (plus left right) = plus left (S right)
133\end{SaveVerbatim}
134\useverb{plusnsm}
136\noindent
137After applying \texttt{intro} twice, we have:
139\begin{SaveVerbatim}{prolemii}
141-views.parity_lemma_1> intro
143 j : Nat
144 value : Parity (S (plus j (S j)))
145---------------------------------- (views.parity_lemma_1) --------
146{hole2} : Parity (S (S (plus j j)))
148\end{SaveVerbatim}
149\useverb{prolemii}
151\noindent
152Then we apply the \texttt{plusSuccRightSucc} rewrite rule, symmetrically,
153to \texttt{j} and \texttt{j}, giving:
155\begin{SaveVerbatim}{prolemr}
157-views.parity_lemma_1> rewrite sym (plusSuccRightSucc j j)
159 j : Nat
160 value : Parity (S (plus j (S j)))
161---------------------------------- (views.parity_lemma_1) --------
162{hole3} : Parity (S (plus j (S j)))
164\end{SaveVerbatim}
165\useverb{prolemr}
167\noindent
168\texttt{sym} is a function, defined in the library, which reverses the order of the rewrite:
170\begin{SaveVerbatim}{sym}
172sym : l = r -> r = l
173sym refl = refl
175\end{SaveVerbatim}
176\useverb{sym}
178\noindent
179We can complete this proof using the \texttt{trivial} tactic, which finds
180\texttt{value} in the premisses. The proof of the second lemma proceeds in
181exactly the same way.
183\subsection{Suspension of Disbelief}
185\Idris{} requires that proofs be complete before compiling programs (although
186evaluation at the prompt is possible without proof details). Sometimes,
187especially when prototyping, it is easier not to have to do this. It might even
188be beneficial to test programs before attempting to prove things about them ---
189if testing finds an error, you know you had better not waste your time proving
190something!
192Therefore, \Idris{} provides a built-in coercion function, which allows you to use
193a value of the incorrect types:
195\begin{SaveVerbatim}{believe}
197believe_me : a -> b
199\end{SaveVerbatim}
200\useverb{believe}
202\noindent
203Obviously, this should be used with extreme caution. It is useful when prototyping, and
204can also be appropriate when asserting properties of external code (perhaps in an
205external C library). The ``proof'' of \texttt{views.parity\_lemma\_1} using this is:
207\begin{SaveVerbatim}{pladodgy}
209views.parity_lemma_2 = proof {
210 intro;
211 intro;
212 exact believe_me value;
215\end{SaveVerbatim}
216\useverb{pladodgy}
218\noindent
219The \texttt{exact} tactic allows us to provide an exact value for the proof. In this case,
220we assert that the value we gave was correct.
222\subsection{Example: Binary numbers}
224Previously, we implemented conversion to binary numbers using the \texttt{Parity} view.
225Here, we show how to use the same view to implement a verified conversion to
226binary.
227We begin by indexing binary numbers over their \texttt{Nat} equivalent. This is a common
228pattern, linking a representation (in this case \texttt{Binary}) with a meaning (in this
229case \texttt{Nat}):
231\begin{SaveVerbatim}{bindef}
233data Binary : Nat -> Type where
234 bEnd : Binary Z
235 bO : Binary n -> Binary (n + n)
236 bI : Binary n -> Binary (S (n + n))
238\end{SaveVerbatim}
239\useverb{bindef}
241\noindent
242\texttt{bO} and \texttt{bI} take a binary number as an argument and effectively shift it one bit
243left, adding either a zero or one as the new least significant bit. The index,
244\texttt{n + n} or \texttt{S (n + n)} states the result that this left shift then add will
245have to the meaning of the number. This will result in a representation with
246the least significant bit at the front.
248Now a function which converts a Nat to binary will state, in the type, that the
249resulting binary number is a faithful representation of the original Nat:
251\begin{SaveVerbatim}{ntbty}
253natToBin : (n:Nat) -> Binary n
255\end{SaveVerbatim}
256\useverb{ntbty}
258\noindent
259The \texttt{Parity} view makes the definition fairly simple --- halving the
260number is effectively a right shift after all --- although we need to use a
261provisional definition in the odd case:
263\begin{SaveVerbatim}{ntbdef}
265natToBin : (n:Nat) -> Binary n
266natToBin Z = bEnd
267natToBin (S k) with (parity k)
268 natToBin (S (j + j)) | even = bI (natToBin j)
269 natToBin (S (S (j + j))) | odd ?= bO (natToBin (S j))
271\end{SaveVerbatim}
272\useverb{ntbdef}
274\noindent
275The problem with the odd case is the same as in the definition of \texttt{parity}, and
276the proof proceeds in the same way:
278\begin{SaveVerbatim}{ntboddprf}
280natToBin_lemma_1 = proof {
281 intro;
282 intro;
283 rewrite sym (plusSuccRightSucc j j);
284 trivial;
287\end{SaveVerbatim}
288\useverb{ntboddprf}
290\noindent
291To finish, we'll implement a main program which reads an integer from the user and
292outputs it in binary.
294\begin{SaveVerbatim}{binmain}
296main : IO ()
297main = do putStr "Enter a number: "
298 x <- getLine
299 print (natToBin (fromInteger (cast x)))
301\end{SaveVerbatim}
302\useverb{binmain}
304\noindent
305For this to work, of course, we need a \texttt{Show} instance for \texttt{Binary n}:
307\begin{SaveVerbatim}{showbin}
309instance Show (Binary n) where
310 show (bO x) = show x ++ "0"
311 show (bI x) = show x ++ "1"
312 show bEnd = ""
314\end{SaveVerbatim}
315\useverb{showbin}