time-1.12.2: A time library

Safe Haskell | Safe
Language | Haskell2010

Data.Time.Calendar.Julian

Contents

- Year and day format

Synopsis

- type Year = Integer
- type MonthOfYear = Int
- pattern January :: MonthOfYear
- pattern February :: MonthOfYear
- pattern March :: MonthOfYear
- pattern April :: MonthOfYear
- pattern May :: MonthOfYear
- pattern June :: MonthOfYear
- pattern July :: MonthOfYear
- pattern August :: MonthOfYear
- pattern September :: MonthOfYear
- pattern October :: MonthOfYear
- pattern November :: MonthOfYear
- pattern December :: MonthOfYear
- type DayOfMonth = Int
- type DayOfYear = Int
- toJulianYearAndDay :: Day -> (Year, DayOfYear)
- fromJulianYearAndDay :: Year -> DayOfYear -> Day
- isJulianLeapYear :: Year -> Bool
- fromJulianYearAndDayValid :: Year -> DayOfYear -> Maybe Day
- showJulianYearAndDay :: Day -> String
- toJulian :: Day -> (Year, MonthOfYear, DayOfMonth)
- fromJulian :: Year -> MonthOfYear -> DayOfMonth -> Day
- pattern JulianYearMonthDay :: Year -> MonthOfYear -> DayOfMonth -> Day
- fromJulianValid :: Year -> MonthOfYear -> DayOfMonth -> Maybe Day
- showJulian :: Day -> String
- julianMonthLength :: Year -> MonthOfYear -> DayOfMonth
- addJulianMonthsClip :: Integer -> Day -> Day
- addJulianMonthsRollOver :: Integer -> Day -> Day
- addJulianYearsClip :: Integer -> Day -> Day
- addJulianYearsRollOver :: Integer -> Day -> Day
- addJulianDurationClip :: CalendarDiffDays -> Day -> Day
- addJulianDurationRollOver :: CalendarDiffDays -> Day -> Day
- diffJulianDurationClip :: Day -> Day -> CalendarDiffDays
- diffJulianDurationRollOver :: Day -> Day -> CalendarDiffDays

# Documentation

type Year = Integer Source #

Year of Common Era (when positive).

type MonthOfYear = Int Source #

Month of year, in range 1 (January) to 12 (December).

pattern January :: MonthOfYear Source #

pattern February :: MonthOfYear Source #

pattern March :: MonthOfYear Source #

pattern April :: MonthOfYear Source #

pattern May :: MonthOfYear Source #

pattern June :: MonthOfYear Source #

pattern July :: MonthOfYear Source #

pattern August :: MonthOfYear Source #

pattern September :: MonthOfYear Source #

pattern October :: MonthOfYear Source #

pattern November :: MonthOfYear Source #

pattern December :: MonthOfYear Source #

The twelve `MonthOfYear` patterns form a `COMPLETE` set.

type DayOfMonth = Int Source #

Day of month, in range 1 to 31.

type DayOfYear = Int Source #

Day of year, in range 1 (January 1st) to 366. December 31st is 365 in a common year, 366 in a leap year.

# Year and day format

toJulianYearAndDay :: Day -> (Year, DayOfYear) Source #

Convert to proleptic Julian year and day format.

fromJulianYearAndDay :: Year -> DayOfYear -> Day Source #

Convert from proleptic Julian year and day format. Invalid day numbers will be clipped to the correct range (1 to 365 or 366).

isJulianLeapYear :: Year -> Bool Source #

Is this year a leap year according to the proleptic Julian calendar?

fromJulianYearAndDayValid :: Year -> DayOfYear -> Maybe Day Source #

Convert from proleptic Julian year and day format. Invalid day numbers will return Nothing

showJulianYearAndDay :: Day -> String Source #

Show in proleptic Julian year and day format (yyyy-ddd)

toJulian :: Day -> (Year, MonthOfYear, DayOfMonth) Source #

Convert to proleptic Julian calendar.

fromJulian :: Year -> MonthOfYear -> DayOfMonth -> Day Source #

Convert from proleptic Julian calendar. Invalid values will be clipped to the correct range, month first, then day.

pattern JulianYearMonthDay :: Year -> MonthOfYear -> DayOfMonth -> Day Source #

Bidirectional abstract constructor for the proleptic Julian calendar. Invalid values will be clipped to the correct range, month first, then day.

fromJulianValid :: Year -> MonthOfYear -> DayOfMonth -> Maybe Day Source #

Convert from proleptic Julian calendar. Invalid values will return Nothing.

showJulian :: Day -> String Source #

Show in ISO 8601 format (yyyy-mm-dd)

julianMonthLength :: Year -> MonthOfYear -> DayOfMonth Source #

The number of days in a given month according to the proleptic Julian calendar.

addJulianMonthsClip :: Integer -> Day -> Day Source #

Add months, with days past the last day of the month clipped to the last day. For instance, 2005-01-30 + 1 month = 2005-02-28.

addJulianMonthsRollOver :: Integer -> Day -> Day Source #

Add months, with days past the last day of the month rolling over to the next month. For instance, 2005-01-30 + 1 month = 2005-03-02.

addJulianYearsClip :: Integer -> Day -> Day Source #

Add years, matching month and day, with Feb 29th clipped to Feb 28th if necessary. For instance, 2004-02-29 + 2 years = 2006-02-28.

addJulianYearsRollOver :: Integer -> Day -> Day Source #

Add years, matching month and day, with Feb 29th rolled over to Mar 1st if necessary. For instance, 2004-02-29 + 2 years = 2006-03-01.

addJulianDurationClip :: CalendarDiffDays -> Day -> Day Source #

Add months (clipped to last day), then add days

addJulianDurationRollOver :: CalendarDiffDays -> Day -> Day Source #

Add months (rolling over to next month), then add days

diffJulianDurationClip :: Day -> Day -> CalendarDiffDays Source #

Calendrical difference, with as many whole months as possible

diffJulianDurationRollOver :: Day -> Day -> CalendarDiffDays Source #

Calendrical difference, with as many whole months as possible. Same as `diffJulianDurationClip` for positive durations.