Specs

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

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

Examples

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

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

  iex>Elixir.ObservationalIslamic.add_days(730739, 100, :date)
  {1422, 10, 4}
  iex>Elixir.ObservationalIslamic.add_days(730739, -100, :date)
  {1422, 3, 10}

  iex>Elixir.ObservationalIslamic.add_days({1422, 6, 22}, 100)
  730839
  iex>Elixir.ObservationalIslamic.add_days({1422, 6, 22}, -100)
  730639

  iex>Elixir.ObservationalIslamic.add_days({1422, 6, 22}, 100, :fixed)
  730839
  iex>Elixir.ObservationalIslamic.add_days({1422, 6, 22}, -100, :fixed)
  730639

  iex>Elixir.ObservationalIslamic.add_days({1422, 6, 22}, 100, :date)
  {1422, 10, 4}
  iex>Elixir.ObservationalIslamic.add_days({1422, 6, 22}, -100, :date)
  {1422, 3, 10}

Specs

as_date(fixed() | observational_islamic_date()) :: observational_islamic_date()

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

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.ObservationalIslamic.as_date(730739)
  {1422, 6, 22}
  iex>Elixir.ObservationalIslamic.as_date({1422, 6, 22})
  {1422, 6, 22}

Specs

as_fixed(fixed() | observational_islamic_date()) :: fixed()

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

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.ObservationalIslamic.as_fixed(730739)
  730739
  iex>Elixir.ObservationalIslamic.as_fixed({1422, 6, 22})
  730739

Specs

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

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

The type parameter determines the type of the returned value:

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

Examples

  iex>Elixir.ObservationalIslamic.as_type(730739)
  730739
  iex>Elixir.ObservationalIslamic.as_type(730739, :fixed)
  730739
  iex>Elixir.ObservationalIslamic.as_type(730739, :date)
  {1422, 6, 22}
  iex>Elixir.ObservationalIslamic.as_type({1422, 6, 22})
  730739
  iex>Elixir.ObservationalIslamic.as_type({1422, 6, 22}, :fixed)
  730739
  iex>Elixir.ObservationalIslamic.as_type({1422, 6, 22}, :date)
  {1422, 6, 22}

Specs

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

Compares two ObservationalIslamic 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.ObservationalIslamic.compare({1422, 6, 22}, {1422, 6, 22})
  :eq
  iex>Elixir.ObservationalIslamic.compare({1422, 6, 22}, {1422, 10, 4})
  :lt
  iex>Elixir.ObservationalIslamic.compare({1422, 10, 4}, {1422, 6, 22})
  :gt

Specs

date(
  observational_islamic_year(),
  observational_islamic_month(),
  observational_islamic_day()
) :: t()

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

Example

  iex>Elixir.ObservationalIslamic.date(1422, 6, 22)
  {1422, 6, 22}

Specs

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

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

The dates can be given as fixed days or ObservationalIslamic 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.ObservationalIslamic.date_diff(730739, 730839)
  100
  iex>Elixir.ObservationalIslamic.date_diff(730839, 730739)
  -100
  iex>Elixir.ObservationalIslamic.date_diff({1422, 6, 22}, {1422, 10, 4})
  100
  iex>Elixir.ObservationalIslamic.date_diff({1422, 10, 4}, {1422, 6, 22})
  -100
  iex>Elixir.ObservationalIslamic.date_diff(730739, {1422, 10, 4})
  100
  iex>Elixir.ObservationalIslamic.date_diff({1422, 6, 22}, 730839)
  100

Specs

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

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

  iex>Elixir.ObservationalIslamic.day({1422, 6, 22})
  22
  iex>Elixir.ObservationalIslamic.day({1422, 6, 22}, :atom)
  :day
  iex>Elixir.ObservationalIslamic.day({1422, 6, 22}, :index)
  2
  iex>Elixir.ObservationalIslamic.day({1422, 6, 22}, :name)
  "Day"
  iex>Elixir.ObservationalIslamic.day({1422, 6, 22}, :value)
  22

Specs

eq(observational_islamic_date(), observational_islamic_date()) :: boolean()

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

Examples

  iex>Elixir.ObservationalIslamic.eq({1422, 6, 22}, {1422, 6, 22})
  true
  iex>Elixir.ObservationalIslamic.eq({1422, 6, 22}, {1422, 10, 4})
  false
  iex>Elixir.ObservationalIslamic.eq({1422, 10, 4}, {1422, 6, 22})
  false

Specs

field_atom(integer()) :: atom()

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

Examples

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

Specs

field_atoms() :: [atom()]

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

Example

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

Specs

field_count() :: integer()

Returns the number of fields in a ObservationalIslamic date

Example

  iex>Elixir.ObservationalIslamic.field_count()
  3

Specs

field_index(atom()) :: integer()

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

Examples

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

Specs

from_date(tuple(), module()) :: observational_islamic_date()

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

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

Example

  iex>Elixir.ObservationalIslamic.from_date({2001, 9, 11}, Gregorian)
  {1422, 6, 22}

Specs

from_fixed(fixed()) :: observational_islamic_date()

Converts a fixed day to a ObservationalIslamic date.

Example

  iex>Elixir.ObservationalIslamic.from_fixed(730739)
  {1422, 6, 22}

Specs

from_jd(tuple() | number()) :: observational_islamic_date()

Converts a Julian Day into the equivalent ObservationalIslamic date.

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

Examples

  iex>Elixir.ObservationalIslamic.from_jd({2452163.5})
  {1422, 6, 22}
  iex>Elixir.ObservationalIslamic.from_jd(2452163.5)
  {1422, 6, 22}

Specs

from_rata_die(tuple() | integer()) :: observational_islamic_date()

Converts a RataDie date into the equivalent ObservationalIslamic date.

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

Examples

  iex>Elixir.ObservationalIslamic.from_rata_die({730739})
  {1422, 6, 22}
  iex>Elixir.ObservationalIslamic.from_rata_die(730739)
  {1422, 6, 22}

Specs

from_unix(tuple() | integer()) :: observational_islamic_date()

Converts a Unix date into the equivalent ObservationalIslamic date.

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

Examples

  iex>Elixir.ObservationalIslamic.from_unix({1000166400})
  {1422, 6, 22}
  iex>Elixir.ObservationalIslamic.from_unix(1000166400)
  {1422, 6, 22}

Specs

ge(observational_islamic_date(), observational_islamic_date()) :: boolean()

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

Examples

  iex>Elixir.ObservationalIslamic.ge({1422, 6, 22}, {1422, 6, 22})
  true
  iex>Elixir.ObservationalIslamic.ge({1422, 6, 22}, {1422, 10, 4})
  false
  iex>Elixir.ObservationalIslamic.ge({1422, 10, 4}, {1422, 6, 22})
  true

Specs

gt(observational_islamic_date(), observational_islamic_date()) :: boolean()

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

Examples

  iex>Elixir.ObservationalIslamic.gt({1422, 6, 22}, {1422, 6, 22})
  false
  iex>Elixir.ObservationalIslamic.gt({1422, 6, 22}, {1422, 10, 4})
  false
  iex>Elixir.ObservationalIslamic.gt({1422, 10, 4}, {1422, 6, 22})
  true

Specs

keyword() :: atom()

Returns the internal keyword of the ObservationalIslamic calendar.

Example

  iex>Elixir.ObservationalIslamic.keyword()
  :observational_islamic

Specs

le(observational_islamic_date(), observational_islamic_date()) :: boolean()

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

Examples

  iex>Elixir.ObservationalIslamic.le({1422, 6, 22}, {1422, 6, 22})
  true
  iex>Elixir.ObservationalIslamic.le({1422, 6, 22}, {1422, 10, 4})
  true
  iex>Elixir.ObservationalIslamic.le({1422, 10, 4}, {1422, 6, 22})
  false

Specs

lt(observational_islamic_date(), observational_islamic_date()) :: boolean()

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

Examples

  iex>Elixir.ObservationalIslamic.lt({1422, 6, 22}, {1422, 6, 22})
  false
  iex>Elixir.ObservationalIslamic.lt({1422, 6, 22}, {1422, 10, 4})
  true
  iex>Elixir.ObservationalIslamic.lt({1422, 10, 4}, {1422, 6, 22})
  false

Specs

module() :: module()

Returns the module of the ObservationalIslamic calendar.

Example

  iex>Elixir.ObservationalIslamic.module()
  ObservationalIslamic

Specs

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

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

  iex>Elixir.ObservationalIslamic.month({1422, 6, 22})
  6
  iex>Elixir.ObservationalIslamic.month({1422, 6, 22}, :atom)
  :month
  iex>Elixir.ObservationalIslamic.month({1422, 6, 22}, :index)
  1
  iex>Elixir.ObservationalIslamic.month({1422, 6, 22}, :name)
  "Month"
  iex>Elixir.ObservationalIslamic.month({1422, 6, 22}, :value)
  6

Specs

name() :: atom()

Returns the internal name of the ObservationalIslamic calendar.

Example

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

Specs

range(observational_islamic_date(), observational_islamic_date()) :: integer()

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

Example

  iex>Elixir.ObservationalIslamic.range({1422, 6, 22}, {1422, 10, 4})
  730739..730839

Specs

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

Returns the start of the day in the ObservationalIslamic calendar.

Possible return values are:

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

Example

  iex>Elixir.ObservationalIslamic.start_of_day()
  :midnight

Specs

to_date(observational_islamic_date(), module()) :: tuple()

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

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

Example

  iex>Elixir.ObservationalIslamic.to_date({1422, 6, 22}, Gregorian)
  {2001, 9, 11}

Specs

to_fixed(observational_islamic_date()) :: fixed()

Converts a ObservationalIslamic date tuple into a fixed day.

Example

  iex>Elixir.ObservationalIslamic.to_fixed({1422, 6, 22})
  730739

Specs

to_fixed(
  observational_islamic_year(),
  observational_islamic_month(),
  observational_islamic_day()
) :: fixed()

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

Example

  iex>Elixir.ObservationalIslamic.to_fixed(1422, 6, 22)
  730739

Specs

to_jd(observational_islamic_date()) :: {number()}

Converts a ObservationalIslamic date into the equivalent Julian Day.

Example

  iex>Elixir.ObservationalIslamic.to_jd({1422, 6, 22})
  {2452163.5}

Specs

to_jd(
  observational_islamic_year(),
  observational_islamic_month(),
  observational_islamic_day()
) :: {number()}

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

Example

  iex>Elixir.ObservationalIslamic.to_jd(1422, 6, 22)
  {2452163.5}

Specs

to_rata_die(observational_islamic_date()) :: {integer()}

Converts a ObservationalIslamic date into the equivalent RataDie date.

Example

  iex>Elixir.ObservationalIslamic.to_rata_die({1422, 6, 22})
  {730739}

Specs

to_rata_die(
  observational_islamic_year(),
  observational_islamic_month(),
  observational_islamic_day()
) :: {integer()}

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

Example

  iex>Elixir.ObservationalIslamic.to_rata_die(1422, 6, 22)
  {730739}

Specs

to_unix(observational_islamic_date()) :: {integer()}

Converts a ObservationalIslamic date into the equivalent Unix date.

Example

  iex>Elixir.ObservationalIslamic.to_unix({1422, 6, 22})
  {1000166400}

Specs

to_unix(
  observational_islamic_year(),
  observational_islamic_month(),
  observational_islamic_day()
) :: {integer()}

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

Example

  iex>Elixir.ObservationalIslamic.to_unix(1422, 6, 22)
  {1000166400}

Specs

today(:fixed | :date) :: fixed() | observational_islamic_date()

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

Examples

  Elixir.ObservationalIslamic.today()
  730739
  Elixir.ObservationalIslamic.today(:fixed)
  730739
  Elixir.ObservationalIslamic.today(:date)
  {1422, 6, 22}

Specs

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

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

  iex>Elixir.ObservationalIslamic.year({1422, 6, 22})
  1422
  iex>Elixir.ObservationalIslamic.year({1422, 6, 22}, :atom)
  :year
  iex>Elixir.ObservationalIslamic.year({1422, 6, 22}, :index)
  0
  iex>Elixir.ObservationalIslamic.year({1422, 6, 22}, :name)
  "Year"
  iex>Elixir.ObservationalIslamic.year({1422, 6, 22}, :value)
  1422