View Source Cldr.Calendar.Coptic (ex_cldr_calendars_coptic v1.0.1)

Implementation of the Coptic calendar.

Summary

Functions

Identifies that this calendar is month based.

Defines the CLDR calendar type for this calendar.

Returns a {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 year from the given year, month, and day.

Returns how many days there are in the given month.

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.

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

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.

Returns the number of months in a given year.

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

Returns the number of periods 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.

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

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

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

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

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".

Types

@type day() :: 1..31
@type month() :: 1..12
@type year() :: -9999..-1 | 1..9999

Functions

Identifies that this calendar is month based.

Defines the CLDR calendar type for this calendar.

This type is used in support of Cldr.Calendar. localize/3.

Link to this function

date_from_iso_days(iso_days)

View Source

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

Link to this function

date_to_iso_days(year, month, 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, month, 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_year(year, month, 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.

@spec days_in_month(Calendar.month()) ::
  Calendar.month()
  | {:ambiguous, Range.t() | [pos_integer()]}
  | {:error, :undefined}

Returns how many days there are in the given month.

Must be implemented in derived calendars because we cannot know what the calendar format is.

Link to this function

days_in_month(year, month)

View Source
@spec days_in_month(year(), month()) :: 29..31

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.

Link to this function

iso_week_of_year(year, month, day)

View Source
@spec iso_week_of_year(year(), month(), day()) :: {:error, :not_defined}

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

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

Returns if the given year is a leap year.

Since this calendar is observational we calculate the start of successive years and then calcualate the difference in days to determine if its a leap year.

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

Link to this function

month_of_year(year, month, day)

View Source
@spec month_of_year(year(), month(), day()) :: month()

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

Returns the number of months in a given year.

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, month, day, hour, minute, second, microsecond)

View Source

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

Returns the number of periods 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 :months only.

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

Link to this function

quarter_of_year(year, month, day)

View Source
@spec quarter_of_year(year(), month(), 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, month, day)

View Source

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

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

Link to this function

week_of_month(year, month, day)

View Source
@spec week_of_month(year(), month(), day()) ::
  {pos_integer(), pos_integer()} | {:error, :not_defined}

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

Link to this function

week_of_year(year, month, day)

View Source
@spec week_of_year(year(), month(), day()) :: {:error, :not_defined}

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

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

@spec year_of_era(year()) :: {year(), era :: 0..1}

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".