Data.Thyme.Calendar

Calendar calculations.

Note that UTCTime is not Y294K-compliant, and Bounded instances for the various calendar types reflect this fact. That said, the calendar calculations by themselves work perfectly fine for a wider range of dates, subject to the size of Int for your platform.

Day

newtype Day

A calendar-agnostic day, internally represented as a count of days since 1858-11-17, the Modified Julian Day (MJD) epoch.

To convert a Day to the corresponding YearMonthDay in the Gregorian calendar, see gregorian.

> gregorian # YearMonthDay 2016 3 1
2016-03-01

Day is an instance of AffineSpace where Diff Day = Days, so arithmetic on Day and Days can be performed with the .-., .+^, and .-^ operators.

> gregorian # YearMonthDay 2016 3 1  .-.  gregorian # YearMonthDay 2016 2 1
29

> gregorian # YearMonthDay 2016 3 1 .-^ 1
2016-02-29

Other ways of viewing a Day include ordinalDate, and weekDate.

Constructors

ModifiedJulianDay

Fields

• toModifiedJulianDay :: Int

Instances

Arbitrary Day

Defined in Data.Thyme.Calendar

Methods

arbitrary :: Gen Day

shrink :: Day -> [Day]

CoArbitrary Day

Defined in Data.Thyme.Calendar.Internal

Methods

coarbitrary :: Day -> Gen b -> Gen b

Data Day

Defined in Data.Thyme.Calendar.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Day -> c Day

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Day

toConstr :: Day -> Constr

dataTypeOf :: Day -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Day)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Day)

gmapT :: (forall b. Data b => b -> b) -> Day -> Day

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Day -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Day -> r

gmapQ :: (forall d. Data d => d -> u) -> Day -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Day -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Day -> m Day

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Day -> m Day

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Day -> m Day

Bounded Day

Defined in Data.Thyme.Calendar

Methods

minBound :: Day

maxBound :: Day

Enum Day

Defined in Data.Thyme.Calendar.Internal

Methods

succ :: Day -> Day

pred :: Day -> Day

toEnum :: Int -> Day

fromEnum :: Day -> Int

enumFrom :: Day -> [Day]

enumFromThen :: Day -> Day -> [Day]

enumFromTo :: Day -> Day -> [Day]

enumFromThenTo :: Day -> Day -> Day -> [Day]

Generic Day

Defined in Data.Thyme.Calendar.Internal

Associated Types

type Rep Day :: Type -> Type

Methods

from :: Day -> Rep Day x

to :: Rep Day x -> Day

Ix Day

Defined in Data.Thyme.Calendar.Internal

Methods

range :: (Day, Day) -> [Day]

index :: (Day, Day) -> Day -> Int

unsafeIndex :: (Day, Day) -> Day -> Int

inRange :: (Day, Day) -> Day -> Bool

rangeSize :: (Day, Day) -> Int

unsafeRangeSize :: (Day, Day) -> Int

Read Day

Defined in Data.Thyme.Format

Methods

readsPrec :: Int -> ReadS Day

readList :: ReadS [Day]

readPrec :: ReadPrec Day

readListPrec :: ReadPrec [Day]

Show Day

Defined in Data.Thyme.Calendar.Internal

Methods

showsPrec :: Int -> Day -> ShowS

show :: Day -> String

showList :: [Day] -> ShowS

NFData Day

Defined in Data.Thyme.Calendar.Internal

Methods

rnf :: Day -> ()

Eq Day

Defined in Data.Thyme.Calendar.Internal

Methods

(==) :: Day -> Day -> Bool

(/=) :: Day -> Day -> Bool

Ord Day

Defined in Data.Thyme.Calendar.Internal

Methods

compare :: Day -> Day -> Ordering

(<) :: Day -> Day -> Bool

(<=) :: Day -> Day -> Bool

(>) :: Day -> Day -> Bool

(>=) :: Day -> Day -> Bool

max :: Day -> Day -> Day

min :: Day -> Day -> Day

Hashable Day

Defined in Data.Thyme.Calendar.Internal

Methods

hashWithSalt :: Int -> Day -> Int

hash :: Day -> Int

Random Day

Defined in Data.Thyme.Calendar

Methods

randomR :: RandomGen g => (Day, Day) -> g -> (Day, g)

random :: RandomGen g => g -> (Day, g)

randomRs :: RandomGen g => (Day, Day) -> g -> [Day]

randoms :: RandomGen g => g -> [Day]

FormatTime Day

Defined in Data.Thyme.Format

Methods

showsTime :: TimeLocale -> Day -> (Char -> ShowS) -> Char -> ShowS

ParseTime Day

Defined in Data.Thyme.Format

Methods

buildTime :: TimeParse -> Day

Unbox Day

Defined in Data.Thyme.Calendar.Internal

AffineSpace Day

Defined in Data.Thyme.Calendar.Internal

Associated Types

type Diff Day

Methods

(.-.) :: Day -> Day -> Diff Day

(.+^) :: Day -> Diff Day -> Day

Thyme Day Day

Defined in Data.Thyme.Time.Core

Methods

thyme :: Iso' Day0 Day

Vector Vector Day

Defined in Data.Thyme.Calendar.Internal

Methods

basicUnsafeFreeze :: Mutable Vector s Day -> ST s (Vector Day)

basicUnsafeThaw :: Vector Day -> ST s (Mutable Vector s Day)

basicLength :: Vector Day -> Int

basicUnsafeSlice :: Int -> Int -> Vector Day -> Vector Day

basicUnsafeIndexM :: Vector Day -> Int -> Box Day

basicUnsafeCopy :: Mutable Vector s Day -> Vector Day -> ST s ()

elemseq :: Vector Day -> Day -> b -> b

MVector MVector Day

Defined in Data.Thyme.Calendar.Internal

Methods

basicLength :: MVector s Day -> Int

basicUnsafeSlice :: Int -> Int -> MVector s Day -> MVector s Day

basicOverlaps :: MVector s Day -> MVector s Day -> Bool

basicUnsafeNew :: Int -> ST s (MVector s Day)

basicInitialize :: MVector s Day -> ST s ()

basicUnsafeReplicate :: Int -> Day -> ST s (MVector s Day)

basicUnsafeRead :: MVector s Day -> Int -> ST s Day

basicUnsafeWrite :: MVector s Day -> Int -> Day -> ST s ()

basicClear :: MVector s Day -> ST s ()

basicSet :: MVector s Day -> Day -> ST s ()

basicUnsafeCopy :: MVector s Day -> MVector s Day -> ST s ()

basicUnsafeMove :: MVector s Day -> MVector s Day -> ST s ()

basicUnsafeGrow :: MVector s Day -> Int -> ST s (MVector s Day)

type Rep Day

Defined in Data.Thyme.Calendar.Internal

type Rep Day = D1 ('MetaData "Day" "Data.Thyme.Calendar.Internal" "thyme-0.4-HyK6SfK4MlBKX4LjgMsZJ4" 'True) (C1 ('MetaCons "ModifiedJulianDay" 'PrefixI 'True) (S1 ('MetaSel ('Just "toModifiedJulianDay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

newtype Vector Day

Defined in Data.Thyme.Calendar.Internal

newtype Vector Day = V_Day (Vector Int)

type Diff Day

Defined in Data.Thyme.Calendar.Internal

type Diff Day = Days

newtype MVector s Day

Defined in Data.Thyme.Calendar.Internal

newtype MVector s Day = MV_Day (MVector s Int)

modifiedJulianDay :: Iso' Day Int

Convert between a Day and the corresponding count of days from 1858-11-17, the MJD epoch.

modifiedJulianDay = iso toModifiedJulianDay ModifiedJulianDay

> modifiedJulianDay # 0
1858-11-17
> gregorian # YearMonthDay 2016 3 1 & modifiedJulianDay %~ subtract 1
2016-02-29

Calendar

type Year = Int

Calendar year.

type Month = Int

Calendar month. January = 1

type DayOfMonth = Int

Calendar day-of-month, starting from 1.

data YearMonthDay

A strict triple of a Year, a Day, and a Month.

Constructors

YearMonthDay

Fields

• ymdYear :: !Year
• ymdMonth :: !Month
• ymdDay :: !DayOfMonth

Instances

Arbitrary YearMonthDay

Defined in Data.Thyme.Calendar

Methods

arbitrary :: Gen YearMonthDay

shrink :: YearMonthDay -> [YearMonthDay]

CoArbitrary YearMonthDay

Defined in Data.Thyme.Calendar

Methods

coarbitrary :: YearMonthDay -> Gen b -> Gen b

Data YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> YearMonthDay -> c YearMonthDay

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c YearMonthDay

toConstr :: YearMonthDay -> Constr

dataTypeOf :: YearMonthDay -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c YearMonthDay)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c YearMonthDay)

gmapT :: (forall b. Data b => b -> b) -> YearMonthDay -> YearMonthDay

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> YearMonthDay -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> YearMonthDay -> r

gmapQ :: (forall d. Data d => d -> u) -> YearMonthDay -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> YearMonthDay -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> YearMonthDay -> m YearMonthDay

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> YearMonthDay -> m YearMonthDay

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> YearMonthDay -> m YearMonthDay

Bounded YearMonthDay

Defined in Data.Thyme.Calendar

Methods

minBound :: YearMonthDay

maxBound :: YearMonthDay

Generic YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Associated Types

type Rep YearMonthDay :: Type -> Type

Methods

from :: YearMonthDay -> Rep YearMonthDay x

to :: Rep YearMonthDay x -> YearMonthDay

Show YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

showsPrec :: Int -> YearMonthDay -> ShowS

show :: YearMonthDay -> String

showList :: [YearMonthDay] -> ShowS

NFData YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

rnf :: YearMonthDay -> ()

Eq YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

(==) :: YearMonthDay -> YearMonthDay -> Bool

(/=) :: YearMonthDay -> YearMonthDay -> Bool

Ord YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

compare :: YearMonthDay -> YearMonthDay -> Ordering

(<) :: YearMonthDay -> YearMonthDay -> Bool

(<=) :: YearMonthDay -> YearMonthDay -> Bool

(>) :: YearMonthDay -> YearMonthDay -> Bool

(>=) :: YearMonthDay -> YearMonthDay -> Bool

max :: YearMonthDay -> YearMonthDay -> YearMonthDay

min :: YearMonthDay -> YearMonthDay -> YearMonthDay

Hashable YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

hashWithSalt :: Int -> YearMonthDay -> Int

hash :: YearMonthDay -> Int

Random YearMonthDay

Defined in Data.Thyme.Calendar

Methods

randomR :: RandomGen g => (YearMonthDay, YearMonthDay) -> g -> (YearMonthDay, g)

random :: RandomGen g => g -> (YearMonthDay, g)

randomRs :: RandomGen g => (YearMonthDay, YearMonthDay) -> g -> [YearMonthDay]

randoms :: RandomGen g => g -> [YearMonthDay]

FormatTime YearMonthDay

Defined in Data.Thyme.Format

Methods

showsTime :: TimeLocale -> YearMonthDay -> (Char -> ShowS) -> Char -> ShowS

ParseTime YearMonthDay

Defined in Data.Thyme.Format

Methods

buildTime :: TimeParse -> YearMonthDay

Unbox YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Vector Vector YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

basicUnsafeFreeze :: Mutable Vector s YearMonthDay -> ST s (Vector YearMonthDay)

basicUnsafeThaw :: Vector YearMonthDay -> ST s (Mutable Vector s YearMonthDay)

basicLength :: Vector YearMonthDay -> Int

basicUnsafeSlice :: Int -> Int -> Vector YearMonthDay -> Vector YearMonthDay

basicUnsafeIndexM :: Vector YearMonthDay -> Int -> Box YearMonthDay

basicUnsafeCopy :: Mutable Vector s YearMonthDay -> Vector YearMonthDay -> ST s ()

elemseq :: Vector YearMonthDay -> YearMonthDay -> b -> b

MVector MVector YearMonthDay

Defined in Data.Thyme.Calendar.Internal

Methods

basicLength :: MVector s YearMonthDay -> Int

basicUnsafeSlice :: Int -> Int -> MVector s YearMonthDay -> MVector s YearMonthDay

basicOverlaps :: MVector s YearMonthDay -> MVector s YearMonthDay -> Bool

basicUnsafeNew :: Int -> ST s (MVector s YearMonthDay)

basicInitialize :: MVector s YearMonthDay -> ST s ()

basicUnsafeReplicate :: Int -> YearMonthDay -> ST s (MVector s YearMonthDay)

basicUnsafeRead :: MVector s YearMonthDay -> Int -> ST s YearMonthDay

basicUnsafeWrite :: MVector s YearMonthDay -> Int -> YearMonthDay -> ST s ()

basicClear :: MVector s YearMonthDay -> ST s ()

basicSet :: MVector s YearMonthDay -> YearMonthDay -> ST s ()

basicUnsafeCopy :: MVector s YearMonthDay -> MVector s YearMonthDay -> ST s ()

basicUnsafeMove :: MVector s YearMonthDay -> MVector s YearMonthDay -> ST s ()

basicUnsafeGrow :: MVector s YearMonthDay -> Int -> ST s (MVector s YearMonthDay)

type Rep YearMonthDay

Defined in Data.Thyme.Calendar.Internal

type Rep YearMonthDay = D1 ('MetaData "YearMonthDay" "Data.Thyme.Calendar.Internal" "thyme-0.4-HyK6SfK4MlBKX4LjgMsZJ4" 'False) (C1 ('MetaCons "YearMonthDay" 'PrefixI 'True) (S1 ('MetaSel ('Just "ymdYear") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Year) :*: (S1 ('MetaSel ('Just "ymdMonth") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Month) :*: S1 ('MetaSel ('Just "ymdDay") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 DayOfMonth))))

newtype Vector YearMonthDay

Defined in Data.Thyme.Calendar.Internal

newtype Vector YearMonthDay = V_YearMonthDay (Vector Int)

newtype MVector s YearMonthDay

Defined in Data.Thyme.Calendar.Internal

newtype MVector s YearMonthDay = MV_YearMonthDay (MVector s Int)

_ymdYear :: Lens' YearMonthDay Year

_ymdMonth :: Lens' YearMonthDay Month

_ymdDay :: Lens' YearMonthDay DayOfMonth

type Years = Int

A duration/count of years.

type Months = Int

A duration/count of months.

type Days = Int

A duration/count of days.

Gregorian calendar

Note that using the Gregorian calendar for dates before its adoption (from 1582 onwards, but varies from one country to the next) produces a proleptic calendar, which may cause some confusion.

isLeapYear :: Year -> Bool

Is it a leap year according to the Gregorian calendar?

yearMonthDay :: Iso' OrdinalDate YearMonthDay

Conversion between a Gregorian OrdinalDate and the corresponding YearMonthDay.

> OrdinalDate 2016 32 ^. yearMonthDay
YearMonthDay {ymdYear = 2016, ymdMonth = 2, ymdDay = 1}

> yearMonthDay # YearMonthDay 2016 2 1
OrdinalDate {odYear = 2016, odDay = 32}

gregorian :: Iso' Day YearMonthDay

Conversion between a Day and its YearMonthDay.

gregorian = ordinalDate . yearMonthDay

> ModifiedJulianDay 0 ^. gregorian
YearMonthDay {ymdYear = 1858, ymdMonth = 11, ymdDay = 17}

> gregorian # YearMonthDay 1858 11 17
1858-11-17

gregorianValid :: YearMonthDay -> Maybe Day

Conversion between a YearMonthDay and the corresponding Day. Returns Nothing for invalid input.

> gregorianValid (YearMonthDay 2015 2 28)
Just 2015-02-28

> gregorianValid (YearMonthDay 2015 2 29)
Nothing

showGregorian :: Day -> String

Shows a Day in ISO 8601 YYYY-MM-DD format.

See Data.Thyme.Format for other possibilities.

gregorianMonthLength :: Year -> Month -> Days

The number of days in a given month in the Gregorian calendar.

> gregorianMonthLength 2005 2
28

gregorianMonthsClip :: Months -> YearMonthDay -> YearMonthDay

Add months, with days past the last day of the month clipped to the last day.

See also addGregorianMonthsClip.

> gregorianMonthsClip 1 $ YearMonthDay 2005 1 30
YearMonthDay {ymdYear = 2005, ymdMonth = 2, ymdDay = 28}

gregorianMonthsRollover :: Months -> YearMonthDay -> YearMonthDay

Add months, with days past the last day of the month rolling over to the next month.

See also addGregorianMonthsRollover.

> gregorianMonthsRollover 1 $ YearMonthDay 2005 1 30
YearMonthDay {ymdYear = 2005, ymdMonth = 3, ymdDay = 2}

gregorianYearsClip :: Years -> YearMonthDay -> YearMonthDay

Add years, matching month and day, with February 29th clipped to the 28th if necessary.

See also addGregorianYearsClip.

> gregorianYearsClip 2 $ YearMonthDay 2004 2 29
YearMonthDay {ymdYear = 2006, ymdMonth = 2, ymdDay = 28}

gregorianYearsRollover :: Years -> YearMonthDay -> YearMonthDay

Add years, matching month and day, with February 29th rolled over to March 1st if necessary.

See also addGregorianYearsRollover.

> gregorianYearsRollover 2 $ YearMonthDay 2004 2 29
YearMonthDay {ymdYear = 2006, ymdMonth = 3, ymdDay = 1}

addDays :: Days -> Day -> Day

Add some Days to a calendar Day to get a new Day.

addDays = flip (.+^)
addDays n d ≡ d .+^ n

See also the AffineSpace instance for Day.

diffDays :: Day -> Day -> Days

Subtract two calendar Days for the difference in Days.

diffDays = (.-.)
diffDays a b = a .-. b

See also the AffineSpace instance for Day.

toGregorian :: Day -> (Year, Month, DayOfMonth)

Convert a Day to its Gregorian Year, Month, and DayOfMonth.

toGregorian (view gregorian -> YearMonthDay y m d) = (y, m, d)

fromGregorian :: Year -> Month -> DayOfMonth -> Day

Construct a Day from a Gregorian calendar date. Does not validate the input.

fromGregorian y m d = gregorian # YearMonthDay y m d

fromGregorianValid :: Year -> Month -> DayOfMonth -> Maybe Day

Construct a Day from a Gregorian calendar date. Returns Nothing for invalid input.

fromGregorianValid y m d = gregorianValid (YearMonthDay y m d)

addGregorianMonthsClip :: Months -> Day -> Day

Add some number of Months to the given Day; if the original DayOfMonth exceeds that of the new Month, it will be clipped to the last day of the new Month.

addGregorianMonthsClip n = gregorian %~ gregorianMonthsClip n

addGregorianMonthsRollover :: Months -> Day -> Day

Add some number of Months to the given Day; if the original DayOfMonth exceeds that of the new Month, it will be rolled over into the following Month.

addGregorianMonthsRollover n = gregorian %~ gregorianMonthsRollover n

addGregorianYearsClip :: Years -> Day -> Day

Add some number of Years to the given Day, with February 29th clipped to February 28th if necessary.

addGregorianYearsClip n = gregorian %~ gregorianYearsClip n

addGregorianYearsRollover :: Years -> Day -> Day

Add some number of Years to the given Day, with February 29th rolled over to March 1st if necessary.

addGregorianYearsRollover n = gregorian %~ gregorianYearsRollover n

Orphan instances

Arbitrary Day

Methods

arbitrary :: Gen Day

shrink :: Day -> [Day]

Arbitrary YearMonthDay

Methods

arbitrary :: Gen YearMonthDay

shrink :: YearMonthDay -> [YearMonthDay]

CoArbitrary YearMonthDay

Methods

coarbitrary :: YearMonthDay -> Gen b -> Gen b

Bounded Day

Methods

minBound :: Day

maxBound :: Day

Bounded YearMonthDay

Methods

minBound :: YearMonthDay

maxBound :: YearMonthDay

Random Day

Methods

randomR :: RandomGen g => (Day, Day) -> g -> (Day, g)

random :: RandomGen g => g -> (Day, g)

randomRs :: RandomGen g => (Day, Day) -> g -> [Day]

randoms :: RandomGen g => g -> [Day]

Random YearMonthDay

Methods

randomR :: RandomGen g => (YearMonthDay, YearMonthDay) -> g -> (YearMonthDay, g)

random :: RandomGen g => g -> (YearMonthDay, g)

randomRs :: RandomGen g => (YearMonthDay, YearMonthDay) -> g -> [YearMonthDay]

randoms :: RandomGen g => g -> [YearMonthDay]