<!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="Batteries.Int.html"> <link rel="next" href="Batteries.Unit.html"> <link rel="Up" href="Batteries.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 grouping all infix operators" rel="Section" href="#6_Submodulesgroupingallinfixoperators"> <link title="Boilerplate code" rel="Section" href="#6_Boilerplatecode"> <title>Batteries user guide : Batteries.Bool</title> </head> <body> <div class="navbar"><a class="pre" href="Batteries.Int.html" title="Batteries.Int">Previous</a> <a class="up" href="Batteries.html" title="Batteries">Up</a> <a class="post" href="Batteries.Unit.html" title="Batteries.Unit">Next</a> </div> <h1>Module <a href="type_Batteries.Bool.html">Batteries.Bool</a></h1> <pre><span class="keyword">module</span> Bool: <code class="type">BatBool</code></pre><hr width="100%"> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type">bool</code> </pre> <div class="info "> The type of booleans. Formally, this is defined as <code class="code"><span class="keyword">type</span> t = <span class="keyword">true</span> <span class="keywordsign">|</span> <span class="keyword">false</span></code><br> </div> <pre><span id="VALnot"><span class="keyword">val</span> not</span> : <code class="type">bool -> bool</code></pre><div class="info "> The boolean negation.<br> </div> <pre><span id="VAL(&&)"><span class="keyword">val</span> (&&)</span> : <code class="type">bool -> bool -> bool</code></pre><div class="info "> The boolean ``and''. Evaluation is sequential, left-to-right: in <code class="code">e1 <span class="keywordsign">&&</span> e2</code>, <code class="code">e1</code> is evaluated first, and if it returns <code class="code"><span class="keyword">false</span></code>, <code class="code">e2</code> is not evaluated at all.<br> </div> <pre><span id="VAL(||)"><span class="keyword">val</span> (||)</span> : <code class="type">bool -> bool -> bool</code></pre><div class="info "> The boolean ``or''. Evaluation is sequential, left-to-right: in <code class="code">e1 <span class="keywordsign">||</span> e2</code>, <code class="code">e1</code> is evaluated first, and if it returns <code class="code"><span class="keyword">true</span></code>, <code class="code">e2</code> is not evaluated at all.<br> </div> <pre><span id="VALzero"><span class="keyword">val</span> zero</span> : <code class="type">bool</code></pre> <pre><span id="VALone"><span class="keyword">val</span> one</span> : <code class="type">bool</code></pre> <pre><span id="VALneg"><span class="keyword">val</span> neg</span> : <code class="type">bool -> bool</code></pre> <pre><span id="VALsucc"><span class="keyword">val</span> succ</span> : <code class="type">bool -> bool</code></pre> <pre><span id="VALpred"><span class="keyword">val</span> pred</span> : <code class="type">bool -> bool</code></pre> <pre><span id="VALabs"><span class="keyword">val</span> abs</span> : <code class="type">bool -> bool</code></pre> <pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">bool -> bool -> bool</code></pre> <pre><span id="VALmul"><span class="keyword">val</span> mul</span> : <code class="type">bool -> bool -> bool</code></pre> <pre><span id="VALsub"><span class="keyword">val</span> sub</span> : <code class="type">bool -> bool -> bool</code></pre> <pre><span id="VALdiv"><span class="keyword">val</span> div</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VALmodulo"><span class="keyword">val</span> modulo</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VALpow"><span class="keyword">val</span> pow</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VALmin_num"><span class="keyword">val</span> min_num</span> : <code class="type">bool</code></pre> <pre><span id="VALmax_num"><span class="keyword">val</span> max_num</span> : <code class="type">bool</code></pre> <pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type">bool -> bool -> int</code></pre> <pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">bool -> bool -> bool</code></pre> <pre><span id="VALord"><span class="keyword">val</span> ord</span> : <code class="type">bool -> bool -> <a href="BatOrd.html#TYPEorder">BatOrd.order</a></code></pre> <pre><span id="VALof_int"><span class="keyword">val</span> of_int</span> : <code class="type">int -> bool</code></pre><div class="info "> anything but <code class="code">0</code> is <code class="code"><span class="keyword">true</span></code><br> </div> <pre><span id="VALto_int"><span class="keyword">val</span> to_int</span> : <code class="type">bool -> int</code></pre> <pre><span id="VALof_string"><span class="keyword">val</span> of_string</span> : <code class="type">string -> bool</code></pre><div class="info "> Convert the given string to a boolean.<br> <b>Raises</b> <code>Invalid_argument</code> if the string is not <code class="code"><span class="string">"true"</span></code>, <code class="code"><span class="string">"false"</span></code>, <code class="code"><span class="string">"0"</span></code>, <code class="code"><span class="string">"1"</span></code>, <code class="code"><span class="string">"tt"</span></code> or <code class="code"><span class="string">"ff"</span></code>.<br> </div> <pre><span id="VALto_string"><span class="keyword">val</span> to_string</span> : <code class="type">bool -> string</code></pre> <pre><span id="VALof_float"><span class="keyword">val</span> of_float</span> : <code class="type">float -> bool</code></pre><div class="info "> <code class="code">0.</code>, <code class="code">nan</code> <code class="code">+infinity</code> and <code class="code">-infiity</code> are <code class="code"><span class="keyword">false</span></code>. The other values convert to <code class="code"><span class="keyword">true</span></code><br> </div> <pre><span id="VALto_float"><span class="keyword">val</span> to_float</span> : <code class="type">bool -> float</code></pre> <pre><span id="VAL(+)"><span class="keyword">val</span> (+)</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VAL(-)"><span class="keyword">val</span> (-)</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VAL( * )"><span class="keyword">val</span> ( * )</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VAL(/)"><span class="keyword">val</span> (/)</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VAL( ** )"><span class="keyword">val</span> ( ** )</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a></code></pre> <pre><span id="VAL(--)"><span class="keyword">val</span> (--)</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> <a href="BatEnum.html#TYPEt">BatEnum.t</a></code></pre> <pre><span id="VAL(---)"><span class="keyword">val</span> (---)</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> -> <a href="BatBool.html#TYPEt">t</a> <a href="BatEnum.html#TYPEt">BatEnum.t</a></code></pre> <pre><span id="VALoperations"><span class="keyword">val</span> operations</span> : <code class="type"><a href="BatBool.html#TYPEt">t</a> <a href="BatNumber.html#TYPEnumeric">BatNumber.numeric</a></code></pre><br> <h6 id="6_Submodulesgroupingallinfixoperators">Submodules grouping all infix operators</h6><br> <pre><span class="keyword">module</span> <a href="BatBool.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="BatBool.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="BatBool.html#TYPEt">t</a> -> unit</code></pre><div class="info "> <div class="h7" id="7_Printing">Printing</div><br> </div> </body></html>