Extended pattern matching¶
- Authors
Cristina Cornes and Hugo Herbelin
This section describes the full form of pattern matching in Coq terms.
Variants and extensions of match¶
Multiple and nested pattern matching¶
The basic version of match allows pattern matching on simple
patterns. As an extension, multiple nested patterns or disjunction of
patterns are allowed, as in ML-like languages
(cf. Multiple patterns and Nested patterns).
The extension just acts as a macro that is expanded during parsing
into a sequence of match on simple patterns. Especially, a
construction defined using the extended match is generally printed
under its expanded form (see Printing Matching).
Pattern-matching on boolean values: the if expression¶
term_if::=if term as name? return term100? then term else termFor inductive types with exactly two constructors and for pattern matching
expressions that do not depend on the arguments of the constructors, it is possible
to use a if … then … else notation. For instance, the definition
- Definition not (b:bool) := match b with | true => false | false => true end.
- not is defined
can be alternatively written
- Definition not (b:bool) := if b then false else true.
- not is defined
More generally, for an inductive type with constructors ident1
and ident2, the following terms are equal:
if term0 as name? return term? then term1 else term2
match term0 as name? return term? with | ident1 _* => term1 | ident2 _* => term2 end
Example
- Check (fun x (H:{x=0}+{x<>0}) => match H with | left _ => true | right _ => false end).
- fun (x : nat) (H : {x = 0} + {x <> 0}) => if H then true else false : forall x : nat, {x = 0} + {x <> 0} -> bool
Notice that the printing uses the if syntax because sumbool is
declared as such (see Controlling pretty-printing of match expressions).
Irrefutable patterns: the destructuring let variants¶
Pattern-matching on terms inhabiting inductive type having only one
constructor can be alternatively written using let … in …
constructions. There are two variants of them.
::=let ( name*, ) as name? return term100? := term in term|let ' pattern := term return term100? in term|let ' pattern in pattern := term return term100 in termFirst destructuring let syntax¶
The expression let ( identi*, ) := term0 in term1
performs case analysis on term0 whose type must be an
inductive type with exactly one constructor. The number of variables
identi must correspond to the number of arguments of this
constructor. Then, in term1, these variables are bound to the
arguments of the constructor in term0. For instance, the
definition
- Definition fst (A B:Set) (H:A * B) := match H with | pair x y => x end.
- fst is defined
can be alternatively written
- Definition fst (A B:Set) (p:A * B) := let (x, _) := p in x.
- fst is defined
Notice that reduction is different from regular let … in …
construction since it happens only if term0 is in constructor form.
Otherwise, the reduction is blocked.
The pretty-printing of a definition by matching on a irrefutable
pattern can either be done using match or the let construction
(see Section Controlling pretty-printing of match expressions).
If term inhabits an inductive type with one constructor C, we have an
equivalence between
let (ident₁, …, identₙ) [dep_ret_type] := term in term'
and
match term [dep_ret_type] with
C ident₁ … identₙ => term'
end
Second destructuring let syntax¶
Another destructuring let syntax is available for inductive types with one constructor by giving an arbitrary pattern instead of just a tuple for all the arguments. For example, the preceding example can be written:
- Definition fst (A B:Set) (p:A*B) := let 'pair x _ := p in x.
- fst is defined
This is useful to match deeper inside tuples and also to use notations
for the pattern, as the syntax let ’p := t in b allows arbitrary
patterns to do the deconstruction. For example:
- Definition deep_tuple (A:Set) (x:(A*A)*(A*A)) : A*A*A*A := let '((a,b), (c, d)) := x in (a,b,c,d).
- deep_tuple is defined
- Notation " x 'With' p " := (exist _ x p) (at level 20).
- Identifier 'With' now a keyword
- Definition proj1_sig' (A:Set) (P:A->Prop) (t:{ x:A | P x }) : A := let 'x With p := t in x.
- proj1_sig' is defined
When printing definitions which are written using this construct it takes precedence over let printing directives for the datatype under consideration (see Section Controlling pretty-printing of match expressions).
Controlling pretty-printing of match expressions¶
The following commands give some control over the pretty-printing
of match expressions.
Printing nested patterns¶
-
Flag
Printing Matching¶ The Calculus of Inductive Constructions knows pattern matching only over simple patterns. It is however convenient to re-factorize nested pattern matching into a single pattern matching over a nested pattern.
When this flag is on (default), Coq’s printer tries to do such limited re-factorization. Turning it off tells Coq to print only simple pattern matching problems in the same way as the Coq kernel handles them.
Factorization of clauses with same right-hand side¶
-
Flag
Printing Factorizable Match Patterns¶ When several patterns share the same right-hand side, it is additionally possible to share the clauses using disjunctive patterns. Assuming that the printing matching mode is on, this flag (on by default) tells Coq's printer to try to do this kind of factorization.
Use of a default clause¶
-
Flag
Printing Allow Match Default Clause¶ When several patterns share the same right-hand side which do not depend on the arguments of the patterns, yet an extra factorization is possible: the disjunction of patterns can be replaced with a
_default clause. Assuming that the printing matching mode and the factorization mode are on, this flag (on by default) tells Coq's printer to use a default clause when relevant.
Printing of wildcard patterns¶
Printing of the elimination predicate¶
Printing matching on irrefutable patterns¶
If an inductive type has just one constructor, pattern matching can be written using the first destructuring let syntax.
-
Table
Printing Let qualid¶ This table specifies a set of qualids for which pattern matching is displayed using a let expression. Note that this only applies to pattern matching instances entered with
match. It doesn't affect pattern matching explicitly entered with a destructuringlet. Use theAddandRemovecommands to update this set.
Printing matching on booleans¶
If an inductive type is isomorphic to the boolean type, pattern matching
can be written using if … then … else …. This table controls
which types are written this way:
-
Table
Printing If qualid¶ This table specifies a set of qualids for which pattern matching is displayed using
if…then…else…. Use theAddandRemovecommands to update this set.
This example emphasizes what the printing settings offer.
Example
- Definition snd (A B:Set) (H:A * B) := match H with | pair x y => y end.
- snd is defined
- Test Printing Let for prod.
- Cases on elements of prod are printed using a `let' form
- Print snd.
- snd = fun (A B : Set) (H : A * B) => let (_, y) := H in y : forall A B : Set, A * B -> B Arguments snd (_ _)%type_scope _
- Remove Printing Let prod.
- Unset Printing Synth.
- Unset Printing Wildcard.
- Print snd.
- snd = fun (A B : Set) (H : A * B) => match H return B with | (x, y) => y end : forall A B : Set, A * B -> B Arguments snd (_ _)%type_scope _
Conventions about unused pattern-matching variables¶
Pattern-matching variables that are not used on the right-hand side of => are
considered the sign of a potential error. For instance, it could
result from an undetected misspelled constant constructor. By default,
a warning is issued in such situations.
-
Warning
Unused variable ident catches more than one case.¶ This indicates that an unused pattern variable
identoccurs in a pattern-matching clause used to complete at least two cases of the pattern-matching problem.The warning can be deactivated by using a variable name starting with
_or by settingSet Warnings "-unused-pattern-matching-variable".Here is an example where the warning is activated.
Example
- Set Warnings "-unused-pattern-matching-variable".
- Definition is_zero (o : option nat) := match o with | Some 0 => true | x => false end.
- is_zero is defined
- Set Warnings "+unused-pattern-matching-variable".
Patterns¶
The full syntax of match is presented in Definition by cases: match.
Identifiers in patterns are either constructor names or variables. Any
identifier that is not the constructor of an inductive or co-inductive
type is considered to be a variable. A variable name cannot occur more
than once in a given pattern. It is recommended to start variable
names by a lowercase letter.
If a pattern has the form c x where c is a constructor symbol and x
is a linear vector of (distinct) variables, it is called simple: it
is the kind of pattern recognized by the basic version of match. On
the opposite, if it is a variable x or has the form c p with p not
only made of variables, the pattern is called nested.
A variable pattern matches any value, and the identifier is bound to
that value. The pattern “_” (called “don't care” or “wildcard” symbol)
also matches any value, but does not bind anything. It may occur an
arbitrary number of times in a pattern. Alias patterns written
(pattern as ident) are also accepted. This pattern matches the
same values as pattern does and ident is bound to the matched
value. A pattern of the form pattern | pattern is called disjunctive. A
list of patterns separated with commas is also considered as a pattern
and is called multiple pattern. However multiple patterns can only
occur at the root of pattern matching equations. Disjunctions of
multiple patterns are allowed though.
Since extended match expressions are compiled into the primitive ones,
the expressiveness of the theory remains the same. Once parsing has finished
only simple patterns remain. The original nesting of the match expressions
is recovered at printing time. An easy way to see the result
of the expansion is to toggle off the nesting performed at printing
(use here Printing Matching), then by printing the term with Print
if the term is a constant, or using the command Check.
The extended match still accepts an optional elimination predicate
given after the keyword return. Given a pattern matching expression,
if all the right-hand-sides of => have the same
type, then this type can be sometimes synthesized, and so we can omit
the return part. Otherwise the predicate after return has to be
provided, like for the basicmatch.
Let us illustrate through examples the different aspects of extended pattern matching. Consider for example the function that computes the maximum of two natural numbers. We can write it in primitive syntax by:
- Fixpoint max (n m:nat) {struct m} : nat := match n with | O => m | S n' => match m with | O => S n' | S m' => S (max n' m') end end.
- max is defined max is recursively defined (guarded on 2nd argument)
Multiple patterns¶
Using multiple patterns in the definition of max lets us write:
- Fixpoint max (n m:nat) {struct m} : nat := match n, m with | O, _ => m | S n', O => S n' | S n', S m' => S (max n' m') end.
- max is defined max is recursively defined (guarded on 2nd argument)
which will be compiled into the previous form.
The pattern matching compilation strategy examines patterns from left to right. A match expression is generated only when there is at least one constructor in the column of patterns. E.g. the following example does not build a match expression.
- Check (fun x:nat => match x return nat with | y => y end).
- fun x : nat => x : nat -> nat
Aliasing subpatterns¶
We can also use as ident to associate a name to a sub-pattern:
- Fixpoint max (n m:nat) {struct n} : nat := match n, m with | O, _ => m | S n' as p, O => p | S n', S m' => S (max n' m') end.
- max is defined max is recursively defined (guarded on 1st argument)
Nested patterns¶
Here is now an example of nested patterns:
- Fixpoint even (n:nat) : bool := match n with | O => true | S O => false | S (S n') => even n' end.
- even is defined even is recursively defined (guarded on 1st argument)
This is compiled into:
- Unset Printing Matching.
- Print even.
- even = fix even (n : nat) : bool := match n with | 0 => true | S n0 => match n0 with | 0 => false | S n' => even n' end end : nat -> bool Arguments even _%nat_scope
- Set Printing Matching.
In the previous examples patterns do not conflict with, but sometimes
it is comfortable to write patterns that admit a non trivial
superposition. Consider the boolean function lef that given two
natural numbers yields true if the first one is less or equal than the
second one and false otherwise. We can write it as follows:
- Fixpoint lef (n m:nat) {struct m} : bool := match n, m with | O, x => true | x, O => false | S n, S m => lef n m end.
- lef is defined lef is recursively defined (guarded on 2nd argument)
Note that the first and the second multiple pattern overlap because
the couple of values O O matches both. Thus, what is the result of the
function on those values? To eliminate ambiguity we use the textual
priority rule: we consider patterns to be ordered from top to bottom. A
value is matched by the pattern at the ith row if and only if it is
not matched by some pattern from a previous row. Thus in the example, O O
is matched by the first pattern, and so (lef O O) yields true.
Another way to write this function is:
- Fixpoint lef (n m:nat) {struct m} : bool := match n, m with | O, x => true | S n, S m => lef n m | _, _ => false end.
- lef is defined lef is recursively defined (guarded on 2nd argument)
Here the last pattern superposes with the first two. Because of the priority rule, the last pattern will be used only for values that do not match neither the first nor the second one.
Terms with useless patterns are not accepted by the system. Here is an example:
- Fail Check (fun x:nat => match x with | O => true | S _ => false | x => true end).
- The command has indeed failed with message: Pattern "x" is redundant in this clause.
Disjunctive patterns¶
Multiple patterns that share the same right-hand-side can be
factorized using the notation pattern+,+|. For
instance, max can be rewritten as follows:
- Fixpoint max (n m:nat) {struct m} : nat := match n, m with | S n', S m' => S (max n' m') | 0, p | p, 0 => p end.
- max is defined max is recursively defined (guarded on 2nd argument)
Similarly, factorization of (not necessarily multiple) patterns that
share the same variables is possible by using the notation pattern+|.
Here is an example:
- Definition filter_2_4 (n:nat) : nat := match n with | 2 as m | 4 as m => m | _ => 0 end.
- filter_2_4 is defined
Nested disjunctive patterns are allowed, inside parentheses, with the
notation (pattern+|), as in:
- Definition filter_some_square_corners (p:nat*nat) : nat*nat := match p with | ((2 as m | 4 as m), (3 as n | 5 as n)) => (m,n) | _ => (0,0) end.
- filter_some_square_corners is defined
About patterns of parametric types¶
Parameters in patterns¶
When matching objects of a parametric type, parameters do not bind in
patterns. They must be substituted by “_”. Consider for example the
type of polymorphic lists:
- Inductive List (A:Set) : Set := | nil : List A | cons : A -> List A -> List A.
- List is defined List_rect is defined List_ind is defined List_rec is defined List_sind is defined
We can check the function tail:
- Check (fun l:List nat => match l with | nil _ => nil nat | cons _ _ l' => l' end).
- fun l : List nat => match l with | nil _ => nil nat | cons _ _ l' => l' end : List nat -> List nat
When we use parameters in patterns there is an error message:
- Fail Check (fun l:List nat => match l with | nil A => nil nat | cons A _ l' => l' end).
- The command has indeed failed with message: The parameters do not bind in patterns; they must be replaced by '_'.
-
Flag
Asymmetric Patterns¶ This flag (off by default) removes parameters from constructors in patterns:
- Set Asymmetric Patterns.
- Check (fun l:List nat => match l with | nil => nil _ | cons _ l' => l' end).
- fun l : List nat => match l with | @nil _ => nil nat | @cons _ _ l' => l' end : List nat -> List nat
- Unset Asymmetric Patterns.
Implicit arguments in patterns¶
By default, implicit arguments are omitted in patterns. So we write:
- Arguments nil {A}.
- Arguments cons [A] _ _.
- Check (fun l:List nat => match l with | nil => nil | cons _ l' => l' end).
- fun l : List nat => match l with | nil => nil | cons _ l' => l' end : List nat -> List nat
But the possibility to use all the arguments is given by “@” implicit
explicitations (as for terms, see Explicit applications).
- Check (fun l:List nat => match l with | @nil _ => @nil nat | @cons _ _ l' => l' end).
- fun l : List nat => match l with | nil => nil | cons _ l' => l' end : List nat -> List nat
Matching objects of dependent types¶
The previous examples illustrate pattern matching on objects of non-
dependent types, but we can also use the expansion strategy to
destructure objects of dependent types. Consider the type listn of
lists of a certain length:
- Inductive listn : nat -> Set := | niln : listn 0 | consn : forall n:nat, nat -> listn n -> listn (S n).
- listn is defined listn_rect is defined listn_ind is defined listn_rec is defined listn_sind is defined
Understanding dependencies in patterns¶
We can define the function length over listn by:
Just for illustrating pattern matching, we can define it by case analysis:
- Definition length (n:nat) (l:listn n) := match l with | niln => 0 | consn n _ _ => S n end.
- length is defined
We can understand the meaning of this definition using the same notions of usual pattern matching.
When the elimination predicate must be provided¶
Dependent pattern matching¶
The examples given so far do not need an explicit elimination
predicate because all the right hand sides have the same type and Coq
succeeds to synthesize it. Unfortunately when dealing with dependent
patterns it often happens that we need to write cases where the types
of the right hand sides are different instances of the elimination predicate. The
function concat for listn is an example where the branches have
different types and we need to provide the elimination predicate:
- Fixpoint concat (n:nat) (l:listn n) (m:nat) (l':listn m) {struct l} : listn (n + m) := match l in listn n return listn (n + m) with | niln => l' | consn n' a y => consn (n' + m) a (concat n' y m l') end.
- concat is defined concat is recursively defined (guarded on 2nd argument)
- Reset concat.
The elimination predicate is fun (n:nat) (l:listn n) => listn (n+m).
In general if m has type (I q1 … qr t1 … ts) where q1, …, qr
are parameters, the elimination predicate should be of the form fun y1 … ys x : (I q1 … qr y1 … ys ) => Q.
In the concrete syntax, it should be written :
match m as x in (I _ … _ y1 … ys) return Q with … end.
The variables which appear in the in and as clause are new and bounded
in the property Q in the return clause. The parameters of the
inductive definitions should not be mentioned and are replaced by _.
Multiple dependent pattern matching¶
Recall that a list of patterns is also a pattern. So, when we
destructure several terms at the same time and the branches have
different types we need to provide the elimination predicate for this
multiple pattern. It is done using the same scheme: each term may be
associated with an as clause and an in clause in order to introduce
a dependent product.
For example, an equivalent definition for concat (even though the
matching on the second term is trivial) would have been:
- Fixpoint concat (n:nat) (l:listn n) (m:nat) (l':listn m) {struct l} : listn (n + m) := match l in listn n, l' return listn (n + m) with | niln, x => x | consn n' a y, x => consn (n' + m) a (concat n' y m x) end.
- concat is defined concat is recursively defined (guarded on 2nd argument)
Even without real matching over the second term, this construction can
be used to keep types linked. If a and b are two listn of the same
length, by writing
- Check (fun n (a b: listn n) => match a, b with | niln, b0 => tt | consn n' a y, bS => tt end).
- fun (n : nat) (a _ : listn n) => match a with | niln | _ => tt end : forall n : nat, listn n -> listn n -> unit
we have a copy of b in type listn 0 resp. listn (S n').
Patterns in in¶
If the type of the matched term is more precise than an inductive
applied to variables, arguments of the inductive in the in branch can
be more complicated patterns than a variable.
Moreover, constructors whose types do not follow the same pattern will become impossible branches. In an impossible branch, you can answer anything but False_rect unit has the advantage to be subterm of anything.
To be concrete: the tail function can be written:
- Definition tail n (v: listn (S n)) := match v in listn (S m) return listn m with | niln => False_rect unit | consn n' a y => y end.
- tail is defined
and tail n v will be subterm of v.
Using pattern matching to write proofs¶
In all the previous examples the elimination predicate does not depend
on the object(s) matched. But it may depend and the typical case is
when we write a proof by induction or a function that yields an object
of a dependent type. An example of a proof written using match is given
in the description of the tactic refine.
For example, we can write the function buildlist that given a natural
number n builds a list of length n containing zeros as follows:
- Fixpoint buildlist (n:nat) : listn n := match n return listn n with | O => niln | S n => consn n 0 (buildlist n) end.
- buildlist is defined buildlist is recursively defined (guarded on 1st argument)
We can also use multiple patterns. Consider the following definition
of the predicate less-equal Le:
- Inductive LE : nat -> nat -> Prop := | LEO : forall n:nat, LE 0 n | LES : forall n m:nat, LE n m -> LE (S n) (S m).
- LE is defined LE_ind is defined LE_sind is defined
We can use multiple patterns to write the proof of the lemma
forall (n m:nat), (LE n m) \/ (LE m n):
- Fixpoint dec (n m:nat) {struct n} : LE n m \/ LE m n := match n, m return LE n m \/ LE m n with | O, x => or_introl (LE x 0) (LEO x) | x, O => or_intror (LE x 0) (LEO x) | S n as n', S m as m' => match dec n m with | or_introl h => or_introl (LE m' n') (LES n m h) | or_intror h => or_intror (LE n' m') (LES m n h) end end.
- dec is defined dec is recursively defined (guarded on 1st argument)
In the example of dec, the first match is dependent while the second
is not.
The user can also use match in combination with the tactic refine
to build incomplete proofs beginning with a match construction.
Pattern-matching on inductive objects involving local definitions¶
If local definitions occur in the type of a constructor, then there are two ways to match on this constructor. Either the local definitions are skipped and matching is done only on the true arguments of the constructors, or the bindings for local definitions can also be caught in the matching.
Example
- Inductive list : nat -> Set := | nil : list 0 | cons : forall n:nat, let m := (2 * n) in list m -> list (S (S m)).
- list is defined list_rect is defined list_ind is defined list_rec is defined list_sind is defined
In the next example, the local definition is not caught.
- Fixpoint length n (l:list n) {struct l} : nat := match l with | nil => 0 | cons n l0 => S (length (2 * n) l0) end.
- length is defined length is recursively defined (guarded on 2nd argument)
But in this example, it is.
- Fixpoint length' n (l:list n) {struct l} : nat := match l with | nil => 0 | @cons _ m l0 => S (length' m l0) end.
- length' is defined length' is recursively defined (guarded on 2nd argument)
Note
For a given matching clause, either none of the local definitions or all of them can be caught.
Note
You can only catch let bindings in mode where you bind all
variables and so you have to use @ syntax.
Note
this feature is incoherent with the fact that parameters cannot be caught and consequently is somehow hidden. For example, there is no mention of it in error messages.
Pattern-matching and coercions¶
If a mismatch occurs between the expected type of a pattern and its actual type, a coercion made from constructors is sought. If such a coercion can be found, it is automatically inserted around the pattern.
Example
- Inductive I : Set := | C1 : nat -> I | C2 : I -> I.
- I is defined I_rect is defined I_ind is defined I_rec is defined I_sind is defined
- Coercion C1 : nat >-> I.
- C1 is now a coercion
- Check (fun x => match x with | C2 O => 0 | _ => 0 end).
- fun x : I => match x with | C1 _ | _ => 0 end : I -> nat
When does the expansion strategy fail?¶
The strategy works very like in ML languages when treating patterns of non-dependent types. But there are new cases of failure that are due to the presence of dependencies.
The error messages of the current implementation may be sometimes
confusing. When the tactic fails because patterns are somehow
incorrect then error messages refer to the initial expression. But the
strategy may succeed to build an expression whose sub-expressions are
well typed when the whole expression is not. In this situation the
message makes reference to the expanded expression. We encourage
users, when they have patterns with the same outer constructor in
different equations, to name the variable patterns in the same
positions with the same name. E.g. to write (cons n O x) => e1 and
(cons n _ x) => e2 instead of (cons n O x) => e1 and
(cons n' _ x') => e2. This helps to maintain certain name correspondence between the
generated expression and the original.
Here is a summary of the error messages corresponding to each situation:
-
Error
The constructor ident expects natural arguments.¶ -
Error
The variable ident is bound several times in pattern term¶ -
Error
Found a constructor of inductive type term while a constructor of term is expected¶ Patterns are incorrect (because constructors are not applied to the correct number of arguments, because they are not linear or they are wrongly typed).
-
Error
Non exhaustive pattern matching.¶ The pattern matching is not exhaustive.