WeekDaze.Temporal.Time

AUTHOR

Dr. Alistair Ward

DESCRIPTION

• The time-slot within any day is identified by an abstract enumerable type, & is therefore only loosely related to time; i.e. in this representation, one would specify the first or perhaps the last time-slot, rather than booking for say exactly 9:30.
• The actual time can only be derived from the time-slot, using knowlege of the time at which the working-day began, & of the constant duration of each time-slot; but it's irrelevant to the scheduling-task.
• Because no absolute time is associated with specific time-slots within a day, lunch-time merely exists invisibly between two time-slots, & plays no part in the scheduling.
• The day & the abstract identifier of the time-slot within that day, together define the coordinates of a specific time-slot in the timetable.
• Day/Time modules may already exist in the Haskell-platform's standard library, but since no account of; time-zones, locales, or leap-years, is required, they're undoubtedly over-engineered for the requirement.

Types

Type-synonyms

type TimeSet timeslotId = Set (Time timeslotId)

An arbitrary set of Times.

type TimesByDay timeslotId = Map Day (Set timeslotId)

Arbitrary times, categorised by day.

Data-types

data Time timeslotId

Defines the coordinates of specific time-slot, within a given week.

Instances

Eq timeslotId => Eq (Time timeslotId)

Defined in WeekDaze.Temporal.Time

Methods

(==) :: Time timeslotId -> Time timeslotId -> Bool

(/=) :: Time timeslotId -> Time timeslotId -> Bool

Ord timeslotId => Ord (Time timeslotId)

Defined in WeekDaze.Temporal.Time

Methods

compare :: Time timeslotId -> Time timeslotId -> Ordering

(<) :: Time timeslotId -> Time timeslotId -> Bool

(<=) :: Time timeslotId -> Time timeslotId -> Bool

(>) :: Time timeslotId -> Time timeslotId -> Bool

(>=) :: Time timeslotId -> Time timeslotId -> Bool

max :: Time timeslotId -> Time timeslotId -> Time timeslotId

min :: Time timeslotId -> Time timeslotId -> Time timeslotId

Read timeslotId => Read (Time timeslotId)

Defined in WeekDaze.Temporal.Time

Methods

readsPrec :: Int -> ReadS (Time timeslotId)

readList :: ReadS [Time timeslotId]

readPrec :: ReadPrec (Time timeslotId)

readListPrec :: ReadPrec [Time timeslotId]

Show timeslotId => Show (Time timeslotId)

Defined in WeekDaze.Temporal.Time

Methods

showsPrec :: Int -> Time timeslotId -> ShowS

show :: Time timeslotId -> String

showList :: [Time timeslotId] -> ShowS

NFData timeslotId => NFData (Time timeslotId)

Defined in WeekDaze.Temporal.Time

Methods

rnf :: Time timeslotId -> ()

XmlPickler timeslotId => XmlPickler (Time timeslotId)

Defined in WeekDaze.Temporal.Time

Methods

xpickle :: PU (Time timeslotId)

HTML timeslotId => HTML (Time timeslotId)

Defined in WeekDaze.Temporal.Time

Methods

toHtml :: Time timeslotId -> Html

toHtmlFromList :: [Time timeslotId] -> Html

Constants

Functions

calculateNTimeslotsPerWeek :: NTimeslots -> NTimeslots

Calculates the number of time-slots in a week, when provided by the number of time-slots per day.

calculateDistance :: Enum timeslotId => timeslotId -> timeslotId -> NTimeslots

The signed distance between time-slots.

calculateAbsoluteDistance :: Enum timeslotId => timeslotId -> timeslotId -> NTimeslots

The absolute distance between time-slots.

categoriseByDay :: Ord timeslotId => TimeSet timeslotId -> TimesByDay timeslotId

• Categorise the specified times, according to their day.
• CAVEAT: some days have zero meetings, & therefore don't have a key in the resulting map.

shift :: Enum timeslotId => NTimeslots -> timeslotId -> timeslotId

Shift the time-slot by the specified number of places.

shiftTime :: Enum timeslotId => NTimeslots -> Time timeslotId -> Time timeslotId

Shift the time by the specified number of time-slots.

Constructors

mkTime :: Day -> timeslotId -> Time timeslotId

Constructor.