Specs

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

Adds the number of days to a fixed day or Ethiopic 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 Ethiopic date.

Examples

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

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

  iex>Elixir.Ethiopic.add_days(730739, 100, :date)
  {1994, 4, 11}
  iex>Elixir.Ethiopic.add_days(730739, -100, :date)
  {1993, 9, 26}

  iex>Elixir.Ethiopic.add_days({1994, 1, 1}, 100)
  730839
  iex>Elixir.Ethiopic.add_days({1994, 1, 1}, -100)
  730639

  iex>Elixir.Ethiopic.add_days({1994, 1, 1}, 100, :fixed)
  730839
  iex>Elixir.Ethiopic.add_days({1994, 1, 1}, -100, :fixed)
  730639

  iex>Elixir.Ethiopic.add_days({1994, 1, 1}, 100, :date)
  {1994, 4, 11}
  iex>Elixir.Ethiopic.add_days({1994, 1, 1}, -100, :date)
  {1993, 9, 26}

Specs

as_date(fixed() | ethiopic_date()) :: ethiopic_date()

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

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.Ethiopic.as_date(730739)
  {1994, 1, 1}
  iex>Elixir.Ethiopic.as_date({1994, 1, 1})
  {1994, 1, 1}

Specs

as_fixed(fixed() | ethiopic_date()) :: fixed()

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

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.Ethiopic.as_fixed(730739)
  730739
  iex>Elixir.Ethiopic.as_fixed({1994, 1, 1})
  730739

Specs

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

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

The type parameter determines the type of the returned value:

• :fixed returns a fixed day (default),
• :date returns a Ethiopic date.

Examples

  iex>Elixir.Ethiopic.as_type(730739)
  730739
  iex>Elixir.Ethiopic.as_type(730739, :fixed)
  730739
  iex>Elixir.Ethiopic.as_type(730739, :date)
  {1994, 1, 1}
  iex>Elixir.Ethiopic.as_type({1994, 1, 1})
  730739
  iex>Elixir.Ethiopic.as_type({1994, 1, 1}, :fixed)
  730739
  iex>Elixir.Ethiopic.as_type({1994, 1, 1}, :date)
  {1994, 1, 1}

Specs

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

Compares two Ethiopic 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.Ethiopic.compare({1994, 1, 1}, {1994, 1, 1})
  :eq
  iex>Elixir.Ethiopic.compare({1994, 1, 1}, {1994, 4, 11})
  :lt
  iex>Elixir.Ethiopic.compare({1994, 4, 11}, {1994, 1, 1})
  :gt

Specs

date(ethiopic_year(), ethiopic_month(), ethiopic_day()) :: t()

Returns a Ethiopic date from its fields year, month, day.

Example

  iex>Elixir.Ethiopic.date(1994, 1, 1)
  {1994, 1, 1}

Specs

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

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

The dates can be given as fixed days or Ethiopic 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.Ethiopic.date_diff(730739, 730839)
  100
  iex>Elixir.Ethiopic.date_diff(730839, 730739)
  -100
  iex>Elixir.Ethiopic.date_diff({1994, 1, 1}, {1994, 4, 11})
  100
  iex>Elixir.Ethiopic.date_diff({1994, 4, 11}, {1994, 1, 1})
  -100
  iex>Elixir.Ethiopic.date_diff(730739, {1994, 4, 11})
  100
  iex>Elixir.Ethiopic.date_diff({1994, 1, 1}, 730839)
  100

Specs

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

Returns the day field of a Ethiopic 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.Ethiopic.day(730739)
  1
  iex>Elixir.Ethiopic.day(730739, :atom)
  :day
  iex>Elixir.Ethiopic.day(730739, :index)
  2
  iex>Elixir.Ethiopic.day(730739, :name)
  "Day"
  iex>Elixir.Ethiopic.day(730739, :value)
  1

  iex>Elixir.Ethiopic.day({1994, 1, 1})
  1
  iex>Elixir.Ethiopic.day({1994, 1, 1}, :atom)
  :day
  iex>Elixir.Ethiopic.day({1994, 1, 1}, :index)
  2
  iex>Elixir.Ethiopic.day({1994, 1, 1}, :name)
  "Day"
  iex>Elixir.Ethiopic.day({1994, 1, 1}, :value)
  1

Specs

epoch() :: number()

Returns the epoch of the Ethiopic calendar.

Example

  iex>Elixir.Ethiopic.epoch()
  2796

Specs

eq(ethiopic_date(), ethiopic_date()) :: boolean()

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

Examples

  iex>Elixir.Ethiopic.eq({1994, 1, 1}, {1994, 1, 1})
  true
  iex>Elixir.Ethiopic.eq({1994, 1, 1}, {1994, 4, 11})
  false
  iex>Elixir.Ethiopic.eq({1994, 4, 11}, {1994, 1, 1})
  false

Specs

field_atom(integer()) :: atom()

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

Examples

  iex>Elixir.Ethiopic.field_atom(0)
  :year
  iex>Elixir.Ethiopic.field_atom(1)
  :month
  iex>Elixir.Ethiopic.field_atom(2)
  :day

Specs

field_atoms() :: [atom()]

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

Example

  iex>Elixir.Ethiopic.field_atoms()
  [:year, :month, :day]

Specs

field_count() :: integer()

Returns the number of fields in a Ethiopic date

Example

  iex>Elixir.Ethiopic.field_count()
  3

Specs

field_index(atom()) :: integer()

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

Examples

  iex>Elixir.Ethiopic.field_index(:year)
  0
  iex>Elixir.Ethiopic.field_index(:month)
  1
  iex>Elixir.Ethiopic.field_index(:day)
  2

Specs

from_date(tuple(), module()) :: ethiopic_date()

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

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

Example

  iex>Elixir.Ethiopic.from_date({2001, 9, 11}, Gregorian)
  {1994, 1, 1}

Specs

from_fixed(fixed()) :: ethiopic_date()

Converts a fixed day to a Ethiopic date.

Example

  iex>Elixir.Ethiopic.from_fixed(730739)
  {1994, 1, 1}

Specs

from_jd(tuple() | number()) :: ethiopic_date()

Converts a Julian Day into the equivalent Ethiopic date.

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

Examples

  iex>Elixir.Ethiopic.from_jd({2452163.5})
  {1994, 1, 1}
  iex>Elixir.Ethiopic.from_jd(2452163.5)
  {1994, 1, 1}

Specs

from_rata_die(tuple() | integer()) :: ethiopic_date()

Converts a RataDie date into the equivalent Ethiopic date.

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

Examples

  iex>Elixir.Ethiopic.from_rata_die({730739})
  {1994, 1, 1}
  iex>Elixir.Ethiopic.from_rata_die(730739)
  {1994, 1, 1}

Specs

from_unix(tuple() | integer()) :: ethiopic_date()

Converts a Unix date into the equivalent Ethiopic date.

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

Examples

  iex>Elixir.Ethiopic.from_unix({1000166400})
  {1994, 1, 1}
  iex>Elixir.Ethiopic.from_unix(1000166400)
  {1994, 1, 1}

Specs

ge(ethiopic_date(), ethiopic_date()) :: boolean()

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

Examples

  iex>Elixir.Ethiopic.ge({1994, 1, 1}, {1994, 1, 1})
  true
  iex>Elixir.Ethiopic.ge({1994, 1, 1}, {1994, 4, 11})
  false
  iex>Elixir.Ethiopic.ge({1994, 4, 11}, {1994, 1, 1})
  true

Specs

gt(ethiopic_date(), ethiopic_date()) :: boolean()

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

Examples

  iex>Elixir.Ethiopic.gt({1994, 1, 1}, {1994, 1, 1})
  false
  iex>Elixir.Ethiopic.gt({1994, 1, 1}, {1994, 4, 11})
  false
  iex>Elixir.Ethiopic.gt({1994, 4, 11}, {1994, 1, 1})
  true

Specs

keyword() :: atom()

Returns the internal keyword of the Ethiopic calendar.

Example

  iex>Elixir.Ethiopic.keyword()
  :ethiopic

Specs

le(ethiopic_date(), ethiopic_date()) :: boolean()

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

Examples

  iex>Elixir.Ethiopic.le({1994, 1, 1}, {1994, 1, 1})
  true
  iex>Elixir.Ethiopic.le({1994, 1, 1}, {1994, 4, 11})
  true
  iex>Elixir.Ethiopic.le({1994, 4, 11}, {1994, 1, 1})
  false

Specs

lt(ethiopic_date(), ethiopic_date()) :: boolean()

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

Examples

  iex>Elixir.Ethiopic.lt({1994, 1, 1}, {1994, 1, 1})
  false
  iex>Elixir.Ethiopic.lt({1994, 1, 1}, {1994, 4, 11})
  true
  iex>Elixir.Ethiopic.lt({1994, 4, 11}, {1994, 1, 1})
  false

Specs

module() :: module()

Returns the module of the Ethiopic calendar.

Example

  iex>Elixir.Ethiopic.module()
  Ethiopic

Specs

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

Returns the month field of a Ethiopic 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.Ethiopic.month(730739)
  1
  iex>Elixir.Ethiopic.month(730739, :atom)
  :month
  iex>Elixir.Ethiopic.month(730739, :index)
  1
  iex>Elixir.Ethiopic.month(730739, :name)
  "Month"
  iex>Elixir.Ethiopic.month(730739, :value)
  1

  iex>Elixir.Ethiopic.month({1994, 1, 1})
  1
  iex>Elixir.Ethiopic.month({1994, 1, 1}, :atom)
  :month
  iex>Elixir.Ethiopic.month({1994, 1, 1}, :index)
  1
  iex>Elixir.Ethiopic.month({1994, 1, 1}, :name)
  "Month"
  iex>Elixir.Ethiopic.month({1994, 1, 1}, :value)
  1

Specs

name() :: atom()

Returns the internal name of the Ethiopic calendar.

Example

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

Specs

range(ethiopic_date(), ethiopic_date()) :: integer()

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

Example

  iex>Elixir.Ethiopic.range({1994, 1, 1}, {1994, 4, 11})
  730739..730839

Specs

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

Returns the start of the day in the Ethiopic calendar.

Possible return values are:

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

Example

  iex>Elixir.Ethiopic.start_of_day()
  :midnight

Specs

to_date(ethiopic_date(), module()) :: tuple()

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

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

Example

  iex>Elixir.Ethiopic.to_date({1994, 1, 1}, Gregorian)
  {2001, 9, 11}

Specs

to_fixed(ethiopic_date()) :: fixed()

Converts a Ethiopic date tuple into a fixed day.

Example

  iex>Elixir.Ethiopic.to_fixed({1994, 1, 1})
  730739

Specs

to_fixed(ethiopic_year(), ethiopic_month(), ethiopic_day()) :: fixed()

Converts a Ethiopic date given by year, month, day into a fixed day.

Example

  iex>Elixir.Ethiopic.to_fixed(1994, 1, 1)
  730739

Specs

to_jd(ethiopic_date()) :: {number()}

Converts a Ethiopic date into the equivalent Julian Day.

Example

  iex>Elixir.Ethiopic.to_jd({1994, 1, 1})
  {2452163.5}

Specs

to_jd(ethiopic_year(), ethiopic_month(), ethiopic_day()) :: {number()}

Converts a Ethiopic date given by year, month, day into the equivalent Julian Day.

Example

  iex>Elixir.Ethiopic.to_jd(1994, 1, 1)
  {2452163.5}

Specs

to_rata_die(ethiopic_date()) :: {integer()}

Converts a Ethiopic date into the equivalent RataDie date.

Example

  iex>Elixir.Ethiopic.to_rata_die({1994, 1, 1})
  {730739}

Specs

to_rata_die(ethiopic_year(), ethiopic_month(), ethiopic_day()) :: {integer()}

Converts a Ethiopic date given by year, month, day into the equivalent RataDie date.

Example

  iex>Elixir.Ethiopic.to_rata_die(1994, 1, 1)
  {730739}

Specs

to_unix(ethiopic_date()) :: {integer()}

Converts a Ethiopic date into the equivalent Unix date.

Example

  iex>Elixir.Ethiopic.to_unix({1994, 1, 1})
  {1000166400}

Specs

to_unix(ethiopic_year(), ethiopic_month(), ethiopic_day()) :: {integer()}

Converts a Ethiopic date given by year, month, day into the equivalent Unix date.

Example

  iex>Elixir.Ethiopic.to_unix(1994, 1, 1)
  {1000166400}

Specs

today(:fixed | :date) :: fixed() | ethiopic_date()

Returns the current date either as a fixed day or a Ethiopic 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 Ethiopic date.

Examples

  Elixir.Ethiopic.today()
  730739
  Elixir.Ethiopic.today(:fixed)
  730739
  Elixir.Ethiopic.today(:date)
  {1994, 1, 1}

Specs

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

Returns the year field of a Ethiopic 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.Ethiopic.year(730739)
  1994
  iex>Elixir.Ethiopic.year(730739, :atom)
  :year
  iex>Elixir.Ethiopic.year(730739, :index)
  0
  iex>Elixir.Ethiopic.year(730739, :name)
  "Year"
  iex>Elixir.Ethiopic.year(730739, :value)
  1994

  iex>Elixir.Ethiopic.year({1994, 1, 1})
  1994
  iex>Elixir.Ethiopic.year({1994, 1, 1}, :atom)
  :year
  iex>Elixir.Ethiopic.year({1994, 1, 1}, :index)
  0
  iex>Elixir.Ethiopic.year({1994, 1, 1}, :name)
  "Year"
  iex>Elixir.Ethiopic.year({1994, 1, 1}, :value)
  1994