WeekDaze.Temporal.Availability

AUTHOR

Dr. Alistair Ward

DESCRIPTION

Describes the availability of some resource.

CAVEAT

• Availability, as defined here, can only be defined for each whole day in any unspecified week, rather than individual time-slots within a day, or sporadic days in the year. This restriction isn't conceptual, but merely for the tractability of the code.
• Resources available for only part of a day, can't be directly accommodated.

Types

Data-types

data Availability

The set of days on which an arbitrary resource is available.

Instances

Eq Availability

Defined in WeekDaze.Temporal.Availability

Methods

(==) :: Availability -> Availability -> Bool

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

Ord Availability

Defined in WeekDaze.Temporal.Availability

Methods

compare :: Availability -> Availability -> Ordering

(<) :: Availability -> Availability -> Bool

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

(>) :: Availability -> Availability -> Bool

(>=) :: Availability -> Availability -> Bool

max :: Availability -> Availability -> Availability

min :: Availability -> Availability -> Availability

Show Availability

Defined in WeekDaze.Temporal.Availability

Methods

showsPrec :: Int -> Availability -> ShowS

show :: Availability -> String

showList :: [Availability] -> ShowS

NFData Availability

Defined in WeekDaze.Temporal.Availability

Methods

rnf :: Availability -> ()

Default Availability

Defined in WeekDaze.Temporal.Availability

Methods

def :: Availability

XmlPickler Availability

Defined in WeekDaze.Temporal.Availability

Methods

xpickle :: PU Availability

SelfValidator Availability

Defined in WeekDaze.Temporal.Availability

Methods

getErrors :: Availability -> [String]

isValid :: Availability -> Bool

Constants

tag :: String

Used to qualify SQL & XML.

Functions

calculateAvailabilityRatio :: Fractional f => Availability -> f

Returns the ratio of the available portion of the week, to the whole week (including weekends).

countDaysPerWeekAvailable :: Availability -> NDays

The number of days per week, which can be considered available.

countInternalAvailabilityGaps :: Availability -> NDays

Counts non-terminal blocks of consecutive unavailable days.

findIntersection :: Availability -> Availability -> Availability

Returns the days on which both resources are available.

findIntersections :: Foldable foldable => foldable Availability -> Availability

Returns the days on which all the specified resources are available.

findUnions :: Foldable foldable => foldable Availability -> Availability

Returns the days on which any of the specified resources is available.

Constructor

mkAvailability :: [Day] -> Availability

• Smart constructor.
• Prevents one directly constructing an unavailable resource, though one can indirectly as a result of an operation which returns a new one; e.g. findIntersection.

Predicates

isFulltime :: Availability -> Bool

True if the resource is available every day.

isUnavailable :: Availability -> Bool

• True is the resource is available on zero days.
• CAVEAT: an Availability which is completely unavailable, can't be constructed by mkAvailability, but it can result from findIntersection.

isAvailableOn :: Day -> Availability -> Bool

True if the unspecified resource is available on the specified day.