<!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="BatNum.html">
<link rel="next" href="BatOo.html">
<link rel="Up" href="index.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"><title>Batteries user guide : BatNumber</title>
</head>
<body>
<div class="navbar"><a class="pre" href="BatNum.html" title="BatNum">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="BatOo.html" title="BatOo">Next</a>
</div>
<h1>Module <a href="type_BatNumber.html">BatNumber</a></h1>
<pre><span class="keyword">module</span> BatNumber: <code class="code"><span class="keyword">sig</span></code> <a href="BatNumber.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
A common interface for numbers.<br>
<b>Author(s):</b> Gabriel Scherer, David Teller<br>
</div>
<hr width="100%">
<pre><span id="EXCEPTIONOverflow"><span class="keyword">exception</span> Overflow</span></pre>
<div class="info ">
Arithmetic overflow.
<p>
This kind of exception is raised by "safe" numeric modules whenever
the number which should be returned is too large to be represented.
<p>
Non-"safe" numeric modules will return a result which depends on
the internal representation. For instance, with module <code class="code"><span class="constructor">Int</span></code>,
<code class="code">max_num + 1</code> returns <code class="code">min_num</code>. By opposition, with module
<code class="code"><span class="constructor">Safe_int</span></code>, <code class="code">max_num + 1</code> raises <code class="code"><span class="constructor">Overflow</span></code>.<br>
</div>
<pre><span id="EXCEPTIONNaN"><span class="keyword">exception</span> NaN</span></pre>
<div class="info ">
Not a Number
<p>
This kind of exception is raised by "safe" modules whenever the
number which should be returned is not a number.
<p>
For instance, with module <code class="code"><span class="constructor">Safe_float</span></code>, <code class="code">0.0 / 0.0</code> raises <code class="code"><span class="constructor">NaN</span></code>.
By opposition, with module <code class="code"><span class="constructor">Float</span></code>, <code class="code">0.0 / 0.0</code> does not interrupt
computation and returns a special value <code class="code">nan</code>.<br>
</div>
<pre><code><span id="TYPEnumeric"><span class="keyword">type</span> <code class="type">'a</code> numeric</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.zero">zero</span> : <code class="type">'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.one">one</span> : <code class="type">'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.neg">neg</span> : <code class="type">'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.succ">succ</span> : <code class="type">'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.pred">pred</span> : <code class="type">'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.abs">abs</span> : <code class="type">'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.add">add</span> : <code class="type">'a -> 'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.sub">sub</span> : <code class="type">'a -> 'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.mul">mul</span> : <code class="type">'a -> 'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.div">div</span> : <code class="type">'a -> 'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.modulo">modulo</span> : <code class="type">'a -> 'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.pow">pow</span> : <code class="type">'a -> 'a -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.compare">compare</span> : <code class="type">'a -> 'a -> int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.of_int">of_int</span> : <code class="type">int -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.to_int">to_int</span> : <code class="type">'a -> int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.of_string">of_string</span> : <code class="type">string -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.to_string">to_string</span> : <code class="type">'a -> string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.of_float">of_float</span> : <code class="type">float -> 'a</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnumeric.to_float">to_float</span> : <code class="type">'a -> float</code>;</code></td>
</tr></table>
}
<div class="info ">
The smallest set of operations supported by every set of numbers.
<p>
This is presented as record to permit lightweight typeclass-style
computation.<br>
</div>
<pre><span class="keyword">module type</span> <a href="BatNumber.Infix.html">Infix</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatNumber.Infix.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
The infix operators available with any type of numbers
</div>
<pre><span class="keyword">module type</span> <a href="BatNumber.Compare.html">Compare</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatNumber.Compare.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
And if you are ready to drop generic comparison operators,
then you can open this one as well
</div>
<pre><span class="keyword">module type</span> <a href="BatNumber.RefOps.html">RefOps</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatNumber.RefOps.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Reference operators ala C.
</div>
<pre><span class="keyword">module type</span> <a href="BatNumber.Numeric.html">Numeric</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatNumber.Numeric.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
The full set of operations of a type of numbers
</div>
<pre><span class="keyword">module type</span> <a href="BatNumber.Bounded.html">Bounded</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatNumber.Bounded.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>
<pre><span class="keyword">module type</span> <a href="BatNumber.Discrete.html">Discrete</a> = <code class="code"><span class="keyword">sig</span></code> <a href="BatNumber.Discrete.html">..</a> <code class="code"><span class="keyword">end</span></code></pre></body></html>
