File: dest_realintconst.doc

package info (click to toggle)
hol-light 20170109-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 36,568 kB
  • ctags: 8,549
  • sloc: ml: 540,018; cpp: 439; lisp: 286; java: 279; makefile: 262; sh: 229; yacc: 108; perl: 78; ansic: 57; sed: 39
file content (27 lines) | stat: -rw-r--r-- 653 bytes parent folder | download | duplicates (4)
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_realintconst

\TYPE {dest_realintconst : term -> num}

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

\DESCRIBE
The call {dest_realintconst t} where {t} is a canonical integer literal of type
{:real}, 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 
{:real}.

\EXAMPLE
{
  # dest_realintconst `-- &27 :real`;;
  val it : num = -27
}

\SEEALSO
dest_intconst, is_realintconst, mk_realintconst, rat_of_term.

\ENDDOC