Tibetan (Calendars v0.2.4) View Source

The Tibetan calendar module.

Link to this section Summary

Types

fixed()

t()

tibetan_date()

tibetan_day()

tibetan_leap_day()

tibetan_leap_month()

tibetan_month()

tibetan_year()

Functions

add_days(cal_date, days, type \\ :fixed)

Adds the number of days to a fixed day or Tibetan date.

as_date(cal_date)

Returns a fixed day or Tibetan date as a Tibetan date.

as_fixed(cal_date)

Returns a fixed day or Tibetan date as a fixed day.

as_type(cal_date, type \\ :fixed)

Returns a fixed day or Tibetan date either as a fixed day or a Tibetan date.

calixir_api(type \\ :atom)

Returns a list of the Calixir functions of the Tibetan calendar.

compare(date1, date2)

Compares two Tibetan dates and returns...

date(year, month, leap_month, day, leap_day)

Returns a Tibetan date from its fields year, month, leap_month, day, leap_day.

date_diff(cal_date1, cal_date2)

Returns the difference (= number of days) between two Tibetan dates.

day(cal_date, type \\ :value)

Returns the day field of a Tibetan date.

epoch()

Returns the epoch of the Tibetan calendar.

eq(date1, date2)

Returns true if Tibetan date1 is equal Tibetan date2, otherwise false.

field_atom(field_index)

Returns the name of the field atom in a Tibetan date at field_index.

field_atoms()

Returns a list of the field atoms (names) of a Tibetan date.

field_count()

Returns the number of fields in a Tibetan date

field_index(field_atom)

Returns the index (= position) of the field_atom in a Tibetan date.

from_date(other_date, other_calendar)

Converts the other_date of the other_calendar into the equivalent date of the Tibetan calendar.

from_fixed(fixed)

Converts a fixed day to a Tibetan date.

from_jd(day)

Converts a Julian Day into the equivalent Tibetan date.

from_rata_die(rd)

Converts a RataDie date into the equivalent Tibetan date.

from_unix(unix_date)

Converts a Unix date into the equivalent Tibetan date.

ge(date1, date2)

Returns true if Tibetan date1 is greater (= later) than or equal Tibetan date2, otherwise false.

gt(date1, date2)

Returns true if Tibetan date1 is greater (= later) than Tibetan date2, otherwise false.

holidays(type \\ :name)

Returns a list of the holidays of the Tibetan calendar.

keyword()

Returns the internal keyword of the Tibetan calendar.

le(date1, date2)

Returns true if Tibetan date1 is smaller (= earlier) than or equal Tibetan date2, otherwise false.

leap_day(cal_date, type \\ :value)

Returns the leap_day field of a Tibetan date.

leap_month(cal_date, type \\ :value)

Returns the leap_month field of a Tibetan date.

lt(date1, date2)

Returns true if Tibetan date1 is smaller (= earlier) than Tibetan date2, otherwise false.

module()

Returns the module of the Tibetan calendar.

month(cal_date, type \\ :value)

Returns the month field of a Tibetan date.

name()

Returns the internal name of the Tibetan calendar.

range(date1, date2)

Returns the distance between two Tibetan dates as a range of fixed days.

start_of_day()

Returns the start of the day in the Tibetan calendar.

tibetan_new_year(gregorian_year)

Returns the fixed date of Losar of the Tibetan calendar in the given gregorian_year or [], if there is no such holiday in that year.

to_date(date, other_calendar)

Converts a Tibetan date into the equivalent date of the other_calendar.

to_fixed(date)

Converts a Tibetan date tuple into a fixed day.

to_fixed(year, month, leap_month, day, leap_day)

Converts a Tibetan date given by year, month, leap_month, day, leap_day into a fixed day.

to_jd(cal_date)

Converts a Tibetan date into the equivalent Julian Day.

to_jd(year, month, leap_month, day, leap_day)

Converts a Tibetan date given by year, month, leap_month, day, leap_day into the equivalent Julian Day.

to_rata_die(date)

Converts a Tibetan date into the equivalent RataDie date.

to_rata_die(year, month, leap_month, day, leap_day)

Converts a Tibetan date given by year, month, leap_month, day, leap_day into the equivalent RataDie date.

to_unix(cal_date)

Converts a Tibetan date into the equivalent Unix date.

to_unix(year, month, leap_month, day, leap_day)

Converts a Tibetan date given by year, month, leap_month, day, leap_day into the equivalent Unix date.

today(type \\ :fixed)

Returns the current date either as a fixed day or a Tibetan date.

year(cal_date, type \\ :value)

Returns the year field of a Tibetan date.

Link to this section Types

fixed()

Specs

fixed() :: integer()

t()

Specs

t() :: tibetan_date()

tibetan_date()

Specs

tibetan_date() ::
  {tibetan_year(), tibetan_month(), tibetan_leap_month(), tibetan_day(),
   tibetan_leap_day()}

tibetan_day()

Specs

tibetan_day() :: 1..30

tibetan_leap_day()

Specs

tibetan_leap_day() :: :boolean

tibetan_leap_month()

Specs

tibetan_leap_month() :: :boolean

tibetan_month()

Specs

tibetan_month() :: 1..12

tibetan_year()

Specs

tibetan_year() :: :integer

Link to this section Functions

add_days(cal_date, days, type \\ :fixed)

Specs

add_days(fixed() | tibetan_date(), integer(), :fixed | :date) ::
  fixed() | tibetan_date()

Adds the number of days to a fixed day or Tibetan date.

If days is negative, the days will be subtracted.

The type parameter determines the type of the returned value:

:fixed returns a fixed day (default),
:date returns a Tibetan date.

Examples

  iex>Elixir.Tibetan.add_days(730739, 100)
  730839
  iex>Elixir.Tibetan.add_days(730739, -100)
  730639

  iex>Elixir.Tibetan.add_days(730739, 100, :fixed)
  730839
  iex>Elixir.Tibetan.add_days(730739, -100, :fixed)
  730639

  iex>Elixir.Tibetan.add_days(730739, 100, :date)
  {2128, 11, false, 6, false}
  iex>Elixir.Tibetan.add_days(730739, -100, :date)
  {2128, 4, false, 12, false}

  iex>Elixir.Tibetan.add_days({2128, 7, false, 23, false}, 100)
  730839
  iex>Elixir.Tibetan.add_days({2128, 7, false, 23, false}, -100)
  730639

  iex>Elixir.Tibetan.add_days({2128, 7, false, 23, false}, 100, :fixed)
  730839
  iex>Elixir.Tibetan.add_days({2128, 7, false, 23, false}, -100, :fixed)
  730639

  iex>Elixir.Tibetan.add_days({2128, 7, false, 23, false}, 100, :date)
  {2128, 11, false, 6, false}
  iex>Elixir.Tibetan.add_days({2128, 7, false, 23, false}, -100, :date)
  {2128, 4, false, 12, false}

as_date(cal_date)

Specs

as_date(fixed() | tibetan_date()) :: tibetan_date()

Returns a fixed day or Tibetan date as a Tibetan date.

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.Tibetan.as_date(730739)
  {2128, 7, false, 23, false}
  iex>Elixir.Tibetan.as_date({2128, 7, false, 23, false})
  {2128, 7, false, 23, false}

as_fixed(cal_date)

Specs

as_fixed(fixed() | tibetan_date()) :: fixed()

Returns a fixed day or Tibetan date as a fixed day.

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.Tibetan.as_fixed(730739)
  730739
  iex>Elixir.Tibetan.as_fixed({2128, 7, false, 23, false})
  730739

as_type(cal_date, type \\ :fixed)

Specs

as_type(fixed() | tibetan_date(), :fixed | :date) :: fixed() | tibetan_date()

Returns a fixed day or Tibetan date either as a fixed day or a Tibetan date.

The type parameter determines the type of the returned value:

:fixed returns a fixed day (default),
:date returns a Tibetan date.

Examples

  iex>Elixir.Tibetan.as_type(730739)
  730739
  iex>Elixir.Tibetan.as_type(730739, :fixed)
  730739
  iex>Elixir.Tibetan.as_type(730739, :date)
  {2128, 7, false, 23, false}
  iex>Elixir.Tibetan.as_type({2128, 7, false, 23, false})
  730739
  iex>Elixir.Tibetan.as_type({2128, 7, false, 23, false}, :fixed)
  730739
  iex>Elixir.Tibetan.as_type({2128, 7, false, 23, false}, :date)
  {2128, 7, false, 23, false}

calixir_api(type \\ :atom)

Returns a list of the Calixir functions of the Tibetan calendar.

The type parameter determines the type of the returned Calixir function:

:atom returns the internal names of the functions (default),
:spec returns the complete specifications of the functions.

Examples

  iex>Elixir.Tibetan.calixir_api()
  [:tibetan_epoch, :tibetan_sun_equation, :tibetan_moon_equation, :fixed_from_tibetan, :tibetan_from_fixed, :tibetan_leap_month?, :tibetan_leap_day?, :tibetan_new_year]
  iex>Elixir.Tibetan.calixir_api(:atom)
  [:tibetan_epoch, :tibetan_sun_equation, :tibetan_moon_equation, :fixed_from_tibetan, :tibetan_from_fixed, :tibetan_leap_month?, :tibetan_leap_day?, :tibetan_new_year]
  iex>Elixir.Tibetan.calixir_api(:fun_specs)
  [[:tibetan_epoch, []], [:tibetan_sun_equation, [:alpha]], [:tibetan_moon_equation, [:alpha]], [:fixed_from_tibetan, [:year, :month, :leap_month, :day, :leap_day]], [:tibetan_from_fixed, [:fixed]], [:tibetan_leap_month?, [:year, :month]], [:tibetan_leap_day?, [:year, :month, :day]], [:tibetan_new_year, [:gregorian_year]]]

compare(date1, date2)

Specs

compare(tibetan_date(), tibetan_date()) :: :lt | :eq | :gt

Compares two Tibetan dates and returns...

:lt if date1 is smaller (= earlier) than date2,
:eq if date1 is equal date2,
:gt if date1 is larger (= later) than date2.

Examples

  iex>Elixir.Tibetan.compare({2128, 7, false, 23, false}, {2128, 7, false, 23, false})
  :eq
  iex>Elixir.Tibetan.compare({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  :lt
  iex>Elixir.Tibetan.compare({2128, 11, false, 6, false}, {2128, 7, false, 23, false})
  :gt

date(year, month, leap_month, day, leap_day)

Specs

date(
  tibetan_year(),
  tibetan_month(),
  tibetan_leap_month(),
  tibetan_day(),
  tibetan_leap_day()
) :: t()

Returns a Tibetan date from its fields year, month, leap_month, day, leap_day.

Example

  iex>Elixir.Tibetan.date(2128, 7, false, 23, false)
  {2128, 7, false, 23, false}

date_diff(cal_date1, cal_date2)

Specs

date_diff(fixed() | tibetan_date(), fixed() | tibetan_date()) :: integer()

Returns the difference (= number of days) between two Tibetan dates.

The dates can be given as fixed days or Tibetan dates in arbitrary combination. The difference is calculated by date2 - date1.

If cal_date2 is larger (= later) than cal_date1 the result is positive.

If cal_date2 is smaller (= earlier) than cal_date1 the result is negative.

Examples

  iex>Elixir.Tibetan.date_diff(730739, 730839)
  100
  iex>Elixir.Tibetan.date_diff(730839, 730739)
  -100
  iex>Elixir.Tibetan.date_diff({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  100
  iex>Elixir.Tibetan.date_diff({2128, 11, false, 6, false}, {2128, 7, false, 23, false})
  -100
  iex>Elixir.Tibetan.date_diff(730739, {2128, 11, false, 6, false})
  100
  iex>Elixir.Tibetan.date_diff({2128, 7, false, 23, false}, 730839)
  100

day(cal_date, type \\ :value)

Specs

day(fixed() | tibetan_date(), :atom | :index | :name | :value) ::
  :atom | integer() | String.t() | number()

Returns the day field of a Tibetan date.

The type parameter determines the type of the returned day:

:atom returns the internal name of day,
:index returns the position of the day field within the date,
:name returns the common name of the day,
:value returns the value of the day (default).

Examples

  iex>Elixir.Tibetan.day(730739)
  23
  iex>Elixir.Tibetan.day(730739, :atom)
  :day
  iex>Elixir.Tibetan.day(730739, :index)
  3
  iex>Elixir.Tibetan.day(730739, :name)
  "Day"
  iex>Elixir.Tibetan.day(730739, :value)
  23

  iex>Elixir.Tibetan.day({2128, 7, false, 23, false})
  23
  iex>Elixir.Tibetan.day({2128, 7, false, 23, false}, :atom)
  :day
  iex>Elixir.Tibetan.day({2128, 7, false, 23, false}, :index)
  3
  iex>Elixir.Tibetan.day({2128, 7, false, 23, false}, :name)
  "Day"
  iex>Elixir.Tibetan.day({2128, 7, false, 23, false}, :value)
  23

epoch()

Specs

epoch() :: number()

Returns the epoch of the Tibetan calendar.

Example

  iex>Elixir.Tibetan.epoch()
  -46410

eq(date1, date2)

Specs

eq(tibetan_date(), tibetan_date()) :: boolean()

Returns true if Tibetan date1 is equal Tibetan date2, otherwise false.

Examples

  iex>Elixir.Tibetan.eq({2128, 7, false, 23, false}, {2128, 7, false, 23, false})
  true
  iex>Elixir.Tibetan.eq({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  false
  iex>Elixir.Tibetan.eq({2128, 11, false, 6, false}, {2128, 7, false, 23, false})
  false

field_atom(field_index)

Specs

field_atom(integer()) :: atom()

Returns the name of the field atom in a Tibetan date at field_index.

Examples

  iex>Elixir.Tibetan.field_atom(0)
  :year
  iex>Elixir.Tibetan.field_atom(1)
  :month
  iex>Elixir.Tibetan.field_atom(2)
  :leap_month
  iex>Elixir.Tibetan.field_atom(3)
  :day
  iex>Elixir.Tibetan.field_atom(4)
  :leap_day

field_atoms()

Specs

field_atoms() :: [atom()]

Returns a list of the field atoms (names) of a Tibetan date.

Example

  iex>Elixir.Tibetan.field_atoms()
  [:year, :month, :leap_month, :day, :leap_day]

field_count()

Specs

field_count() :: integer()

Returns the number of fields in a Tibetan date

Example

  iex>Elixir.Tibetan.field_count()
  5

field_index(field_atom)

Specs

field_index(atom()) :: integer()

Returns the index (= position) of the field_atom in a Tibetan date.

Examples

  iex>Elixir.Tibetan.field_index(:year)
  0
  iex>Elixir.Tibetan.field_index(:month)
  1
  iex>Elixir.Tibetan.field_index(:leap_month)
  2
  iex>Elixir.Tibetan.field_index(:day)
  3
  iex>Elixir.Tibetan.field_index(:leap_day)
  4

from_date(other_date, other_calendar)

Specs

from_date(tuple(), module()) :: tibetan_date()

from_date(tuple(), module()) :: {:error, String.t()}

Converts the other_date of the other_calendar into the equivalent date of the Tibetan calendar.

Example

  iex>Elixir.Tibetan.from_date({2001, 9, 11}, Gregorian)
  {2128, 7, false, 23, false}

from_fixed(fixed)

Specs

from_fixed(fixed()) :: tibetan_date()

Converts a fixed day to a Tibetan date.

Example

  iex>Elixir.Tibetan.from_fixed(730739)
  {2128, 7, false, 23, false}

from_jd(day)

Specs

from_jd(tuple() | number()) :: tibetan_date()

Converts a Julian Day into the equivalent Tibetan date.

The Julian Day can be given as a tuple or by a Julian day.

Examples

  iex>Elixir.Tibetan.from_jd({2452163.5})
  {2128, 7, false, 23, false}
  iex>Elixir.Tibetan.from_jd(2452163.5)
  {2128, 7, false, 23, false}

from_rata_die(rd)

Specs

from_rata_die(tuple() | integer()) :: tibetan_date()

Converts a RataDie date into the equivalent Tibetan date.

The RataDie date can be given as a tuple or by a RataDie rd.

Examples

  iex>Elixir.Tibetan.from_rata_die({730739})
  {2128, 7, false, 23, false}
  iex>Elixir.Tibetan.from_rata_die(730739)
  {2128, 7, false, 23, false}

from_unix(unix_date)

Specs

from_unix(tuple() | integer()) :: tibetan_date()

Converts a Unix date into the equivalent Tibetan date.

The Unix date can be given as a tuple or by Unix seconds.

Examples

  iex>Elixir.Tibetan.from_unix({1000166400})
  {2128, 7, false, 23, false}
  iex>Elixir.Tibetan.from_unix(1000166400)
  {2128, 7, false, 23, false}

ge(date1, date2)

Specs

ge(tibetan_date(), tibetan_date()) :: boolean()

Returns true if Tibetan date1 is greater (= later) than or equal Tibetan date2, otherwise false.

Examples

  iex>Elixir.Tibetan.ge({2128, 7, false, 23, false}, {2128, 7, false, 23, false})
  true
  iex>Elixir.Tibetan.ge({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  false
  iex>Elixir.Tibetan.ge({2128, 11, false, 6, false}, {2128, 7, false, 23, false})
  true

gt(date1, date2)

Specs

gt(tibetan_date(), tibetan_date()) :: boolean()

Returns true if Tibetan date1 is greater (= later) than Tibetan date2, otherwise false.

Examples

  iex>Elixir.Tibetan.gt({2128, 7, false, 23, false}, {2128, 7, false, 23, false})
  false
  iex>Elixir.Tibetan.gt({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  false
  iex>Elixir.Tibetan.gt({2128, 11, false, 6, false}, {2128, 7, false, 23, false})
  true

holidays(type \\ :name)

Returns a list of the holidays of the Tibetan calendar.

The type parameter determines the type of the returned holidays:

:atom returns the internal names of the holidays,
:name returns the common names of the holidays (default).

Examples

  iex>Elixir.Tibetan.holidays()
  ["Losar"]
  iex>Elixir.Tibetan.holidays(:atom)
  [:tibetan_new_year]
  iex>Elixir.Tibetan.holidays(:name)
  ["Losar"]

keyword()

Specs

keyword() :: atom()

Returns the internal keyword of the Tibetan calendar.

Example

  iex>Elixir.Tibetan.keyword()
  :tibetan

le(date1, date2)

Specs

le(tibetan_date(), tibetan_date()) :: boolean()

Returns true if Tibetan date1 is smaller (= earlier) than or equal Tibetan date2, otherwise false.

Examples

  iex>Elixir.Tibetan.le({2128, 7, false, 23, false}, {2128, 7, false, 23, false})
  true
  iex>Elixir.Tibetan.le({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  true
  iex>Elixir.Tibetan.le({2128, 11, false, 6, false}, {2128, 7, false, 23, false})
  false

leap_day(cal_date, type \\ :value)

Specs

leap_day(fixed() | tibetan_date(), :atom | :index | :name | :value) ::
  :atom | integer() | String.t() | number()

Returns the leap_day field of a Tibetan date.

The type parameter determines the type of the returned leap_day:

:atom returns the internal name of leap_day,
:index returns the position of the leap_day field within the date,
:name returns the common name of the leap_day,
:value returns the value of the leap_day (default).

Examples

  iex>Elixir.Tibetan.leap_day(730739)
  false
  iex>Elixir.Tibetan.leap_day(730739, :atom)
  :leap_day
  iex>Elixir.Tibetan.leap_day(730739, :index)
  4
  iex>Elixir.Tibetan.leap_day(730739, :name)
  "Leap_day"
  iex>Elixir.Tibetan.leap_day(730739, :value)
  false

  iex>Elixir.Tibetan.leap_day({2128, 7, false, 23, false})
  false
  iex>Elixir.Tibetan.leap_day({2128, 7, false, 23, false}, :atom)
  :leap_day
  iex>Elixir.Tibetan.leap_day({2128, 7, false, 23, false}, :index)
  4
  iex>Elixir.Tibetan.leap_day({2128, 7, false, 23, false}, :name)
  "Leap_day"
  iex>Elixir.Tibetan.leap_day({2128, 7, false, 23, false}, :value)
  false

leap_month(cal_date, type \\ :value)

Specs

leap_month(fixed() | tibetan_date(), :atom | :index | :name | :value) ::
  :atom | integer() | String.t() | number()

Returns the leap_month field of a Tibetan date.

The type parameter determines the type of the returned leap_month:

:atom returns the internal name of leap_month,
:index returns the position of the leap_month field within the date,
:name returns the common name of the leap_month,
:value returns the value of the leap_month (default).

Examples

  iex>Elixir.Tibetan.leap_month(730739)
  false
  iex>Elixir.Tibetan.leap_month(730739, :atom)
  :leap_month
  iex>Elixir.Tibetan.leap_month(730739, :index)
  2
  iex>Elixir.Tibetan.leap_month(730739, :name)
  "Leap_month"
  iex>Elixir.Tibetan.leap_month(730739, :value)
  false

  iex>Elixir.Tibetan.leap_month({2128, 7, false, 23, false})
  false
  iex>Elixir.Tibetan.leap_month({2128, 7, false, 23, false}, :atom)
  :leap_month
  iex>Elixir.Tibetan.leap_month({2128, 7, false, 23, false}, :index)
  2
  iex>Elixir.Tibetan.leap_month({2128, 7, false, 23, false}, :name)
  "Leap_month"
  iex>Elixir.Tibetan.leap_month({2128, 7, false, 23, false}, :value)
  false

lt(date1, date2)

Specs

lt(tibetan_date(), tibetan_date()) :: boolean()

Returns true if Tibetan date1 is smaller (= earlier) than Tibetan date2, otherwise false.

Examples

  iex>Elixir.Tibetan.lt({2128, 7, false, 23, false}, {2128, 7, false, 23, false})
  false
  iex>Elixir.Tibetan.lt({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  true
  iex>Elixir.Tibetan.lt({2128, 11, false, 6, false}, {2128, 7, false, 23, false})
  false

module()

Specs

module() :: module()

Returns the module of the Tibetan calendar.

Example

  iex>Elixir.Tibetan.module()
  Tibetan

month(cal_date, type \\ :value)

Specs

month(fixed() | tibetan_date(), :atom | :index | :name | :value) ::
  :atom | integer() | String.t() | number()

Returns the month field of a Tibetan date.

The type parameter determines the type of the returned month:

:atom returns the internal name of month,
:index returns the position of the month field within the date,
:name returns the common name of the month,
:value returns the value of the month (default).

Examples

  iex>Elixir.Tibetan.month(730739)
  7
  iex>Elixir.Tibetan.month(730739, :atom)
  :month
  iex>Elixir.Tibetan.month(730739, :index)
  1
  iex>Elixir.Tibetan.month(730739, :name)
  "Month"
  iex>Elixir.Tibetan.month(730739, :value)
  7

  iex>Elixir.Tibetan.month({2128, 7, false, 23, false})
  7
  iex>Elixir.Tibetan.month({2128, 7, false, 23, false}, :atom)
  :month
  iex>Elixir.Tibetan.month({2128, 7, false, 23, false}, :index)
  1
  iex>Elixir.Tibetan.month({2128, 7, false, 23, false}, :name)
  "Month"
  iex>Elixir.Tibetan.month({2128, 7, false, 23, false}, :value)
  7

name()

Specs

name() :: atom()

Returns the internal name of the Tibetan calendar.

Example

  iex>Elixir.Tibetan.name()
  "Tibetan"

range(date1, date2)

Specs

range(tibetan_date(), tibetan_date()) :: integer()

Returns the distance between two Tibetan dates as a range of fixed days.

Example

  iex>Elixir.Tibetan.range({2128, 7, false, 23, false}, {2128, 11, false, 6, false})
  730739..730839

start_of_day()

Specs

start_of_day() :: :midnight | :sunset | :sunrise | :noon

Returns the start of the day in the Tibetan calendar.

Possible return values are:

:midnight,
:noon,
:sunrise,
:sunset,

Example

  iex>Elixir.Tibetan.start_of_day()
  :midnight

tibetan_new_year(gregorian_year)

Specs

tibetan_new_year(Gregorian.gregorian_year()) :: fixed() | tibetan_date()

Returns the fixed date of Losar of the Tibetan calendar in the given gregorian_year or [], if there is no such holiday in that year.

The type parameter determines the type of the returned value:

:fixed returns a fixed day (default),
:date returns a Tibetan date.

Example

  iex>Elixir.Tibetan.tibetan_new_year(2001)
  {2001, 2, 24}

to_date(date, other_calendar)

Specs

to_date(tibetan_date(), module()) :: tuple()

Converts a Tibetan date into the equivalent date of the other_calendar.

For the following example to work the Gregorian calendar must be available.

Example

  iex>Elixir.Tibetan.to_date({2128, 7, false, 23, false}, Gregorian)
  {2001, 9, 11}

to_fixed(date)

Specs

to_fixed(tibetan_date()) :: fixed()

Converts a Tibetan date tuple into a fixed day.

Example

  iex>Elixir.Tibetan.to_fixed({2128, 7, false, 23, false})
  730739

to_fixed(year, month, leap_month, day, leap_day)

Specs

to_fixed(
  tibetan_year(),
  tibetan_month(),
  tibetan_leap_month(),
  tibetan_day(),
  tibetan_leap_day()
) :: fixed()

Converts a Tibetan date given by year, month, leap_month, day, leap_day into a fixed day.

Example

  iex>Elixir.Tibetan.to_fixed(2128, 7, false, 23, false)
  730739

to_jd(cal_date)

Specs

to_jd(tibetan_date()) :: {number()}

Converts a Tibetan date into the equivalent Julian Day.

Example

  iex>Elixir.Tibetan.to_jd({2128, 7, false, 23, false})
  {2452163.5}

to_jd(year, month, leap_month, day, leap_day)

Specs

to_jd(
  tibetan_year(),
  tibetan_month(),
  tibetan_leap_month(),
  tibetan_day(),
  tibetan_leap_day()
) :: {number()}

Converts a Tibetan date given by year, month, leap_month, day, leap_day into the equivalent Julian Day.

Example

  iex>Elixir.Tibetan.to_jd(2128, 7, false, 23, false)
  {2452163.5}

to_rata_die(date)

Specs

to_rata_die(tibetan_date()) :: {integer()}

Converts a Tibetan date into the equivalent RataDie date.

Example

  iex>Elixir.Tibetan.to_rata_die({2128, 7, false, 23, false})
  {730739}

to_rata_die(year, month, leap_month, day, leap_day)

Specs

to_rata_die(
  tibetan_year(),
  tibetan_month(),
  tibetan_leap_month(),
  tibetan_day(),
  tibetan_leap_day()
) :: {integer()}

Converts a Tibetan date given by year, month, leap_month, day, leap_day into the equivalent RataDie date.

Example

  iex>Elixir.Tibetan.to_rata_die(2128, 7, false, 23, false)
  {730739}

to_unix(cal_date)

Specs

to_unix(tibetan_date()) :: {integer()}

Converts a Tibetan date into the equivalent Unix date.

Example

  iex>Elixir.Tibetan.to_unix({2128, 7, false, 23, false})
  {1000166400}

to_unix(year, month, leap_month, day, leap_day)

Specs

to_unix(
  tibetan_year(),
  tibetan_month(),
  tibetan_leap_month(),
  tibetan_day(),
  tibetan_leap_day()
) :: {integer()}

Converts a Tibetan date given by year, month, leap_month, day, leap_day into the equivalent Unix date.

Example

  iex>Elixir.Tibetan.to_unix(2128, 7, false, 23, false)
  {1000166400}

today(type \\ :fixed)

Specs

today(:fixed | :date) :: fixed() | tibetan_date()

Returns the current date either as a fixed day or a Tibetan date.

(This cannot be doctested, because today is a moving target.)

The type parameter determines the type of the returned value:

:fixed returns a fixed day (default),
:date returns a Tibetan date.

Examples

  Elixir.Tibetan.today()
  730739
  Elixir.Tibetan.today(:fixed)
  730739
  Elixir.Tibetan.today(:date)
  {2128, 7, false, 23, false}

year(cal_date, type \\ :value)

Specs

year(fixed() | tibetan_date(), :atom | :index | :name | :value) ::
  :atom | integer() | String.t() | number()

Returns the year field of a Tibetan date.

The type parameter determines the type of the returned year:

:atom returns the internal name of year,
:index returns the position of the year field within the date,
:name returns the common name of the year,
:value returns the value of the year (default).

Examples

  iex>Elixir.Tibetan.year(730739)
  2128
  iex>Elixir.Tibetan.year(730739, :atom)
  :year
  iex>Elixir.Tibetan.year(730739, :index)
  0
  iex>Elixir.Tibetan.year(730739, :name)
  "Year"
  iex>Elixir.Tibetan.year(730739, :value)
  2128

  iex>Elixir.Tibetan.year({2128, 7, false, 23, false})
  2128
  iex>Elixir.Tibetan.year({2128, 7, false, 23, false}, :atom)
  :year
  iex>Elixir.Tibetan.year({2128, 7, false, 23, false}, :index)
  0
  iex>Elixir.Tibetan.year({2128, 7, false, 23, false}, :name)
  "Year"
  iex>Elixir.Tibetan.year({2128, 7, false, 23, false}, :value)
  2128