File: mk_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 (30 lines) | stat: -rw-r--r-- 756 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
28
29
30
\DOC mk_realintconst

\TYPE {mk_realintconst : num -> term}

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

\DESCRIBE
The call {mk_realintconst n} where {n} is an OCaml number (type {num}) produces
the canonical literal of type {:real} representing the integer {n}. This will
be of the form `{&m}' for a numeral {m} (when {n} is nonnegative) or `{-- &m}'
for a nonzero numeral {m} (when {n} is negative).

\FAILURE
Fails if applied to a number that is not an integer (type {num} also includes 
rational numbers).

\EXAMPLE
{
  # mk_realintconst (Int (-101));;
  val it : term = `-- &101`

  # type_of it;;
  val it : hol_type = `:real`
}

\SEEALSO
dest_realintconst, is_realintconst, mk_intconst, rat_of_term.

\ENDDOC