<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="BatInt.Compare.html">
<link rel="Up" href="BatInt.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="BatArray" rel="Chapter" href="BatArray.html">
<link title="BatAvlTree" rel="Chapter" href="BatAvlTree.html">
<link title="BatBase64" rel="Chapter" href="BatBase64.html">
<link title="BatBig_int" rel="Chapter" href="BatBig_int.html">
<link title="BatBigarray" rel="Chapter" href="BatBigarray.html">
<link title="BatBitSet" rel="Chapter" href="BatBitSet.html">
<link title="BatBool" rel="Chapter" href="BatBool.html">
<link title="BatBounded" rel="Chapter" href="BatBounded.html">
<link title="BatBuffer" rel="Chapter" href="BatBuffer.html">
<link title="BatCache" rel="Chapter" href="BatCache.html">
<link title="BatChar" rel="Chapter" href="BatChar.html">
<link title="BatCharParser" rel="Chapter" href="BatCharParser.html">
<link title="BatComplex" rel="Chapter" href="BatComplex.html">
<link title="BatConcurrent" rel="Chapter" href="BatConcurrent.html">
<link title="BatDeque" rel="Chapter" href="BatDeque.html">
<link title="BatDigest" rel="Chapter" href="BatDigest.html">
<link title="BatDllist" rel="Chapter" href="BatDllist.html">
<link title="BatDynArray" rel="Chapter" href="BatDynArray.html">
<link title="BatEnum" rel="Chapter" href="BatEnum.html">
<link title="BatFile" rel="Chapter" href="BatFile.html">
<link title="BatFingerTree" rel="Chapter" href="BatFingerTree.html">
<link title="BatFloat" rel="Chapter" href="BatFloat.html">
<link title="BatFormat" rel="Chapter" href="BatFormat.html">
<link title="BatGc" rel="Chapter" href="BatGc.html">
<link title="BatGenlex" rel="Chapter" href="BatGenlex.html">
<link title="BatGlobal" rel="Chapter" href="BatGlobal.html">
<link title="BatHashcons" rel="Chapter" href="BatHashcons.html">
<link title="BatHashtbl" rel="Chapter" href="BatHashtbl.html">
<link title="BatHeap" rel="Chapter" href="BatHeap.html">
<link title="BatIMap" rel="Chapter" href="BatIMap.html">
<link title="BatIO" rel="Chapter" href="BatIO.html">
<link title="BatISet" rel="Chapter" href="BatISet.html">
<link title="BatInnerIO" rel="Chapter" href="BatInnerIO.html">
<link title="BatInnerPervasives" rel="Chapter" href="BatInnerPervasives.html">
<link title="BatInnerWeaktbl" rel="Chapter" href="BatInnerWeaktbl.html">
<link title="BatInt" rel="Chapter" href="BatInt.html">
<link title="BatInt32" rel="Chapter" href="BatInt32.html">
<link title="BatInt64" rel="Chapter" href="BatInt64.html">
<link title="BatInterfaces" rel="Chapter" href="BatInterfaces.html">
<link title="BatLazyList" rel="Chapter" href="BatLazyList.html">
<link title="BatLexing" rel="Chapter" href="BatLexing.html">
<link title="BatList" rel="Chapter" href="BatList.html">
<link title="BatLog" rel="Chapter" href="BatLog.html">
<link title="BatLogger" rel="Chapter" href="BatLogger.html">
<link title="BatMap" rel="Chapter" href="BatMap.html">
<link title="BatMarshal" rel="Chapter" href="BatMarshal.html">
<link title="BatMultiMap" rel="Chapter" href="BatMultiMap.html">
<link title="BatMultiPMap" rel="Chapter" href="BatMultiPMap.html">
<link title="BatMutex" rel="Chapter" href="BatMutex.html">
<link title="BatNativeint" rel="Chapter" href="BatNativeint.html">
<link title="BatNum" rel="Chapter" href="BatNum.html">
<link title="BatNumber" rel="Chapter" href="BatNumber.html">
<link title="BatOo" rel="Chapter" href="BatOo.html">
<link title="BatOptParse" rel="Chapter" href="BatOptParse.html">
<link title="BatOption" rel="Chapter" href="BatOption.html">
<link title="BatOrd" rel="Chapter" href="BatOrd.html">
<link title="BatParserCo" rel="Chapter" href="BatParserCo.html">
<link title="BatPathGen" rel="Chapter" href="BatPathGen.html">
<link title="BatPervasives" rel="Chapter" href="BatPervasives.html">
<link title="BatPrintexc" rel="Chapter" href="BatPrintexc.html">
<link title="BatPrintf" rel="Chapter" href="BatPrintf.html">
<link title="BatQueue" rel="Chapter" href="BatQueue.html">
<link title="BatRMutex" rel="Chapter" href="BatRMutex.html">
<link title="BatRandom" rel="Chapter" href="BatRandom.html">
<link title="BatRef" rel="Chapter" href="BatRef.html">
<link title="BatRefList" rel="Chapter" href="BatRefList.html">
<link title="BatResult" rel="Chapter" href="BatResult.html">
<link title="BatReturn" rel="Chapter" href="BatReturn.html">
<link title="BatScanf" rel="Chapter" href="BatScanf.html">
<link title="BatSeq" rel="Chapter" href="BatSeq.html">
<link title="BatSet" rel="Chapter" href="BatSet.html">
<link title="BatSplay" rel="Chapter" href="BatSplay.html">
<link title="BatStack" rel="Chapter" href="BatStack.html">
<link title="BatStream" rel="Chapter" href="BatStream.html">
<link title="BatString" rel="Chapter" href="BatString.html">
<link title="BatSubstring" rel="Chapter" href="BatSubstring.html">
<link title="BatSys" rel="Chapter" href="BatSys.html">
<link title="BatText" rel="Chapter" href="BatText.html">
<link title="BatTuple" rel="Chapter" href="BatTuple.html">
<link title="BatUChar" rel="Chapter" href="BatUChar.html">
<link title="BatUTF8" rel="Chapter" href="BatUTF8.html">
<link title="BatUnit" rel="Chapter" href="BatUnit.html">
<link title="BatUnix" rel="Chapter" href="BatUnix.html">
<link title="BatUref" rel="Chapter" href="BatUref.html">
<link title="BatVect" rel="Chapter" href="BatVect.html">
<link title="Batteries" rel="Chapter" href="Batteries.html">
<link title="BatteriesConfig" rel="Chapter" href="BatteriesConfig.html">
<link title="BatteriesPrint" rel="Chapter" href="BatteriesPrint.html">
<link title="BatteriesThread" rel="Chapter" href="BatteriesThread.html">
<link title="Extlib" rel="Chapter" href="Extlib.html"><link title="Submodules regrouping all infix operations on safe integers" rel="Section" href="#6_Submodulesregroupingallinfixoperationsonsafeintegers">
<link title="Boilerplate code" rel="Section" href="#6_Boilerplatecode">
<title>Batteries user guide : BatInt.Safe_int</title>
</head>
<body>
<div class="navbar"><a class="pre" href="BatInt.Compare.html" title="BatInt.Compare">Previous</a>
<a class="up" href="BatInt.html" title="BatInt">Up</a>
</div>
<h1>Module <a href="type_BatInt.Safe_int.html">BatInt.Safe_int</a></h1>
<pre><span class="keyword">module</span> Safe_int: <code class="code"><span class="keyword">sig</span></code> <a href="BatInt.Safe_int.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
Safe operations on integers.
<p>
This module provides operations on the type <code class="code">int</code> of
integers. Values of this type may be either 31 bits on 32-bit
processors or 63 bits on 64-bit processors. Operations which
overflow raise exception <code class="code"><span class="constructor">Number</span>.<span class="constructor">Overflow</span></code>.
<p>
This module implements <code class="code"><span class="constructor">Number</span>.<span class="constructor">Numeric</span></code>,
<code class="code"><span class="constructor">Number</span>.<span class="constructor">Bounded</span></code>, <code class="code"><span class="constructor">Number</span>.<span class="constructor">Discrete</span></code>.
<p>
<b>Important note</b> Untested.<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type">int</code> </pre>
<div class="info ">
An alias for the type of integers.<br>
</div>
<pre><span id="VALzero"><span class="keyword">val</span> zero</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
The integer <code class="code">0</code>.<br>
</div>
<pre><span id="VALone"><span class="keyword">val</span> one</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
The integer <code class="code">1</code>.<br>
</div>
<pre><span id="VALminus_one"><span class="keyword">val</span> minus_one</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
The integer <code class="code">-1</code>.<br>
</div>
<pre><span id="VALneg"><span class="keyword">val</span> neg</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Unary negation.<br>
</div>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Addition.<br>
</div>
<pre><span id="VAL(+)"><span class="keyword">val</span> (+)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Addition.<br>
</div>
<pre><span id="VALsub"><span class="keyword">val</span> sub</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Substraction.<br>
</div>
<pre><span id="VAL(-)"><span class="keyword">val</span> (-)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Substraction.<br>
</div>
<pre><span id="VALmul"><span class="keyword">val</span> mul</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Multiplication.<br>
</div>
<pre><span id="VAL( * )"><span class="keyword">val</span> ( * )</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Multiplication.<br>
</div>
<pre><span id="VALdiv"><span class="keyword">val</span> div</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Integer division.
This division rounds the real quotient of
its arguments towards zero, as specified for <code class="code"><span class="constructor">Pervasives</span>.(/)</code>.<br>
<b>Raises</b> <code>Division_by_zero</code> if the second argument is zero.<br>
</div>
<pre><span id="VAL(/)"><span class="keyword">val</span> (/)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Integer division. This division rounds the real quotient of
its arguments towards zero, as specified for <code class="code"><span class="constructor">Pervasives</span>.(/)</code>.<br>
<b>Raises</b> <code>Division_by_zero</code> if the second argument is zero.<br>
</div>
<pre><span id="VALrem"><span class="keyword">val</span> rem</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Integer remainder. If <code class="code">y</code> is not zero, the result
of <code class="code"><span class="constructor">Int</span>.rem x y</code> satisfies the following property:
<code class="code">x = <span class="constructor">Int</span>.add (<span class="constructor">Int</span>.mul (<span class="constructor">Int</span>.div x y) y) (<span class="constructor">Int</span>.rem x y)</code>.<br>
<b>Raises</b> <code>Division_by_zero</code> if the second argument is zero.<br>
</div>
<pre><span id="VALmodulo"><span class="keyword">val</span> modulo</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">modulo a b</code> computes the remainder of the integer
division of <code class="code">a</code> by <code class="code">b</code>. This is defined only if <code class="code">b <> 0</code>.
<p>
The result of <code class="code">modulo a b</code> is a number <code class="code">m</code> between
<code class="code">0</code> and <code class="code">abs ( b - 1 )</code> if <code class="code">a >= 0</code> or between <code class="code"><span class="keywordsign">~-</span> ( abs ( b - 1 ) ) </code>
if <code class="code">a < 0</code> and such that <code class="code">a * k + (abs b) = m</code>,
for some <code class="code">k</code>.<br>
</div>
<pre><span id="VALpow"><span class="keyword">val</span> pow</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">pow a b</code> computes a<sup class="superscript">b</sup>.<br>
<b>Raises</b> <code>Invalid_argument</code> when <code class="code">b</code> is negative.<br>
</div>
<pre><span id="VAL( ** )"><span class="keyword">val</span> ( ** )</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">a ** b</code> computes a<sup class="superscript">b</sup><br>
</div>
<pre><span id="VAL(<>)"><span class="keyword">val</span> (<>)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
Comparaison: <code class="code">a <> b</code> is true if and only if <code class="code">a</code> and <code class="code">b</code> have
different values.<br>
</div>
<pre><span id="VAL(>)"><span class="keyword">val</span> (>)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
Comparaison: <code class="code">a > b</code> is true if and only if <code class="code">a</code> is strictly greater than <code class="code">b</code>.<br>
</div>
<pre><span id="VAL(<)"><span class="keyword">val</span> (<)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
Comparaison: <code class="code">a < b</code> is true if and only if <code class="code">a</code> is strictly smaller than <code class="code">b</code>.<br>
</div>
<pre><span id="VAL(>=)"><span class="keyword">val</span> (>=)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
Comparaison: <code class="code">a >= b</code> is true if and only if <code class="code">a</code> is greater or equal to <code class="code">b</code>.<br>
</div>
<pre><span id="VAL(<=)"><span class="keyword">val</span> (<=)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
Comparaison: <code class="code">a <= b</code> is true if and only if <code class="code">a</code> is smaller or equalto <code class="code">b</code>.<br>
</div>
<pre><span id="VAL(=)"><span class="keyword">val</span> (=)</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
Comparaison: <code class="code">a = b</code> if and only if <code class="code">a</code> and <code class="code">b</code> have the same value.<br>
</div>
<pre><span id="VALmax_num"><span class="keyword">val</span> max_num</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
The greatest representable integer, which is either 2<sup class="superscript">30</sup>-1 or 2<sup class="superscript">62</sup>-1.<br>
</div>
<pre><span id="VALmin_num"><span class="keyword">val</span> min_num</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
The smallest representable integer, -2<sup class="superscript">30</sup> or 2<sup class="superscript">62</sup>.<br>
</div>
<pre><span id="VALsucc"><span class="keyword">val</span> succ</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Successor. <code class="code">succ x</code> is <code class="code">add x one</code>.<br>
</div>
<pre><span id="VALpred"><span class="keyword">val</span> pred</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Predecessor. <code class="code">pred x</code> is <code class="code">sub x one</code>.<br>
</div>
<pre><span id="VALabs"><span class="keyword">val</span> abs</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Return the absolute value of its argument.<br>
</div>
<pre><span id="VALof_float"><span class="keyword">val</span> of_float</span> : <code class="type">float -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Convert the given floating-point number to integer,
discarding the fractional part (truncate towards 0).
The result of the conversion is undefined if, after truncation,
the number is outside the range [<code class="code"><span class="constructor">Int</span>.min_int</code>, <code class="code"><span class="constructor">Int</span>.max_int</code>].<br>
</div>
<pre><span id="VALto_float"><span class="keyword">val</span> to_float</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> float</code></pre><div class="info ">
Convert the given integer to a floating-point number.<br>
</div>
<pre><span id="VALof_string"><span class="keyword">val</span> of_string</span> : <code class="type">string -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre><div class="info ">
Convert the given string to an integer
The string is read in decimal (by default) or in hexadecimal,
octal or binary if the string begins with <code class="code">0x</code>, <code class="code">0o</code> or <code class="code">0b</code>
respectively.<br>
<b>Raises</b> <code>Invalid_argument</code> if the given string is not
a valid representation of an integer, or if the integer represented
exceeds the range of integers representable in type <code class="code">int</code>.<br>
</div>
<pre><span id="VALto_string"><span class="keyword">val</span> to_string</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> string</code></pre><div class="info ">
Return the string representation of its argument, in signed decimal.<br>
</div>
<pre><span id="VALoperations"><span class="keyword">val</span> operations</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> <a href="BatNumber.html#TYPEnumeric">BatNumber.numeric</a></code></pre>
<pre><span id="VALof_int"><span class="keyword">val</span> of_int</span> : <code class="type">int -> <a href="BatInt.Safe_int.html#TYPEt">t</a></code></pre>
<pre><span id="VALto_int"><span class="keyword">val</span> to_int</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> int</code></pre><br>
<h6 id="6_Submodulesregroupingallinfixoperationsonsafeintegers">Submodules regrouping all infix operations on safe integers</h6><br>
<pre><span class="keyword">module</span> <a href="BatInt.Safe_int.Infix.html">Infix</a>: <code class="type"><a href="BatNumber.Infix.html">BatNumber.Infix</a></code><code class="type"> with type bat__infix_t = t</code></pre>
<pre><span class="keyword">module</span> <a href="BatInt.Safe_int.Compare.html">Compare</a>: <code class="type"><a href="BatNumber.Compare.html">BatNumber.Compare</a></code><code class="type"> with type bat__compare_t = t</code></pre><br>
<h6 id="6_Boilerplatecode">Boilerplate code</h6><br>
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type">'a <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> unit</code></pre>
<pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> int</code></pre><div class="info ">
The comparison function for integers, with the same specification as
<code class="code"><span class="constructor">Pervasives</span>.compare</code>. Along with the type <code class="code">t</code>, this function <code class="code">compare</code>
allows the module <code class="code"><span class="constructor">Int</span></code> to be passed as argument to the functors
<code class="code"><span class="constructor">Set</span>.<span class="constructor">Make</span></code> and <code class="code"><span class="constructor">Map</span>.<span class="constructor">Make</span></code>.<br>
</div>
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
Equality function for integers, useful for <code class="code"><span class="constructor">HashedType</span></code>.<br>
</div>
<pre><span id="VALord"><span class="keyword">val</span> ord</span> : <code class="type"><a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatInt.Safe_int.html#TYPEt">t</a> -> <a href="BatOrd.html#TYPEorder">BatOrd.order</a></code></pre></body></html>
