File: assert.doc

package info (click to toggle)
hol88 2.02.19940316dfsg-5
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 65,816 kB
  • sloc: ml: 199,939; ansic: 9,666; sh: 6,913; makefile: 6,032; lisp: 2,747; yacc: 894; sed: 201; cpp: 87; awk: 5
file content (33 lines) | stat: -rw-r--r-- 500 bytes parent folder | download | duplicates (11) 
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
32
33
 
\DOC assert

\TYPE {assert : ((* -> bool) -> * -> *)}

\SYNOPSIS
Checks that a value satisfies a predicate.

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

\FAILURE
{assert p x} fails with the string {`fail`} if the predicate {p} yields
{false} when applied to the value {x}.

\EXAMPLE
{
#null [];;
true : bool

#assert null [];;
[] : * list

#null [1];;
false : bool

#assert null [1];;
evaluation failed     fail
}
\SEEALSO
can.

\ENDDOC