summaryrefslogtreecommitdiff
path: root/doc/Calendar.Precise.html
blob: ec57f49c43d813a80caf8583bd177604a465b33b (plain)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
<!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="Calendar.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="Datatypes" rel="Section" href="#2_Datatypes">
<link title="Constructors" rel="Section" href="#2_Constructors">
<link title="Conversions" rel="Section" href="#2_Conversions">
<link title="Getters" rel="Section" href="#2_Getters">
<link title="Calendars are comparable" rel="Section" href="#2_Calendarsarecomparable">
<link title="Coercions" rel="Section" href="#2_Coercions">
<link title="Period" rel="Section" href="#2_Period">
<link title="Arithmetic operations on calendars and periods" rel="Section" href="#2_Arithmeticoperationsoncalendarsandperiods">
<title>Calendar.Precise</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="Calendar.html" title="Calendar">Up</a>
&nbsp;</div>
<h1>Module <a href="type_Calendar.Precise.html">Calendar.Precise</a></h1>
<pre><span class="keyword">module</span> Precise: <code class="type"><a href="Calendar_sig.S.html">Calendar_sig.S</a></code><code class="type">  with module Date = Date and module Time = Time</code></pre><div class="info">
More precise implementation of calendar in which seconds are integer.<br>
<b>Since</b> 2.0<br>
</div>
<hr width="100%">
<br>
<h2 id="2_Datatypes">Datatypes</h2><br>
<pre><span class="keyword">module</span> <a href="Calendar_sig.S.Date.html">Date</a>: <code class="type"><a href="Date_sig.S.html">Date_sig.S</a></code><code class="type"> </code></pre><div class="info">
Date implementation used by this calendar.
</div>
<pre><span class="keyword">module</span> <a href="Calendar_sig.S.Time.html">Time</a>: <code class="type"><a href="Time_sig.S.html">Time_sig.S</a></code><code class="type"> </code></pre><div class="info">
Time implementation used by this calendar.
</div>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>

<pre><span id="TYPEday"><span class="keyword">type</span> <code class="type"></code>day</span> = <code class="type">Date.day</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTday.Sun"><span class="constructor">Sun</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTday.Mon"><span class="constructor">Mon</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTday.Tue"><span class="constructor">Tue</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTday.Wed"><span class="constructor">Wed</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTday.Thu"><span class="constructor">Thu</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTday.Fri"><span class="constructor">Fri</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTday.Sat"><span class="constructor">Sat</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Days of the week.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>


<pre><span id="TYPEmonth"><span class="keyword">type</span> <code class="type"></code>month</span> = <code class="type">Date.month</code> = </pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Jan"><span class="constructor">Jan</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Feb"><span class="constructor">Feb</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Mar"><span class="constructor">Mar</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Apr"><span class="constructor">Apr</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.May"><span class="constructor">May</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Jun"><span class="constructor">Jun</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Jul"><span class="constructor">Jul</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Aug"><span class="constructor">Aug</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Sep"><span class="constructor">Sep</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Oct"><span class="constructor">Oct</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Nov"><span class="constructor">Nov</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmonth.Dec"><span class="constructor">Dec</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Months of the year.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>


<pre><span id="TYPEyear"><span class="keyword">type</span> <code class="type"></code>year</span> = <code class="type">Date.year</code> </pre>
<div class="info">
Year as an int<br>
</div>

<pre><span id="TYPEsecond"><span class="keyword">type</span> <code class="type"></code>second</span> = <code class="type">Time.second</code> </pre>

<pre><span id="TYPEfield"><span class="keyword">type</span> <code class="type"></code>field</span> = <code class="type">[ `Day | `Hour | `Minute | `Month | `Second | `Week | `Year ]</code> </pre>
<div class="info">
The different fields of a calendar.<br>
</div>

<br>
<h2 id="2_Constructors">Constructors</h2><br>
<pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">int -> int -> int -> int -> int -> <a href="Calendar_sig.S.html#TYPEsecond">second</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">make year month day hour minute second</code> makes the calendar
	"year-month-day; hour-minute-second".<br>
<b>Raises</b><ul><li><code>D.Out_of_bounds</code> when a date is outside the Julian period.</li>
<li><code>D.Undefined</code> when a date belongs to <code class="code">[<span class="constructor">October</span> 5th, 1582; <span class="constructor">October</span>
	14th, 1582]</code>.</li>
</ul>
</div>
<pre><span id="VALlmake"><span class="keyword">val</span> lmake</span> : <code class="type">year:int -><br>       ?month:int -><br>       ?day:int -><br>       ?hour:int -><br>       ?minute:int -> ?second:<a href="Calendar_sig.S.html#TYPEsecond">second</a> -> unit -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
Labelled version of <code class="code">make</code>.
	The default value of <code class="code">month</code> and <code class="code">day</code> (resp. of <code class="code">hour</code>, <code class="code">minute</code>
	and <code class="code">second</code>) is <code class="code">1</code> (resp. <code class="code">0</code>).<br>
<b>Since</b> 1.05<br>
<b>Raises</b><ul><li><code>D.Out_of_bounds</code> when a date is outside the Julian period.</li>
<li><code>D.Undefined</code> when a date belongs to <code class="code">[<span class="constructor">October</span> 5th, 1582; <span class="constructor">October</span>
	14th, 1582]</code>.</li>
</ul>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">Date.t -> Time.t -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">create d t</code> creates a calendar from the given date and time.<br>
</div>
<pre><span id="VALnow"><span class="keyword">val</span> now</span> : <code class="type">unit -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">now ()</code> returns the current date and time (in the current time
	zone).<br>
</div>
<pre><span id="VALfrom_jd"><span class="keyword">val</span> from_jd</span> : <code class="type">float -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
Return the Julian day.
	More precise than <code class="code"><span class="constructor">Date</span>.from_jd</code>: the fractional part represents the
	time.<br>
</div>
<pre><span id="VALfrom_mjd"><span class="keyword">val</span> from_mjd</span> : <code class="type">float -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
Return the Modified Julian day.
	It is <code class="code"><span class="constructor">Julian</span> day - 2 400 000.5</code> (more precise than <code class="code"><span class="constructor">Date</span>.from_mjd</code>).<br>
</div>
<br>
<h2 id="2_Conversions">Conversions</h2><br>
<br>
Those functions have the same behaviour as those defined in
       <a href="Time_sig.S.html"><code class="code"><span class="constructor">Time_sig</span>.<span class="constructor">S</span></code></a>.<br>
<pre><span id="VALconvert"><span class="keyword">val</span> convert</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Time_Zone.html#TYPEt">Time_Zone.t</a> -> <a href="Time_Zone.html#TYPEt">Time_Zone.t</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALconvert">Time_sig.S.convert</a><br>
</div>
<pre><span id="VALto_gmt"><span class="keyword">val</span> to_gmt</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALto_gmt">Time_sig.S.to_gmt</a><br>
</div>
<pre><span id="VALfrom_gmt"><span class="keyword">val</span> from_gmt</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALfrom_gmt">Time_sig.S.from_gmt</a><br>
</div>
<br>
<h2 id="2_Getters">Getters</h2><br>
<br>
Those functions have the same behavious as those defined in
      <a href="Date_sig.S.html"><code class="code"><span class="constructor">Date_sig</span>.<span class="constructor">S</span></code></a>.<br>
<pre><span id="VALdays_in_month"><span class="keyword">val</span> days_in_month</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALdays_in_month">Date_sig.S.days_in_month</a><br>
</div>
<pre><span id="VALday_of_week"><span class="keyword">val</span> day_of_week</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEday">day</a></code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALdays_of_week">Date_sig.S.days_of_week</a><br>
</div>
<pre><span id="VALday_of_month"><span class="keyword">val</span> day_of_month</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALdays_of_month">Date_sig.S.days_of_month</a><br>
</div>
<pre><span id="VALday_of_year"><span class="keyword">val</span> day_of_year</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALdays_of_year">Date_sig.S.days_of_year</a><br>
</div>
<pre><span id="VALweek"><span class="keyword">val</span> week</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALweek">Date_sig.S.week</a><br>
</div>
<pre><span id="VALmonth"><span class="keyword">val</span> month</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEmonth">month</a></code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALmonth">Date_sig.S.month</a><br>
</div>
<pre><span id="VALyear"><span class="keyword">val</span> year</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALyear">Date_sig.S.year</a><br>
</div>
<br>
<code class="code">to_jd</code> and <code class="code">to_mjd</code> are more precise than <a href="Date_sig.S.html#VALto_jd"><code class="code"><span class="constructor">Date_sig</span>.<span class="constructor">S</span>.to_jd</code></a> and
      <a href="Date_sig.S.html#VALto_mjd"><code class="code"><span class="constructor">Date_sig</span>.<span class="constructor">S</span>.to_mjd</code></a>.<br>
<pre><span id="VALto_jd"><span class="keyword">val</span> to_jd</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> float</code></pre><pre><span id="VALto_mjd"><span class="keyword">val</span> to_mjd</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> float</code></pre><br>
Those functions have the same behavious as those defined in
      <a href="Time_sig.S.html"><code class="code"><span class="constructor">Time_sig</span>.<span class="constructor">S</span></code></a>.<br>
<pre><span id="VALhour"><span class="keyword">val</span> hour</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALhour">Time_sig.S.hour</a><br>
</div>
<pre><span id="VALminute"><span class="keyword">val</span> minute</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALminute">Time_sig.S.minute</a><br>
</div>
<pre><span id="VALsecond"><span class="keyword">val</span> second</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEsecond">second</a></code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALsecond">Time_sig.S.second</a><br>
</div>
<br>
<h2 id="2_Calendarsarecomparable">Calendars are comparable</h2><br>
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a> -> bool</code></pre><div class="info">
Equality function between two calendars.<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="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
Comparison function between two calendars.<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="Calendar_sig.S.html#TYPEt">t</a> -> int</code></pre><div class="info">
Hash function for calendars.<br>
<b>Since</b> 2.0<br>
<b>See also</b> <a href="Utils.Comparable.html#VALhash">Utils.Comparable.hash.</a><br>
</div>
<br>
Those functions have the same behavious as those defined in
      <a href="Date_sig.S.html"><code class="code"><span class="constructor">Date_sig</span>.<span class="constructor">S</span></code></a>.<br>
<pre><span id="VALis_leap_day"><span class="keyword">val</span> is_leap_day</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> bool</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALis_leap_day">Date_sig.S.is_leap_day</a><br>
</div>
<pre><span id="VALis_gregorian"><span class="keyword">val</span> is_gregorian</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> bool</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALis_gregorian">Date_sig.S.is_gregorian</a><br>
</div>
<pre><span id="VALis_julian"><span class="keyword">val</span> is_julian</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> bool</code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALis_julian">Date_sig.S.is_julian</a><br>
</div>
<br>
Those functions have the same behavious as those defined in
      <a href="Time_sig.S.html"><code class="code"><span class="constructor">Time_sig</span>.<span class="constructor">S</span></code></a>.<br>
<pre><span id="VALis_pm"><span class="keyword">val</span> is_pm</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> bool</code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALis_pm">Time_sig.S.is_pm</a><br>
</div>
<pre><span id="VALis_am"><span class="keyword">val</span> is_am</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> bool</code></pre><div class="info">
<b>See also</b> <a href="Time_sig.S.html#VALis_am">Time_sig.S.is_am</a><br>
</div>
<br>
<h2 id="2_Coercions">Coercions</h2><br>
<pre><span id="VALto_unixtm"><span class="keyword">val</span> to_unixtm</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> Unix.tm</code></pre><div class="info">
Convert a calendar into the <code class="code">unix.tm</code> type.
	The field <code class="code">isdst</code> is always <code class="code"><span class="keyword">false</span></code>. More precise than
	<a href="Date_sig.S.html#VALto_unixtm"><code class="code"><span class="constructor">Date_sig</span>.<span class="constructor">S</span>.to_unixtm</code></a>.<br>
<b>Since</b> 1.01<br>
</div>
<pre><span id="VALfrom_unixtm"><span class="keyword">val</span> from_unixtm</span> : <code class="type">Unix.tm -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
Inverse of <code class="code">to_unixtm</code>. Assumes the current time zone.
	So, The following invariant holds:
	<code class="code">hour (from_unixtm u) = u.<span class="constructor">Unix</span>.tm_hour</code>.<br>
<b>Since</b> 1.01<br>
</div>
<pre><span id="VALto_unixfloat"><span class="keyword">val</span> to_unixfloat</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> float</code></pre><div class="info">
Convert a calendar to a float such than
	<code class="code">to_unixfloat (make 1970 1 1 0 0 0)</code> returns <code class="code">0.0</code> at UTC.
	So such a float is convertible with those of the module <code class="code"><span class="constructor">Unix</span></code>.
	More precise than <a href="Date_sig.S.html#VALto_unixfloat"><code class="code"><span class="constructor">Date_sig</span>.<span class="constructor">S</span>.to_unixfloat</code></a>.<br>
<b>Since</b> 1.01<br>
</div>
<pre><span id="VALfrom_unixfloat"><span class="keyword">val</span> from_unixfloat</span> : <code class="type">float -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
Inverse of <code class="code">to_unixfloat</code>. Assumes the current time zone.
	So, the following invariant holds:
	<code class="code">hour (from_unixfloat u) = (<span class="constructor">Unix</span>.gmtime u).<span class="constructor">Unix</span>.tm_hour</code>.<br>
<b>Since</b> 1.01<br>
</div>
<pre><span id="VALfrom_date"><span class="keyword">val</span> from_date</span> : <code class="type">Date.t -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
Convert a date to a calendar.
	The time is midnight in the current time zone.<br>
</div>
<pre><span id="VALto_date"><span class="keyword">val</span> to_date</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> Date.t</code></pre><div class="info">
Convert a calendar to a date. Time part of the calendar is ignored.<br>
</div>
<pre><span id="VALto_time"><span class="keyword">val</span> to_time</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> Time.t</code></pre><div class="info">
Convert a calendar to a time. Date part of the calendar is ignored.<br>
<b>Since</b> 1.03<br>
</div>
<br>
<h2 id="2_Period">Period</h2><br>
<pre><span class="keyword">module</span> <a href="Calendar_sig.S.Period.html">Period</a>: <code class="code"><span class="keyword">sig</span></code> <a href="Calendar_sig.S.Period.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
A period is the number of seconds between two calendars.
</div>
<br>
<h2 id="2_Arithmeticoperationsoncalendarsandperiods">Arithmetic operations on calendars and periods</h2><br>
<br>
Those functions have the same behavious as those defined in
      <a href="Date_sig.S.html"><code class="code"><span class="constructor">Date_sig</span>.<span class="constructor">S</span></code></a>.<br>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -><br>       [< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Calendar_sig.S.Period.html#TYPEperiod">Period.period</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALadd">Date_sig.S.add</a><br>
</div>
<pre><span id="VALsub"><span class="keyword">val</span> sub</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -><br>       <a href="Calendar_sig.S.html#TYPEt">t</a> -><br>       [< <a href="Period.html#TYPEdate_field">Period.date_field</a> > `Day `Week ] <a href="Calendar_sig.S.Period.html#TYPEperiod">Period.period</a></code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALsub">Date_sig.S.sub</a><br>
</div>
<pre><span id="VALprecise_sub"><span class="keyword">val</span> precise_sub</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.Period.html#TYPEt">Period.t</a></code></pre><div class="info">
<b>Since</b> 2.03<br>
<b>See also</b> <a href="Date_sig.S.html#VALprecise_sub">Date_sig.S.precise_sub</a><br>
</div>
<pre><span id="VALrem"><span class="keyword">val</span> rem</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -><br>       [< <a href="Period.html#TYPEdate_field">Period.date_field</a> ] <a href="Calendar_sig.S.Period.html#TYPEperiod">Period.period</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALrem">Date_sig.S.rem</a><br>
</div>
<pre><span id="VALnext"><span class="keyword">val</span> next</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEfield">field</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALnext">Date_sig.S.next</a><br>
</div>
<pre><span id="VALprev"><span class="keyword">val</span> prev</span> : <code class="type"><a href="Calendar_sig.S.html#TYPEt">t</a> -> <a href="Calendar_sig.S.html#TYPEfield">field</a> -> <a href="Calendar_sig.S.html#TYPEt">t</a></code></pre><div class="info">
<b>See also</b> <a href="Date_sig.S.html#VALprev">Date_sig.S.prev</a><br>
</div>
</body></html>