Specs

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

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

Examples

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

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

  iex>Elixir.ArithmeticPersian.add_days(730739, 100, :date)
  {1380, 9, 29}
  iex>Elixir.ArithmeticPersian.add_days(730739, -100, :date)
  {1380, 3, 13}

  iex>Elixir.ArithmeticPersian.add_days({1380, 6, 20}, 100)
  730839
  iex>Elixir.ArithmeticPersian.add_days({1380, 6, 20}, -100)
  730639

  iex>Elixir.ArithmeticPersian.add_days({1380, 6, 20}, 100, :fixed)
  730839
  iex>Elixir.ArithmeticPersian.add_days({1380, 6, 20}, -100, :fixed)
  730639

  iex>Elixir.ArithmeticPersian.add_days({1380, 6, 20}, 100, :date)
  {1380, 9, 29}
  iex>Elixir.ArithmeticPersian.add_days({1380, 6, 20}, -100, :date)
  {1380, 3, 13}

Specs

as_date(fixed() | arithmetic_persian_date()) :: arithmetic_persian_date()

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

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.ArithmeticPersian.as_date(730739)
  {1380, 6, 20}
  iex>Elixir.ArithmeticPersian.as_date({1380, 6, 20})
  {1380, 6, 20}

Specs

as_fixed(fixed() | arithmetic_persian_date()) :: fixed()

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

This is a convenience function to simplify certain function calls.

Examples

  iex>Elixir.ArithmeticPersian.as_fixed(730739)
  730739
  iex>Elixir.ArithmeticPersian.as_fixed({1380, 6, 20})
  730739

Specs

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

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

The type parameter determines the type of the returned value:

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

Examples

  iex>Elixir.ArithmeticPersian.as_type(730739)
  730739
  iex>Elixir.ArithmeticPersian.as_type(730739, :fixed)
  730739
  iex>Elixir.ArithmeticPersian.as_type(730739, :date)
  {1380, 6, 20}
  iex>Elixir.ArithmeticPersian.as_type({1380, 6, 20})
  730739
  iex>Elixir.ArithmeticPersian.as_type({1380, 6, 20}, :fixed)
  730739
  iex>Elixir.ArithmeticPersian.as_type({1380, 6, 20}, :date)
  {1380, 6, 20}

Specs

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

Compares two ArithmeticPersian 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.ArithmeticPersian.compare({1380, 6, 20}, {1380, 6, 20})
  :eq
  iex>Elixir.ArithmeticPersian.compare({1380, 6, 20}, {1380, 9, 29})
  :lt
  iex>Elixir.ArithmeticPersian.compare({1380, 9, 29}, {1380, 6, 20})
  :gt

Specs

date(
  arithmetic_persian_year(),
  arithmetic_persian_month(),
  arithmetic_persian_day()
) :: t()

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

Example

  iex>Elixir.ArithmeticPersian.date(1380, 6, 20)
  {1380, 6, 20}

Specs

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

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

The dates can be given as fixed days or ArithmeticPersian 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.ArithmeticPersian.date_diff(730739, 730839)
  100
  iex>Elixir.ArithmeticPersian.date_diff(730839, 730739)
  -100
  iex>Elixir.ArithmeticPersian.date_diff({1380, 6, 20}, {1380, 9, 29})
  100
  iex>Elixir.ArithmeticPersian.date_diff({1380, 9, 29}, {1380, 6, 20})
  -100
  iex>Elixir.ArithmeticPersian.date_diff(730739, {1380, 9, 29})
  100
  iex>Elixir.ArithmeticPersian.date_diff({1380, 6, 20}, 730839)
  100

Specs

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

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

  iex>Elixir.ArithmeticPersian.day({1380, 6, 20})
  20
  iex>Elixir.ArithmeticPersian.day({1380, 6, 20}, :atom)
  :day
  iex>Elixir.ArithmeticPersian.day({1380, 6, 20}, :index)
  2
  iex>Elixir.ArithmeticPersian.day({1380, 6, 20}, :name)
  "Day"
  iex>Elixir.ArithmeticPersian.day({1380, 6, 20}, :value)
  20

Specs

eq(arithmetic_persian_date(), arithmetic_persian_date()) :: boolean()

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

Examples

  iex>Elixir.ArithmeticPersian.eq({1380, 6, 20}, {1380, 6, 20})
  true
  iex>Elixir.ArithmeticPersian.eq({1380, 6, 20}, {1380, 9, 29})
  false
  iex>Elixir.ArithmeticPersian.eq({1380, 9, 29}, {1380, 6, 20})
  false

Specs

field_atom(integer()) :: atom()

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

Examples

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

Specs

field_atoms() :: [atom()]

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

Example

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

Specs

field_count() :: integer()

Returns the number of fields in a ArithmeticPersian date

Example

  iex>Elixir.ArithmeticPersian.field_count()
  3

Specs

field_index(atom()) :: integer()

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

Examples

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

Specs

from_date(tuple(), module()) :: arithmetic_persian_date()

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

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

Example

  iex>Elixir.ArithmeticPersian.from_date({2001, 9, 11}, Gregorian)
  {1380, 6, 20}

Specs

from_fixed(fixed()) :: arithmetic_persian_date()

Converts a fixed day to a ArithmeticPersian date.

Example

  iex>Elixir.ArithmeticPersian.from_fixed(730739)
  {1380, 6, 20}

Specs

from_jd(tuple() | number()) :: arithmetic_persian_date()

Converts a Julian Day into the equivalent ArithmeticPersian date.

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

Examples

  iex>Elixir.ArithmeticPersian.from_jd({2452163.5})
  {1380, 6, 20}
  iex>Elixir.ArithmeticPersian.from_jd(2452163.5)
  {1380, 6, 20}

Specs

from_rata_die(tuple() | integer()) :: arithmetic_persian_date()

Converts a RataDie date into the equivalent ArithmeticPersian date.

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

Examples

  iex>Elixir.ArithmeticPersian.from_rata_die({730739})
  {1380, 6, 20}
  iex>Elixir.ArithmeticPersian.from_rata_die(730739)
  {1380, 6, 20}

Specs

from_unix(tuple() | integer()) :: arithmetic_persian_date()

Converts a Unix date into the equivalent ArithmeticPersian date.

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

Examples

  iex>Elixir.ArithmeticPersian.from_unix({1000166400})
  {1380, 6, 20}
  iex>Elixir.ArithmeticPersian.from_unix(1000166400)
  {1380, 6, 20}

Specs

ge(arithmetic_persian_date(), arithmetic_persian_date()) :: boolean()

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

Examples

  iex>Elixir.ArithmeticPersian.ge({1380, 6, 20}, {1380, 6, 20})
  true
  iex>Elixir.ArithmeticPersian.ge({1380, 6, 20}, {1380, 9, 29})
  false
  iex>Elixir.ArithmeticPersian.ge({1380, 9, 29}, {1380, 6, 20})
  true

Specs

gt(arithmetic_persian_date(), arithmetic_persian_date()) :: boolean()

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

Examples

  iex>Elixir.ArithmeticPersian.gt({1380, 6, 20}, {1380, 6, 20})
  false
  iex>Elixir.ArithmeticPersian.gt({1380, 6, 20}, {1380, 9, 29})
  false
  iex>Elixir.ArithmeticPersian.gt({1380, 9, 29}, {1380, 6, 20})
  true

Specs

keyword() :: atom()

Returns the internal keyword of the ArithmeticPersian calendar.

Example

  iex>Elixir.ArithmeticPersian.keyword()
  :arithmetic_persian

Specs

le(arithmetic_persian_date(), arithmetic_persian_date()) :: boolean()

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

Examples

  iex>Elixir.ArithmeticPersian.le({1380, 6, 20}, {1380, 6, 20})
  true
  iex>Elixir.ArithmeticPersian.le({1380, 6, 20}, {1380, 9, 29})
  true
  iex>Elixir.ArithmeticPersian.le({1380, 9, 29}, {1380, 6, 20})
  false

Specs

lt(arithmetic_persian_date(), arithmetic_persian_date()) :: boolean()

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

Examples

  iex>Elixir.ArithmeticPersian.lt({1380, 6, 20}, {1380, 6, 20})
  false
  iex>Elixir.ArithmeticPersian.lt({1380, 6, 20}, {1380, 9, 29})
  true
  iex>Elixir.ArithmeticPersian.lt({1380, 9, 29}, {1380, 6, 20})
  false

Specs

module() :: module()

Returns the module of the ArithmeticPersian calendar.

Example

  iex>Elixir.ArithmeticPersian.module()
  ArithmeticPersian

Specs

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

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

  iex>Elixir.ArithmeticPersian.month({1380, 6, 20})
  6
  iex>Elixir.ArithmeticPersian.month({1380, 6, 20}, :atom)
  :month
  iex>Elixir.ArithmeticPersian.month({1380, 6, 20}, :index)
  1
  iex>Elixir.ArithmeticPersian.month({1380, 6, 20}, :name)
  "Month"
  iex>Elixir.ArithmeticPersian.month({1380, 6, 20}, :value)
  6

Specs

name() :: atom()

Returns the internal name of the ArithmeticPersian calendar.

Example

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

Specs

range(arithmetic_persian_date(), arithmetic_persian_date()) :: integer()

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

Example

  iex>Elixir.ArithmeticPersian.range({1380, 6, 20}, {1380, 9, 29})
  730739..730839

Specs

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

Returns the start of the day in the ArithmeticPersian calendar.

Possible return values are:

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

Example

  iex>Elixir.ArithmeticPersian.start_of_day()
  :midnight

Specs

to_date(arithmetic_persian_date(), module()) :: tuple()

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

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

Example

  iex>Elixir.ArithmeticPersian.to_date({1380, 6, 20}, Gregorian)
  {2001, 9, 11}

Specs

to_fixed(arithmetic_persian_date()) :: fixed()

Converts a ArithmeticPersian date tuple into a fixed day.

Example

  iex>Elixir.ArithmeticPersian.to_fixed({1380, 6, 20})
  730739

Specs

to_fixed(
  arithmetic_persian_year(),
  arithmetic_persian_month(),
  arithmetic_persian_day()
) :: fixed()

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

Example

  iex>Elixir.ArithmeticPersian.to_fixed(1380, 6, 20)
  730739

Specs

to_jd(arithmetic_persian_date()) :: {number()}

Converts a ArithmeticPersian date into the equivalent Julian Day.

Example

  iex>Elixir.ArithmeticPersian.to_jd({1380, 6, 20})
  {2452163.5}

Specs

to_jd(
  arithmetic_persian_year(),
  arithmetic_persian_month(),
  arithmetic_persian_day()
) :: {number()}

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

Example

  iex>Elixir.ArithmeticPersian.to_jd(1380, 6, 20)
  {2452163.5}

Specs

to_rata_die(arithmetic_persian_date()) :: {integer()}

Converts a ArithmeticPersian date into the equivalent RataDie date.

Example

  iex>Elixir.ArithmeticPersian.to_rata_die({1380, 6, 20})
  {730739}

Specs

to_rata_die(
  arithmetic_persian_year(),
  arithmetic_persian_month(),
  arithmetic_persian_day()
) :: {integer()}

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

Example

  iex>Elixir.ArithmeticPersian.to_rata_die(1380, 6, 20)
  {730739}

Specs

to_unix(arithmetic_persian_date()) :: {integer()}

Converts a ArithmeticPersian date into the equivalent Unix date.

Example

  iex>Elixir.ArithmeticPersian.to_unix({1380, 6, 20})
  {1000166400}

Specs

to_unix(
  arithmetic_persian_year(),
  arithmetic_persian_month(),
  arithmetic_persian_day()
) :: {integer()}

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

Example

  iex>Elixir.ArithmeticPersian.to_unix(1380, 6, 20)
  {1000166400}

Specs

today(:fixed | :date) :: fixed() | arithmetic_persian_date()

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

Examples

  Elixir.ArithmeticPersian.today()
  730739
  Elixir.ArithmeticPersian.today(:fixed)
  730739
  Elixir.ArithmeticPersian.today(:date)
  {1380, 6, 20}

Specs

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

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

  iex>Elixir.ArithmeticPersian.year({1380, 6, 20})
  1380
  iex>Elixir.ArithmeticPersian.year({1380, 6, 20}, :atom)
  :year
  iex>Elixir.ArithmeticPersian.year({1380, 6, 20}, :index)
  0
  iex>Elixir.ArithmeticPersian.year({1380, 6, 20}, :name)
  "Year"
  iex>Elixir.ArithmeticPersian.year({1380, 6, 20}, :value)
  1380