File: dest_intconst.doc

package info (click to toggle)
hol-light 20120602-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 23,452 kB
  • sloc: ml: 348,797; cpp: 438; java: 279; makefile: 252; sh: 183; yacc: 108; perl: 78; ansic: 57; sed: 39
file content (27 lines) | stat: -rw-r--r-- 615 bytes parent folder | download | duplicates (7)
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
\DOC dest_intconst

\TYPE {dest_intconst : term -> num}

\SYNOPSIS
Converts an integer literal of type {:int} to an OCaml number.

\DESCRIBE
The call {dest_intconst t} where {t} is a canonical integer literal of type
{:int}, returns the corresponding OCaml number (type {num}). The permissible
forms of integer literals are `{&n}' for a numeral {n} or `{-- &n}' for a
nonzero numeral {n}.

\FAILURE
Fails if applied to a term that is not a canonical integer literal of type
{:int}.

\EXAMPLE
{
  # dest_intconst `-- &11 :int`;;
  val it : num = -11
}

\SEEALSO
dest_realintconst, is_intconst, mk_intconst.

\ENDDOC