File: mk_intconst.doc

package info (click to toggle)
hol-light 20131026-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 26,264 kB
  • ctags: 4,620
  • sloc: ml: 400,325; cpp: 438; java: 279; lisp: 261; makefile: 256; sh: 190; yacc: 108; perl: 78; ansic: 57; sed: 39
file content (30 lines) | stat: -rw-r--r-- 728 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_intconst

\TYPE {mk_intconst : num -> term}

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

\DESCRIBE
The call {mk_intconst n} where {n} is an OCaml number (type {num}) produces
the canonical integer literal of type {:int} 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_intconst (Int (-101));;
  val it : term = `-- &101`

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

\SEEALSO
dest_intconst, is_intconst, mk_realintconst.

\ENDDOC