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 Hebrew {year, month, day} for the given ISO day number.

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

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

@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()) :: 29..30

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

Returns {:error, :invalid_month} if month is 6 (Adar I) and year is not a leap year.

Returns the number days in a a week.

@spec days_in_year(year()) :: 353..355 | 383..385

Returns the total number of days in the given Hebrew year.

Possible values are 353, 354, 355 (ordinary years) and 383, 384, 385 (leap years).

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

Returns the extended year as displayed on rendered calendars.

@spec hebrew_new_year(year()) :: integer()

Returns the ISO day number of 1 Tishri of the given Hebrew year (the start of the Hebrew year).

@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 Hebrew year is a leap year (i.e. it contains the embolismic month Adar I).

Leap years are determined by a 19-year Metonic cycle: years 3, 6, 8, 11, 14, 17, and 19 of each cycle are leap years.

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 for the given Hebrew date.

In a leap year, month 7 is Adar II and is returned as {7, :leap} so that Calendrical.localize/3 picks up the CLDR 7_yeartype_leap variant ("Adar II"). All other months are returned as plain integers.

Returns the number of months in a leap year.

Returns the number of months in a normal year.

@spec months_in_year(year()) :: 12..13

Returns the number of months in the given Hebrew year (12 in an ordinary year, 13 in a leap 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()

The Hebrew calendar does not define quarters because the year has a variable number of months (12 or 13).

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

Returns the related gregorain year as displayed on rendered calendars.

Determines if the given year, month, and day form a valid Hebrew date.

Month 6 (Adar I) is only valid in leap years.

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.