package dates_calc

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

type date

A valid date in the standard Gregorian calendar.

type period

A period can be any number and combination of days, months, years.

exception InvalidDate

exception AmbiguousComputation

type date_rounding =

| RoundUp
| RoundDown
| AbortOnRound
(*
When choosing AbortOnRound, functions may raise AmbiguousComputation.
*)

val make_date : year:int -> month:int -> day:int -> date

val add_dates : ?round:date_rounding -> date -> period -> date

val sub_dates : date -> date -> period

The returned period is always expressed as a number of days.

val compare_dates : date -> date -> int

val date_to_ymd : date -> int * int * int

val format_date : Format.formatter -> date -> unit

Respects ISO8601 format.

val make_period : years:int -> months:int -> days:int -> period

val neg_period : period -> period

val add_periods : period -> period -> period

val sub_periods : period -> period -> period

val mul_period : period -> int -> period

val format_period : Format.formatter -> period -> unit

val period_to_days : period -> int

raises [AmbiguousComputation]
when the period is anything else than a number of days.