Cldr Calendars v1.1.0 Cldr.Calendar.Interval View Source
Implements functions to return intervals and compare date intervals.
In particular it provides functions which return an
interval (as a Date.Range.t
) for years, quarters,
months, weeks and days.
Link to this section Summary
Functions
Compare two date ranges.
Returns a Date.Range.t
that represents
the day
.
Returns a Date.Range.t
that represents
the year
.
Returns a Date.Range.t
that represents
the quarter
.
Returns a Date.Range.t
that represents
the year
.
Returns a Date.Range.t
that represents
the year
.
Link to this section Functions
compare(r1, r2)
View Sourcecompare(range_1 :: Date.Range.t(), range_2 :: Date.Range.t()) :: Cldr.Calendar.interval_relation()
Compare two date ranges.
Uses Allen's Interval Algebra to return one of 13 different relationships:
Relation | Converse |
---|---|
:precedes | :preceded_by |
:meets | :met_by |
:overlaps | :overlapped_by |
:finished_by | :finishes |
:contains | :during |
:starts | :started_by |
:equals | :equals |
Arguments
range_1
is aDate.Range.t
range_2
is aDate.Range.t
Returns
An atom representing the relationship between the two ranges.
Examples
iex> Cldr.Calendar.Interval.compare Cldr.Calendar.Interval.day(~D[2019-01-01]),
...> Cldr.Calendar.Interval.day(~D[2019-01-02])
:meets
iex> Cldr.Calendar.Interval.compare Cldr.Calendar.Interval.day(~D[2019-01-01]),
...> Cldr.Calendar.Interval.day(~D[2019-01-03])
:precedes
iex> Cldr.Calendar.Interval.compare Cldr.Calendar.Interval.day(~D[2019-01-03]),
...> Cldr.Calendar.Interval.day(~D[2019-01-01])
:preceded_by
iex> Cldr.Calendar.Interval.compare Cldr.Calendar.Interval.day(~D[2019-01-02]),
...> Cldr.Calendar.Interval.day(~D[2019-01-01])
:met_by
iex> Cldr.Calendar.Interval.compare Cldr.Calendar.Interval.day(~D[2019-01-02]),
...> Cldr.Calendar.Interval.day(~D[2019-01-02])
:equals
Returns a Date.Range.t
that represents
the day
.
The range is enumerable.
Arguments
year
is anyyear
forcalendar
day
is anyday
in theyear
forcalendar
calendar
is any module that implements theCalendar
andCldr.Calendar
behaviours. The default isCldr.Calendar.Gregorian
.
Returns
- A
Date.Range.t()
representing the the enumerable days in theweek
Examples
iex> Cldr.Calendar.Interval.day 2019, 52, Cldr.Calendar.US
#DateRange<~d[2019-02-21 Cldr.Calendar.US], ~d[2019-02-21 Cldr.Calendar.US]>
iex> Cldr.Calendar.Interval.day 2019, 92, Cldr.Calendar.NRF
#DateRange<~d[2019-W14-1 Cldr.Calendar.NRF], ~d[2019-W14-1 Cldr.Calendar.NRF]>
Cldr.Calendar.Interval.day 2019, 8, Cldr.Calendar.ISOWeek
#DateRange<%Date{calendar: Cldr.Calendar.ISOWeek, day: 1, month: 2, year: 2019}, %Date{calendar: Cldr.Calendar.ISOWeek, day: 1, month: 2, year: 2019}>
day(year, day, calendar \\ Cldr.Calendar.Gregorian)
View Sourceday(Calendar.year(), Calendar.day(), Cldr.Calendar.calendar()) :: Date.Range.t()
Returns a Date.Range.t
that represents
the year
.
The range is enumerable.
Arguments
year
is anyyear
forcalendar
month
is anymonth
in theyear
forcalendar
calendar
is any module that implements theCalendar
andCldr.Calendar
behaviours. The default isCldr.Calendar.Gregorian
.
Returns
- A
Date.Range.t()
representing the the enumerable days in themonth
Examples
iex> Cldr.Calendar.Interval.month 2019, 3, Cldr.Calendar.UK
#DateRange<~d[2019-03-01 Cldr.Calendar.UK], ~d[2019-03-30 Cldr.Calendar.UK]>
iex> Cldr.Calendar.Interval.month 2019, 3, Cldr.Calendar.US
#DateRange<~d[2019-03-01 Cldr.Calendar.US], ~d[2019-03-31 Cldr.Calendar.US]>
month(year, month, calendar \\ Cldr.Calendar.Gregorian)
View Sourcemonth(Calendar.year(), Calendar.month(), Cldr.Calendar.calendar()) :: Date.Range.t()
Returns a Date.Range.t
that represents
the quarter
.
The range is enumerable.
Arguments
year
is anyyear
forcalendar
quarter
is anyquarter
in theyear
forcalendar
calendar
is any module that implements theCalendar
andCldr.Calendar
behaviours. The default isCldr.Calendar.Gregorian
.
Returns
- A
Date.Range.t()
representing the the enumerable days in thequarter
Examples
iex> Cldr.Calendar.Interval.quarter 2019, 2, Cldr.Calendar.UK
#DateRange<~d[2019-04-01 Cldr.Calendar.UK], ~d[2019-06-30 Cldr.Calendar.UK]>
iex> Cldr.Calendar.Interval.quarter 2019, 2, Cldr.Calendar.ISOWeek
#DateRange<~d[2019-W14-1 Cldr.Calendar.ISOWeek], ~d[2019-W26-7 Cldr.Calendar.ISOWeek]>
quarter(year, quarter, calendar \\ Cldr.Calendar.Gregorian)
View Sourcequarter(Calendar.year(), Cldr.Calendar.quarter(), Cldr.Calendar.calendar()) :: Date.Range.t()
Returns a Date.Range.t
that represents
the year
.
The range is enumerable.
Arguments
year
is anyyear
forcalendar
week
is anyweek
in theyear
forcalendar
calendar
is any module that implements theCalendar
andCldr.Calendar
behaviours. The default isCldr.Calendar.Gregorian
.
Returns
A
Date.Range.t()
representing the the enumerable days in theweek
or{:error, :not_defined}
if the calendar does not support the concept of weeks
Examples
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.US
#DateRange<~d[2019-12-22 Cldr.Calendar.US], ~d[2019-12-28 Cldr.Calendar.US]>
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.NRF
#DateRange<~d[2019-W52-1 Cldr.Calendar.NRF], ~d[2019-W52-7 Cldr.Calendar.NRF]>
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.ISOWeek
#DateRange<~d[2019-W52-1 Cldr.Calendar.ISOWeek], ~d[2019-W52-7 Cldr.Calendar.ISOWeek]>
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.Julian
{:error, :not_defined}
week(year, week, calendar \\ Cldr.Calendar.Gregorian)
View Sourceweek(Calendar.year(), Cldr.Calendar.week(), Cldr.Calendar.calendar()) :: Date.Range.t()
Returns a Date.Range.t
that represents
the year
.
The range is enumerable.
Arguments
year
is anyyear
forcalendar
calendar
is any module that implements theCalendar
andCldr.Calendar
behaviours. The default isCldr.Calendar.Gregorian
.
Returns
- A
Date.Range.t()
representing the the enumerable days in theyear
Examples
iex> Cldr.Calendar.Interval.year 2019, Cldr.Calendar.UK
#DateRange<~d[2019-01-01 Cldr.Calendar.UK], ~d[2019-12-31 Cldr.Calendar.UK]>
iex> Cldr.Calendar.Interval.year 2019, Cldr.Calendar.NRF
#DateRange<~d[2019-W01-1 Cldr.Calendar.NRF], ~d[2019-W52-7 Cldr.Calendar.NRF]>
year(year, calendar \\ Cldr.Calendar.Gregorian)
View Sourceyear(Calendar.year(), Cldr.Calendar.calendar()) :: Date.Range.t()