@spec buddhist_year(integer()) :: year()

Returns the Buddhist year corresponding to the given Gregorian year.

Arguments

• gregorian_year is any proleptic Gregorian year as an integer.

Returns

• An integer Buddhist year (543 more than the input).

Examples

iex> Calendrical.Buddhist.buddhist_year(2026)
2569

Identifies whether this calendar is month or week based.

@spec calendar_year(Calendar.year(), Calendar.month(), Calendar.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 Calendrical. localize/3.

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

Returns the cyclic year as displayed on rendered calendars.

@spec date_from_iso_days(integer()) :: {year(), month(), day()}

Returns a Buddhist {year, month, day} tuple for the given ISO day number.

Arguments

• iso_days is an integer count of days since the proleptic ISO epoch.

Returns

• A three-tuple {year, month, day} in Buddhist Era numbering.

Examples

iex> Calendrical.Buddhist.date_from_iso_days(739_252)
{2567, 1, 2}

@spec date_to_iso_days(year(), month(), day()) :: integer()

Returns the number of ISO days for the given Buddhist year, month, and day.

Arguments

• year is any Buddhist year as an integer.

• month is a month in the range 1..12.

• day is a day-of-month.

Returns

• An integer count of days since the proleptic ISO epoch.

Examples

iex> Calendrical.Buddhist.date_to_iso_days(2569, 1, 1)
739982

@spec day_of_era(Calendar.year(), Calendar.month(), Calendar.day()) ::
  {day :: Calendar.day(), era :: Calendar.era()}

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

By default we consider on two eras: before the epoch and on-or-after the epoch.

@spec day_of_year(Calendar.year(), Calendar.month(), Calendar.day()) :: Calendar.day()

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.

@spec days_in_month(Calendar.year(), Calendar.month()) :: Calendar.month()

@spec days_in_month(year(), month()) :: 28..31

Returns the number of days in the given Buddhist year and month.

Arguments

• year is any Buddhist year as an integer.

• month is a month in the range 1..12.

Returns

• The number of days in the month (28..31).

Examples

iex> Calendrical.Buddhist.days_in_month(2569, 2)
28

Returns the number days in a a week.

Returns the number of days in the given Buddhist year.

Arguments

• year is any Buddhist year as an integer.

Returns

• 365 for an ordinary year or 366 for a leap year.

Examples

iex> Calendrical.Buddhist.days_in_year(2569)
365

iex> Calendrical.Buddhist.days_in_year(2567)
366

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

Returns the extended year as displayed on rendered calendars.

@spec gregorian_offset() :: 543

Returns the offset (in years) between the Buddhist Era and the proleptic Gregorian calendar.

Subtracting this offset from a Buddhist year yields the corresponding Gregorian year.

Returns

• The integer 543.

Examples

iex> Calendrical.Buddhist.gregorian_offset()
543

@spec gregorian_year(year()) :: integer()

Returns the Gregorian year corresponding to the given Buddhist year.

Arguments

• buddhist_year is any Buddhist Era year as an integer.

Returns

• An integer Gregorian year (543 less than the input).

Examples

iex> Calendrical.Buddhist.gregorian_year(2569)
2026

@spec iso_week_of_year(Calendar.year(), Calendar.month(), Calendar.day()) ::
  {:error, :not_defined}

Calculates the ISO week of the year from the given year, month, and day.

By default this function always returns {:error, :not_defined}.

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

Returns whether the given Buddhist year is a leap year.

The underlying calendar is proleptic Gregorian, so the leap-year rule applies to the corresponding Gregorian year.

Arguments

• year is any Buddhist year as an integer.

Returns

• true if the year contains 366 days; otherwise false.

Examples

iex> Calendrical.Buddhist.leap_year?(2567)
true

iex> Calendrical.Buddhist.leap_year?(2569)
false

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

@spec month_of_year(Calendar.year(), Calendar.month(), Calendar.day()) ::
  Calendar.month() | {Calendar.month(), Calendrical.leap_month?()}

Returns the month of the year from the given year, month, and day.

Returns the number of months in a leap year.

Returns the number of months in a normal year.

Returns the number of months in a given year.

@spec naive_datetime_from_iso_days(Calendar.iso_days()) ::
  {Calendar.year(), Calendar.month(), Calendar.day(), Calendar.hour(),
   Calendar.minute(), Calendar.second(), Calendar.microsecond()}

Converts the t:Calendar.iso_days format to the datetime format specified by this calendar.

@spec naive_datetime_to_iso_days(
  Calendar.year(),
  Calendar.month(),
  Calendar.day(),
  Calendar.hour(),
  Calendar.minute(),
  Calendar.second(),
  Calendar.microsecond()
) :: Calendar.iso_days()

Returns the t:Calendar.iso_days 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.

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

date_part can be :months only.

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

@spec quarter_of_year(Calendar.year(), Calendar.month(), Calendar.day()) ::
  Calendrical.quarter()

Returns the quarter of the year from the given year, month, and day.

@spec related_gregorian_year(Calendar.year(), Calendar.month(), Calendar.day()) ::
  Calendar.year()

Returns the related gregorain year as displayed on rendered calendars.

Returns whether the given year, month, and day form a valid Buddhist date.

Arguments

• year is any Buddhist year as an integer.

• month is a month in the range 1..12.

• day is a day-of-month.

Returns

• true if the date is valid; otherwise false.

Examples

iex> Calendrical.Buddhist.valid_date?(2569, 1, 31)
true

iex> Calendrical.Buddhist.valid_date?(2569, 2, 29)
false

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

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

Calculates the week of the year from the given year, month, and day.

By default this function always returns {:error, :not_defined}.

@spec week_of_year(Calendar.year(), Calendar.month(), Calendar.day()) ::
  {:error, :not_defined}

Calculates the week of the year from the given year, month, and day.

By default this function always returns {:error, :not_defined}.

Returns the number of weeks in a given year.

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

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

Calculates the year and era from the given year.

@spec year_of_era(Calendar.year(), Calendar.month(), Calendar.day()) ::
  {year :: Calendar.year(), era :: Calendar.era()}

Calculates the year and era from the given date.