<!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="Up" href="Period.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 modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="Utils" rel="Chapter" href="Utils.html"> <link title="Time_Zone" rel="Chapter" href="Time_Zone.html"> <link title="Period" rel="Chapter" href="Period.html"> <link title="Time_sig" rel="Chapter" href="Time_sig.html"> <link title="Time" rel="Chapter" href="Time.html"> <link title="Ftime" rel="Chapter" href="Ftime.html"> <link title="Date_sig" rel="Chapter" href="Date_sig.html"> <link title="Date" rel="Chapter" href="Date.html"> <link title="Calendar_sig" rel="Chapter" href="Calendar_sig.html"> <link title="Calendar_builder" rel="Chapter" href="Calendar_builder.html"> <link title="Calendar" rel="Chapter" href="Calendar.html"> <link title="Fcalendar" rel="Chapter" href="Fcalendar.html"> <link title="Printer" rel="Chapter" href="Printer.html"> <link title="Version" rel="Chapter" href="Version.html"><link title="Period is an additive monoid" rel="Section" href="#3_Periodisanadditivemonoid"> <link title="Periods are comparable" rel="Section" href="#3_Periodsarecomparable"> <title>Period.S</title> </head> <body> <div class="navbar"> <a href="Period.html">Up</a> </div> <center><h1>Module type <a href="type_Period.S.html">Period.S</a></h1></center> <br> <pre><span class="keyword">module type</span> S = <code class="code"><span class="keyword">sig</span></code> <a href="Period.S.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Common interface for all periods.<br> <hr width="100%"> <pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre> <div class="info"> Type of a period.<br> </div> <br> <a name="3_Periodisanadditivemonoid"></a> <h3>Period is an additive monoid</h3><br> <pre><span class="keyword">val</span> <a name="VALempty"></a>empty : <code class="type"><a href="Period.S.html#TYPEt">t</a></code></pre><div class="info"> The empty period.<br> </div> <pre><span class="keyword">val</span> <a name="VALadd"></a>add : <code class="type"><a href="Period.S.html#TYPEt">t</a> -> <a href="Period.S.html#TYPEt">t</a> -> <a href="Period.S.html#TYPEt">t</a></code></pre><div class="info"> Addition of periods.<br> </div> <pre><span class="keyword">val</span> <a name="VALsub"></a>sub : <code class="type"><a href="Period.S.html#TYPEt">t</a> -> <a href="Period.S.html#TYPEt">t</a> -> <a href="Period.S.html#TYPEt">t</a></code></pre><div class="info"> Substraction of periods.<br> </div> <pre><span class="keyword">val</span> <a name="VALopp"></a>opp : <code class="type"><a href="Period.S.html#TYPEt">t</a> -> <a href="Period.S.html#TYPEt">t</a></code></pre><div class="info"> Opposite of a period.<br> </div> <br> <a name="3_Periodsarecomparable"></a> <h3>Periods are comparable</h3><br> <pre><span class="keyword">val</span> <a name="VALequal"></a>equal : <code class="type"><a href="Period.S.html#TYPEt">t</a> -> <a href="Period.S.html#TYPEt">t</a> -> bool</code></pre><div class="info"> Equality function between two periods.<br> <b>Since</b> 1.09.0<br> <b>See also</b> <a href="Utils.Comparable.html#VALequal">Utils.Comparable.equal</a><br> </div> <pre><span class="keyword">val</span> <a name="VALcompare"></a>compare : <code class="type"><a href="Period.S.html#TYPEt">t</a> -> <a href="Period.S.html#TYPEt">t</a> -> int</code></pre><div class="info"> Comparison function between two periods.<br> <b>See also</b> <a href="Utils.Comparable.html#VALcompare">Utils.Comparable.compare</a><br> </div> <pre><span class="keyword">val</span> <a name="VALhash"></a>hash : <code class="type"><a href="Period.S.html#TYPEt">t</a> -> int</code></pre><div class="info"> Hash function for periods.<br> <b>Since</b> 2.0<br> <b>See also</b> <a href="Utils.Comparable.html#VALhash">Utils.Comparable.hash</a><br> </div> </body></html>