View Source Cldr.Calendar.ISOWeek (Cldr Calendars v1.20.0)

Implements the ISO Week calendar.

The ISO Week calendar manages dates in a yyyy-ww-dd format with each year having either 52 or 53 weeks.

Link to this section Summary

Functions

Adds a :year, :month, :day or time increments

Identifies that the calendar is week based.

Returns the calendar year as displayed on rendered calendars.

Defines the CLDR calendar type for this calendar.

Returns the cyclic year as displayed on rendered calendars.

Returns {year, month, day} calculated from the number of iso_days.

Returns the number of days since the calendar epoch for a given year-month-day

Calculates the day and era from the given year, month, and day.

Calculates the day of the week from the given year, month, and day. It is an integer from 1 to 7, where 1 is Monday and 7 is Sunday.

Calculates the day of the year from the given year, month, and day. It is an integer from 1 to 366.

Returns how many days there are in the given year-month.

Returns the number days in a a week.

Returns the number days in a given year.

Returns the extended year as displayed on rendered calendars.

Returns the number of iso_days that is the first day of the given year for this calendar.

Calculates the ISO week of the year from the given year, month, and day. It is an integer from 1 to 53.

Returns the number of iso_days that is the last day of the given year for this calendar.

Returns if the given year is a leap year.

Returns a Date.Range.t representing a given month of a year.

Calculates the month of the year from the given year, month, and day. It is an integer from 1 to 12.

Converts the Calendar.iso_days/0 format to the datetime format specified by this calendar.

Calculates the number of period in a given year. A period corresponds to a month in month-based calendars and a week in week-based calendars..

Adds an increment number of date_parts to a year-month-day.

Returns a Date.Range.t representing a given quarter of a year.

Calculates the quarter of the year from the given year, month, and day. It is an integer from 1 to 4.

Returns the related gregorian year as displayed on rendered calendars.

Determines if the date given is valid according to the this calendar.

Returns a Date.Range.t representing a given week of a year.

Calculates the week of the month from the given year, month, and day. It is an integer from 1 to 5.

Calculates the week of the year from the given year, month, and day. It is an integer from 1 to 53.

Returns the number weeks in a given year.

Returns a Date.Range.t representing a given year.

Calculates the year and era from the given year. The ISO calendar has two eras: the current era which starts in year 1 and is defined as era "1". And a second era for those years less than 1 defined as era "0".

Calculates the year and era from the given year, month and day.

Link to this section Types

@type day() :: 1..7
@type month() :: 1..12
@type week() :: 1..53
@type year() :: -9999..9999

Link to this section Functions

Link to this function

add(year, month, day, hour, minute, second, microsecond, atom, step)

View Source

Adds a :year, :month, :day or time increments

These functions support CalendarInterval

Identifies that the calendar is week based.

Link to this function

calendar_year(year, month, day)

View Source
@spec calendar_year(year(), month(), day()) :: Calendar.year()

Returns the calendar year as displayed on rendered calendars.

Defines the CLDR calendar type for this calendar.

This type is used in support of Cldr.Calendar.localize/3. Currently only :gregorian is supported.

Link to this function

cyclic_year(year, month, day)

View Source
@spec cyclic_year(year(), month(), day()) :: Calendar.year()

Returns the cyclic year as displayed on rendered calendars.

Link to this function

date_from_iso_days(iso_days)

View Source

Returns {year, month, day} calculated from the number of iso_days.

Link to this function

date_to_iso_days(year, week, day)

View Source

Returns the number of days since the calendar epoch for a given year-month-day

Link to this function

day_of_era(year, week, day)

View Source
@spec day_of_era(year(), month(), day()) :: {day :: pos_integer(), era :: 0..1}

Calculates the day and era from the given year, month, and day.

Link to this function

day_of_week(year, month, day, atom)

View Source
@spec day_of_week(year(), month(), day(), :default | atom()) ::
  {Calendar.day_of_week(), first_day_of_week :: non_neg_integer(),
   last_day_of_week :: non_neg_integer()}

Calculates the day of the week from the given year, month, and day. It is an integer from 1 to 7, where 1 is Monday and 7 is Sunday.

Link to this function

day_of_year(year, week, day)

View Source
@spec day_of_year(year(), month(), day()) :: 1..366

Calculates the day of the year from the given year, month, and day. It is an integer from 1 to 366.

Link to this function

days_in_month(year, month)

View Source
@spec days_in_month(year(), month()) :: Calendar.day()

Returns how many days there are in the given year-month.

Returns the number days in a a week.

@spec days_in_year(year()) :: Calendar.day()

Returns the number days in a given year.

Link to this function

extended_year(year, month, day)

View Source
@spec extended_year(year(), month(), day()) :: Calendar.year()

Returns the extended year as displayed on rendered calendars.

Link to this function

first_gregorian_day_of_year(year)

View Source

Returns the number of iso_days that is the first day of the given year for this calendar.

Link to this function

iso_week_of_year(year, week, day)

View Source
@spec iso_week_of_year(year(), Cldr.Calendar.week(), day()) ::
  {year(), Cldr.Calendar.week()}

Calculates the ISO week of the year from the given year, month, and day. It is an integer from 1 to 53.

Link to this function

last_gregorian_day_of_year(year)

View Source

Returns the number of iso_days that is the last day of the given year for this calendar.

@spec leap_year?(year()) :: boolean()

Returns if the given year is a leap year.

Returns a Date.Range.t representing a given month of a year.

Link to this function

month_of_year(year, week, day)

View Source
@spec month_of_year(year(), Cldr.Calendar.week(), day()) :: month()

Calculates the month of the year from the given year, month, and day. It is an integer from 1 to 12.

Link to this function

naive_datetime_from_iso_days(arg)

View Source

Converts the Calendar.iso_days/0 format to the datetime format specified by this calendar.

Link to this function

naive_datetime_to_iso_days(year, week, day, hour, minute, second, microsecond)

View Source

Returns the Calendar.iso_days/0 format of the specified date.

@spec periods_in_year(year()) :: Calendar.week()

Calculates the number of period in a given year. A period corresponds to a month in month-based calendars and a week in week-based calendars..

Link to this function

plus(year, month, day, date_part, increment, options \\ [])

View Source

Adds an increment number of date_parts to a year-month-day.

date_part can be :years, :quarters, or :months.

Returns a Date.Range.t representing a given quarter of a year.

Link to this function

quarter_of_year(year, week, day)

View Source
@spec quarter_of_year(year(), Cldr.Calendar.week(), day()) :: 1..4

Calculates the quarter of the year from the given year, month, and day. It is an integer from 1 to 4.

Link to this function

valid_date?(year, week, day)

View Source

Determines if the date given is valid according to the this calendar.

Returns a Date.Range.t representing a given week of a year.

Link to this function

week_of_month(year, week, day)

View Source
@spec week_of_month(year(), Cldr.Calendar.week(), day()) ::
  {month(), Cldr.Calendar.week()}

Calculates the week of the month from the given year, month, and day. It is an integer from 1 to 5.

Link to this function

week_of_year(year, week, day)

View Source
@spec week_of_year(year(), Cldr.Calendar.week(), day()) ::
  {year(), Cldr.Calendar.week()}

Calculates the week of the year from the given year, month, and day. It is an integer from 1 to 53.

@spec weeks_in_year(year()) :: Calendar.week()

Returns the number weeks in a given year.

Returns a Date.Range.t representing a given year.

@spec year_of_era(year()) :: {year(), era :: non_neg_integer()}

Calculates the year and era from the given year. The ISO calendar has two eras: the current era which starts in year 1 and is defined as era "1". And a second era for those years less than 1 defined as era "0".

Link to this function

year_of_era(year, week, day)

View Source
@spec year_of_era(year(), month(), day()) :: {year(), era :: non_neg_integer()}

Calculates the year and era from the given year, month and day.

The ISO calendar has two eras: the current era which starts in year 1 and is defined as era "1". And a second era for those years less than 1 defined as era "0".