# Index of values

A
add [Calendar_sig.S.Period] | Addition of periods.
add [Calendar_sig.S] |
add [Date_sig.S] | `add d p` returns `d + p`.
add [Time_sig.S] | `app t p` returns `t + p`.
add [Period.S] | Addition of periods.
ascension [Date_sig.S] | Ascension.
ash [Date_sig.S] | Ash Wednesday.
C
carnaval [Date_sig.S] | Carnaval Monday.
century [Date_sig.S] | Century of a year.
change [Time_Zone] | Change the current time zone by another one.
compare [Calendar_sig.S.Period] | Comparison function between two periods.
compare [Calendar_sig.S] | Comparison function between two calendars.
compare [Date_sig.S] | Comparison function between two dates.
compare [Time_sig.S] | Comparison function between two times.
compare [Period.S] | Comparison function between two periods.
compare [Utils.Comparable] | Comparison over `t`.
convert [Calendar_sig.S] |
convert [Time_sig.S] | `convert t t1 t2` converts the time `t` expressed in the time zone `t1` to the same time expressed in the time zone `t2`.
corpus_christi [Date_sig.S] | Feast of Corpus Christi.
create [Calendar_sig.S] | `create d t` creates a calendar from the given date and time.
current [Time_Zone] | Return the current time zone.
D
date [Version] | Date of compilation.
day [Calendar_sig.S.Period] |
day [Date_sig.S.Period] | `day n` makes a period of `n` days.
day_name [Printer] | String representation of a day.
day_of_int [Date_sig.S] | Inverse of `int_of_day`.
day_of_month [Calendar_sig.S] |
day_of_month [Date_sig.S] | Day of the month.
day_of_week [Calendar_sig.S] |
day_of_week [Date_sig.S] | Day of the week.
day_of_year [Calendar_sig.S] |
day_of_year [Date_sig.S] | Day of the year.
days_in_month [Calendar_sig.S] |
days_in_month [Date_sig.S] | Number of days in the month of a date.
days_in_year [Date_sig.S] | Number of days in a year.
div [Time_sig.S.Period] | Division.
dprint [Printer.S] | Same as `print d` where `d` is the default format (see the printer implementations).
E
easter [Date_sig.S] | Easter Sunday.
easter_friday [Date_sig.S] | Easter Friday.
easter_monday [Date_sig.S] | Easter Monday.
easter_saturday [Date_sig.S] | Easter Saturday.
empty [Calendar_sig.S.Period] | The empty period.
empty [Period.S] | The empty period.
epact [Date_sig.S] | Epact.
equal [Calendar_sig.S.Period] | Equality function between two periods.
equal [Calendar_sig.S] | Equality function between two calendars.
equal [Date_sig.S] | Equality function between two dates.
equal [Time_sig.S] | Equality function between two times.
equal [Period.S] | Equality function between two periods.
equal [Utils.Comparable] | Equality over `t`.
F
fprint [Printer.S] | `fprint format formatter x` outputs `x` on `formatter` according to the specified `format`.
from_business [Date_sig.S] | Inverse of `to_business` respecting ISO-8601.
from_date [Calendar_sig.S.Period] | Convert a date period to a calendar period.
from_date [Calendar_sig.S] | Convert a date to a calendar.
from_day_of_year [Date_sig.S] | Make a date from a year and its day of the year.
from_float [Time_sig.Second] | Convert a float to an equivalent number of seconds.
from_fstring [Printer.S] | `from_fstring format s` converts `s` to a date according to `format`.
from_gmt [Calendar_sig.S] |
from_gmt [Time_sig.S] | `from_gmt t` is equivalent to `convert t Time_Zone.GMT (Time_Zone.current ())`.
from_gmt [Time_Zone] | `from_gmt ()` is equivalent to `gap UTC (current ())`.
from_hours [Time_sig.S] | Inverse of `to_hours`.
from_int [Time_sig.Second] | Convert an integer to an equivalent number of seconds.
from_jd [Calendar_sig.S] | Return the Julian day.
from_jd [Date_sig.S] | Make a date from its Julian day.
from_minutes [Time_sig.S] | Inverse of `to_minutes`.
from_mjd [Calendar_sig.S] | Return the Modified Julian day.
from_mjd [Date_sig.S] | Make a date from its modified Julian day (i.e.
from_seconds [Time_sig.S] | Inverse of `to_seconds`.
from_string [Printer.S] | Same as `from_fstring d` where `d` is the default format.
from_time [Calendar_sig.S.Period] | Convert a time period to a calendar period.
from_unixfloat [Calendar_sig.S] | Inverse of `to_unixfloat`.
from_unixfloat [Date_sig.S] | Inverse of `to_unixfloat`.
from_unixtm [Calendar_sig.S] | Inverse of `to_unixtm`.
from_unixtm [Date_sig.S] | Inverse of `to_unixtm`.
G
gap [Time_Zone] | Return the gap between two time zone.
golden_number [Date_sig.S] | Golden number.
H
hash [Calendar_sig.S.Period] | Hash function for periods.
hash [Calendar_sig.S] | Hash function for calendars.
hash [Date_sig.S] | Hash function for dates.
hash [Time_sig.S] | Hash function for times.
hash [Period.S] | Hash function for periods.
hash [Utils.Comparable] | A hash function over `t`.
hour [Calendar_sig.S.Period] |
hour [Calendar_sig.S] |
hour [Time_sig.S.Period] | `hour n` makes a period of `n` hours.
hour [Time_sig.S] | Hour.
hour_of_dst [Time_Zone] | `hour_of_dst ()` returns `1` if `is_dst ()` and `0` otherwise.
I
indiction [Date_sig.S] | Indiction.
int_of_day [Date_sig.S] | Convert a day to an integer respecting ISO-8601.
int_of_month [Date_sig.S] | Convert a month to an integer respecting ISO-8601.
is_am [Calendar_sig.S] |
is_am [Time_sig.S] | Return `true` is the time is after midday in the current time zone; `false` otherwise.
is_dst [Time_Zone] | `is_dst ()` checks if daylight saving time is in effect.
is_gregorian [Calendar_sig.S] |
is_gregorian [Date_sig.S] | Return `true` if a date belongs to the Gregorian calendar; `false` otherwise.
is_julian [Calendar_sig.S] |
is_julian [Date_sig.S] | Return `true` iff a date belongs to the Julian calendar; `false` otherwise.
is_leap_day [Calendar_sig.S] |
is_leap_day [Date_sig.S] | Return `true` if a date is a leap day (i.e.
is_leap_year [Date_sig.S] | Return `true` if a year is a leap year; `false` otherwise.
is_pm [Calendar_sig.S] |
is_pm [Time_sig.S] | Return `true` is the time is before midday in the current time zone; `false` otherwise.
is_valid_date [Date_sig.S] | Check if a date is valid, that is the date has not been coerced to look like a real date.
L
length [Time_sig.S.Period] | Number of seconds of a period.
lmake [Calendar_sig.S.Period] | Labelled version of `make`.
lmake [Calendar_sig.S] | Labelled version of `make`.
lmake [Date_sig.S.Period] | Labelled version of `make`.
lmake [Date_sig.S] | Labelled version of `make`.
lmake [Time_sig.S.Period] | Labelled version of `make`.
lmake [Time_sig.S] | Labelled version of `make`.
M
make [Calendar_sig.S.Period] | `make year month day hour minute second` makes a period of the specified length.
make [Calendar_sig.S] | `make year month day hour minute second` makes the calendar "year-month-day; hour-minute-second".
make [Date_sig.S.Period] | `make year month day` makes a period of the specified length.
make [Date_sig.S] | `make year month day` makes the date year-month-day.
make [Time_sig.S.Period] | `make hour minute second` makes a period of the specified length.
make [Time_sig.S] | `make hour minute second` makes the time hour-minute-second.
make_year [Date_sig.S] | `make_year y` makes a date only represented by its year `y`.
make_year_month [Date_sig.S] | `make_year_month y m` makes a date only represented by its year `y` and its month `m`.
mardi_gras [Date_sig.S] | Mardi Gras.
midday [Time_sig.S] | `midday ()` is midday (expressed in the current time zone).
midnight [Time_sig.S] | `midnight ()` is midnight (expressed in the current time zone).
millenium [Date_sig.S] | Millenium of a year.
minute [Calendar_sig.S.Period] |
minute [Calendar_sig.S] |
minute [Time_sig.S.Period] | `minute n` makes a period of `n` minutes.
minute [Time_sig.S] | Minute.
month [Calendar_sig.S.Period] |
month [Calendar_sig.S] |
month [Date_sig.S.Period] | `month n` makes a period of `n` months.
month [Date_sig.S] | Month.
month_name [Printer] | String representation of a month.
month_of_int [Date_sig.S] | Inverse of `int_of_month`.
mul [Time_sig.S.Period] | Multiplication.
N
name_of_day [Printer] | `name_of_day d` is equivalent to `!day_name d`.
name_of_month [Printer] | `name_of_month m` is equivalent to `!day_month m`.
nb_days [Date_sig.S.Period] | Number of days in a period.
next [Calendar_sig.S] |
next [Date_sig.S] | `next d f` returns the date corresponding to the next specified field.
next [Time_sig.S] | `next t f` returns the time corresponding to the next specified field.
normalize [Time_sig.S] | `normalize t` returns `t` such that `hour t` belongs to `[0; 24[`.
now [Calendar_sig.S] | `now ()` returns the current date and time (in the current time zone).
now [Time_sig.S] | The current time based on `Time_Zone.current ()`.
nth_weekday_of_month [Date_sig.S] | `nth_weekday_of_month y m d n` returns the `n`-th day `d` in the month `m` of the year `y` (for instance the 3rd Thursday of the month).
O
on [Time_Zone] | `on f tz x` changes the time zone to `tz`, then computes `f x`, and finally reset the time zone to the initial one and returns the result of the computation.
opp [Calendar_sig.S.Period] | Opposite of a period.
opp [Period.S] | Opposite of a period.
P
palm [Date_sig.S] | Palm Sunday.
precise_sub [Calendar_sig.S] |
precise_sub [Date_sig.S] | `precise_sub d1 d2` returns the period between `d1` and `d2`.
prev [Calendar_sig.S] |
prev [Date_sig.S] | `prev d f` returns the date corresponding to the previous specified field.
prev [Time_sig.S] | `prev t f` returns the time corresponding to the previous specified field.
print [Printer.S] | `print format` is equivalent to `fprint format Format.std_formatter`
R
rem [Calendar_sig.S] |
rem [Date_sig.S] | `rem d p` is equivalent to `add d (Period.opp p)`.
rem [Time_sig.S] | `rem t p` is equivalent to `add t (Period.opp p)`.
round [Utils.Float] | Round a float to the nearest integer.
S
safe_nb_days [Date_sig.S.Period] | Equivalent to `Date_sig.S.Period.nb_days` but never raises any exception.
safe_to_time [Calendar_sig.S.Period] | Equivalent to `Calendar_sig.S.Period.to_time` but never raises any exception.
same_calendar [Date_sig.S] | Return `true` if two years have the same calendar; `false` otherwise.
second [Calendar_sig.S.Period] |
second [Calendar_sig.S] |
second [Time_sig.S.Period] | `second n` makes a period of `n` seconds.
second [Time_sig.S] | Second.
set_precision [Utils.Float] | Set the precision of `equal` and `compare` for float.
set_word_regexp [Printer] | Set the regular expression used to recognize words in `from_fstring`.
short_name_of_day [Printer] | `short_name_of_day d` returns the 3 first characters of `name_of_day d`.
short_name_of_month [Printer] | `short_name_of_month d` returns the 3 first characters of `name_of_month d`.
solar_number [Date_sig.S] | Solar number.
sprint [Printer.S] | `sprint format date` converts `date` to a string according to `format`.
sub [Calendar_sig.S.Period] | Substraction of periods.
sub [Calendar_sig.S] |
sub [Date_sig.S] | `sub d1 d2` returns the period between `d1` and `d2`.
sub [Time_sig.S] | `sub t1 t2` returns the period between `t1` and `t2`.
sub [Period.S] | Substraction of periods.
T
to_business [Date_sig.S] | Return the "business week" and the day in this week respecting ISO 8601.
to_date [Calendar_sig.S.Period] | Convert a calendar period to a date period.
to_date [Calendar_sig.S] | Convert a calendar to a date.
to_float [Time_sig.Second] | Inverse of `from_float`.
to_gmt [Calendar_sig.S] |
to_gmt [Time_sig.S] | `to_gmt t` is equivalent to `convert t (Time_Zone.current ()) Time_Zone.GMT`.
to_gmt [Time_Zone] | `to_gmt ()` is equivalent to `gap (current ()) UTC`.
to_hours [Time_sig.S.Period] | Number of hours of a period.
to_hours [Time_sig.S] | Number of hours of a time.
to_int [Time_sig.Second] | Inverse of `from_int`.
to_jd [Calendar_sig.S] |
to_jd [Date_sig.S] | Julian day.
to_minutes [Time_sig.S.Period] | Number of minutes of a period.
to_minutes [Time_sig.S] | Number of minutes of a time.
to_mjd [Calendar_sig.S] |
to_mjd [Date_sig.S] | Modified Julian day (i.e.
to_seconds [Time_sig.S.Period] | Number of seconds of a period.
to_seconds [Time_sig.S] | Number of seconds of a time.
to_string [Printer.S] | Same as `sprint d` where `d` is the default format (see the printer implementations).
to_time [Calendar_sig.S.Period] | Convert a calendar period to a date period.
to_time [Calendar_sig.S] | Convert a calendar to a time.
to_unixfloat [Calendar_sig.S] | Convert a calendar to a float such than `to_unixfloat (make 1970 1 1 0 0 0)` returns `0.0` at UTC.
to_unixfloat [Date_sig.S] | Convert a date to a float such than `to_unixfloat (make 1970 1 1)` returns `0.0`.
to_unixtm [Calendar_sig.S] | Convert a calendar into the `unix.tm` type.
to_unixtm [Date_sig.S] | Convert a date into the `Unix.tm` type.
today [Date_sig.S] | Date of the current day (based on `Time_Zone.current ()`).
V
version [Version] | Name of this version.
W
week [Calendar_sig.S.Period] |
week [Calendar_sig.S] |
week [Date_sig.S.Period] | `week n` makes a period of `n` weeks.
week [Date_sig.S] | Week.
week_first_last [Date_sig.S] | Return the first and last days of a week in a year.
weeks_in_year [Date_sig.S] | Number of weeks in a year.
withmonday [Date_sig.S] | Withmonday.
withsunday [Date_sig.S] | Withsunday.
Y
year [Calendar_sig.S.Period] |
year [Calendar_sig.S] |
year [Date_sig.S.Period] | `year n` makes a period of `n` years.
year [Date_sig.S] | Year.
ymd [Date_sig.S.Period] | Number of years, months and days in a period.
ymds [Calendar_sig.S.Period] | Number of years, months, days and seconds in a period.