File: check.doc

package info (click to toggle)
hol-light 20230128-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 45,636 kB
  • sloc: ml: 688,681; cpp: 439; makefile: 302; lisp: 286; java: 279; sh: 251; yacc: 108; perl: 78; ansic: 57; sed: 39; python: 13
file content (31 lines) | stat: -rw-r--r-- 609 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
\DOC check

\TYPE {check : ('a -> bool) -> 'a -> 'a}

\SYNOPSIS
Checks that a value satisfies a predicate.

\DESCRIBE
{check p x} returns {x} if the application {p x} yields {true}. Otherwise,
{check p x} fails.

\FAILURE
{check p x} fails with {Failure "check"} if the predicate {p} yields
{false} when applied to the value {x}.

\EXAMPLE
{
  # check is_var `x:bool`;;
  val it : term = `x`
  # check is_var `x + 2`;;
  Exception: Failure "check".
}

\USES
Can be used to filter out candidates from a set of terms, e.g. to apply
theorem-tactics to assumptions with a certain pattern.

\SEEALSO
can.

\ENDDOC