doc/Period.S.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

<!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">&nbsp;<a href="Period.html">Up</a>
&nbsp;</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 id="TYPEperiod"><span class="keyword">type</span> <code class="type">+[< <a href="Period.html#TYPEdate_field">Period.date_field</a> ]</code> period</span> </pre>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type"><a href="Period.html#TYPEdate_field">Period.date_field</a> <a href="Period.S.html#TYPEperiod">period</a></code> </pre>
<div class="info">
Type of a period.<br>
</div>

<br>
<span id="3_Periodisanadditivemonoid"><h3>Period is an additive monoid</h3></span><br>
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">[< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Period.S.html#TYPEperiod">period</a></code></pre><div class="info">
The empty period.<br>
</div>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">([< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] as 'a) <a href="Period.S.html#TYPEperiod">period</a> -><br>       'a <a href="Period.S.html#TYPEperiod">period</a> -> 'a <a href="Period.S.html#TYPEperiod">period</a></code></pre><div class="info">
Addition of periods.<br>
</div>
<pre><span id="VALsub"><span class="keyword">val</span> sub</span> : <code class="type">([< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] as 'a) <a href="Period.S.html#TYPEperiod">period</a> -><br>       'a <a href="Period.S.html#TYPEperiod">period</a> -> 'a <a href="Period.S.html#TYPEperiod">period</a></code></pre><div class="info">
Substraction of periods.<br>
</div>
<pre><span id="VALopp"><span class="keyword">val</span> opp</span> : <code class="type">([< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] as 'a) <a href="Period.S.html#TYPEperiod">period</a> -> 'a <a href="Period.S.html#TYPEperiod">period</a></code></pre><div class="info">
Opposite of a period.<br>
</div>
<br>
<span id="3_Periodsarecomparable"><h3>Periods are comparable</h3></span><br>
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">[< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Period.S.html#TYPEperiod">period</a> -><br>       [< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Period.S.html#TYPEperiod">period</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 id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type">[< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Period.S.html#TYPEperiod">period</a> -><br>       [< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Period.S.html#TYPEperiod">period</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 id="VALhash"><span class="keyword">val</span> hash</span> : <code class="type">[< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Period.S.html#TYPEperiod">period</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>