Common operations for all calendar representations.
DatatypesDate implementation used by this calendar.
Time implementation used by this calendar.
type day = Date.day =
| Sun
| Mon
| Tue
| Wed
| Thu
| Fri
| Sat
type month = Date.month =
| Jan
| Feb
| Mar
| Apr
| May
| Jun
| Jul
| Aug
| Sep
| Oct
| Nov
| Dec
The different fields of a calendar.
Constructorsval make : int -> int -> int -> int -> int -> second -> t
make year month day hour minute second
makes the calendar "year-month-day; hour-minute-second".
val lmake :
year :int ->
?month :int ->
?day :int ->
?hour :int ->
?minute :int ->
?second :second ->
unit ->
t
Labelled version of make
. The default value of month
and day
(resp. of hour
, minute
and second
) is 1
(resp. 0
).
create d t
creates a calendar from the given date and time.
now ()
returns the current date and time (in the current time zone).
Return the Julian day. More precise than Date.from_jd
: the fractional part represents the time.
val from_mjd : float -> t
Return the Modified Julian day. It is Julian day - 2 400 000.5
(more precise than Date.from_mjd
).
ConversionsThose functions have the same behaviour as those defined in Time_sig.S
.
GettersThose functions have the same behavious as those defined in Date_sig.S
.
val days_in_month : t -> int
val day_of_week : t -> day
val day_of_month : t -> int
val day_of_year : t -> int
to_jd
and to_mjd
are more precise than Date_sig.S.to_jd
and Date_sig.S.to_mjd
.
Those functions have the same behavious as those defined in Time_sig.S
.
Calendars are comparableval equal : t -> t -> bool
Equality function between two calendars.
val compare : t -> t -> int
Comparison function between two calendars.
Hash function for calendars.
Those functions have the same behavious as those defined in Date_sig.S
.
val is_leap_day : t -> bool
val is_gregorian : t -> bool
val is_julian : t -> bool
Those functions have the same behavious as those defined in Time_sig.S
.
Coercionsval to_unixtm : t -> Unix .tm
Convert a calendar into the unix.tm
type. The field isdst
is always false
. More precise than Date_sig.S.to_unixtm
.
val from_unixtm : Unix .tm -> t
Inverse of to_unixtm
. Assumes the current time zone. So, The following invariant holds: hour (from_unixtm u) = u.Unix.tm_hour
.
val to_unixfloat : t -> float
Convert a calendar to a float such than to_unixfloat (make 1970 1 1 0 0 0)
returns 0.0
at UTC. So such a float is convertible with those of the module Unix
. More precise than Date_sig.S.to_unixfloat
.
val from_unixfloat : float -> t
Inverse of to_unixfloat
. Assumes the current time zone. So, the following invariant holds: hour (from_unixfloat u) = (Unix.gmtime u).Unix.tm_hour
.
Convert a date to a calendar. The time is midnight in the current time zone.
Convert a calendar to a date. Time part of the calendar is ignored.
Convert a calendar to a time. Date part of the calendar is ignored.
PeriodA period is the number of seconds between two calendars.
Arithmetic operations on calendars and periodsThose functions have the same behavious as those defined in Date_sig.S
.