Class ilib.Cal.PersianAlgo

Construct a new Persian algorithmic calendar object. This class encodes information about a Persian algorithmic calendar.

Depends directive: !depends persian.js
Defined in: ilib-dyn-full.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	ilib.Cal.PersianAlgo()

Method Summary
Method Attributes	Method Name and Description
	equivalentCycleYear(year) Return the equivalent year in the 2820 year cycle that begins on Far 1, 474.
	getMonLength(month, year) Return the number of days in a particular month in a particular year.
	getNumMonths(year) Return the number of months in the given year.
	getType() Return the type of this calendar.
	isLeapYear(year) Return true if the given year is a leap year in the Persian calendar.
	newDateInstance(options) Return a date instance for this calendar type using the given options.

Class Detail

ilib.Cal.PersianAlgo()

Method Detail

{number} equivalentCycleYear(year)

Return the equivalent year in the 2820 year cycle that begins on Far 1, 474. This particular cycle obeys the cycle-of-years formula whereas the others do not specifically. This cycle can be used as a proxy for other years outside of the cycle by shifting them into the cycle.

Parameters:
{number} year: year to find the equivalent cycle year for

Returns:: {number} the equivalent cycle year

{number} getMonLength(month, year)

Return the number of days in a particular month in a particular year. This function can return a different number for a month depending on the year because of things like leap years.

Parameters:
{number} month: the month for which the length is sought
{number} year: the year within which that month can be found

Returns:: {number} the number of days within the given month in the given year

{number} getNumMonths(year)

Return the number of months in the given year. The number of months in a year varies for some luni-solar calendars because in some years, an extra month is needed to extend the days in a year to an entire solar year. The month is represented as a 1-based number where 1=first month, 2=second month, etc.

Parameters:
{number} year: a year for which the number of months is sought

Returns:: {number} The number of months in the given year

{string} getType()

Return the type of this calendar.

Returns:: {string} the name of the type of this calendar

{boolean} isLeapYear(year)

Return true if the given year is a leap year in the Persian calendar. The year parameter may be given as a number, or as a PersAlgoDate object.

Parameters:
{number} year: the year for which the leap year information is being sought

Returns:: {boolean} true if the given year is a leap year

{ilib.Date} newDateInstance(options)

Return a date instance for this calendar type using the given options.

Parameters:
{Object} options: options controlling the construction of the date instance

Returns:: {ilib.Date} a date appropriate for this calendar type

Classes

Class ilib.Cal.PersianAlgo