<!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="BatText.html">
<link rel="next" href="BatUChar.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 : BatTuple</title>
</head>
<body>
<div class="navbar"><a class="pre" href="BatText.html" title="BatText">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="BatUChar.html" title="BatUChar">Next</a>
</div>
<h1>Module <a href="type_BatTuple.html">BatTuple</a></h1>
<pre><span class="keyword">module</span> BatTuple: <code class="code"><span class="keyword">sig</span></code> <a href="BatTuple.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
Tuples.
<p>
NOTE: API changes are expected in a future release.
<p>
Modules are provided for tuples with 2, 3, 4, and 5
elements. Each provides the following categories of functions.
<p>
Projection. Functions <code class="code">first</code>, <code class="code">second</code>, <code class="code">third</code>, <code class="code">fourth</code>, and <code class="code">fifth</code>
extract a single element. Also, multiple elements can be
extracted. For example, <a href="BatTuple.Tuple3.html#VALget13"><code class="code"><span class="constructor">BatTuple</span>.<span class="constructor">Tuple3</span>.get13</code></a> returns the first and
third elements of a 3-tuple. All possible combinations are
provided.
<p>
Note there are no <code class="code">get</code> functions in Tuple2 because <code class="code">first</code> and
<code class="code">second</code> already cover all possibilities. However, <code class="code">swap</code> is
provided, which can be thought of as projecting items in a
different order.
<p>
Mapping. Apply a function to one or all elements of a
tuple. Functions <code class="code">map1</code>, <code class="code">map2</code>, etc. map a given function to the
first, second, etc. element of a tuple. All elements can be mapped
using <code class="code">map</code> or <code class="code">mapn</code>. For example, <a href="BatTuple.Tuple3.html#VALmap"><code class="code"><span class="constructor">BatTuple</span>.<span class="constructor">Tuple3</span>.map</code></a> <code class="code">f g h</code> will
apply <code class="code">f</code>, <code class="code">g</code>, and <code class="code">h</code> to the three elements, respectively, of a
3-tuple. Function <code class="code">mapn</code> is similar but applies the same function
to all elements, which thus requires the elements to be of the
same type.
<p>
Currying. Every tuple has a <code class="code">curry</code> and <code class="code">uncurry</code> function, which
allow converting between functions that take <code class="code">n</code> arguments to ones
that take a single <code class="code">n</code>-tuple argument.
<p>
Enumeration. Every <code class="code">n</code>-tuple can be converted to an enum with <code class="code">n</code>
elements using its <code class="code">enum</code> function, and can be constructed from an
enum using <code class="code">of_enum</code>. Tuples satisfy <a href="BatEnum.Enumerable.html"><code class="code"><span class="constructor">BatEnum</span>.<span class="constructor">Enumerable</span></code></a>.
<p>
Printing. Function <code class="code">print</code> prints a tuple given a method for
printing each of its elements. The simpler <code class="code">printn</code> function can
be used when all elements are of the same type.
<p>
Comparison. Every tuple has a <code class="code">compare</code> function, which can
optionally be customized by specifying methods for comparing each
element. <code class="code"><span class="constructor">Pervasives</span>.compare</code> is used by default.<br>
</div>
<hr width="100%">
<pre><span class="keyword">module</span> <a href="BatTuple.Tuple2.html">Tuple2</a>: <code class="code"><span class="keyword">sig</span></code> <a href="BatTuple.Tuple2.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Pairs.
</div>
<pre><span class="keyword">module</span> <a href="BatTuple.Tuple3.html">Tuple3</a>: <code class="code"><span class="keyword">sig</span></code> <a href="BatTuple.Tuple3.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Triples.
</div>
<pre><span class="keyword">module</span> <a href="BatTuple.Tuple4.html">Tuple4</a>: <code class="code"><span class="keyword">sig</span></code> <a href="BatTuple.Tuple4.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
4-Tuples.
</div>
<pre><span class="keyword">module</span> <a href="BatTuple.Tuple5.html">Tuple5</a>: <code class="code"><span class="keyword">sig</span></code> <a href="BatTuple.Tuple5.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
5-Tuples.
</div>
</body></html>
