WeekDaze.ProblemConfiguration.ProblemParameters

AUTHOR

Dr. Alistair Ward

DESCRIPTION

Encapsulates the data which defines the problem, rather than the solution-mechanism, or its presentation.

Types

Data-types

data ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId

Encapsulates the data which defines the problem.

Constructors

MkProblemParameters

Fields

• getProblemValidationSwitches :: ProblemValidationSwitches

  Defines toggle-switches governing validity-checks.

• getTimetableValidationSwitches :: TimetableValidationSwitches

  Defines toggle-switches governing validity-checks.

• getTimeslotIdBounds :: Interval timeslotId

  The closed bounds, defining the timeslot-ids, in any day.

• getLocationCatalogue :: LocationCatalogue locationId campus

  Defines the profiles of available locations, indexed by location-id.

• getTeacherRegister :: TeacherRegister teacherId synchronisationId level timeslotId locationId teachingRatio

  Defines the profiles of teachers, indexed by teacher-id.

• getStudentBodyRegister :: StudentBodyRegister level stream teachingRatio

  Defines the common profile of students, indexed by the mnemonic of the student-body of which they're all members.

• getGroupCatalogue :: GroupCatalogue timeslotId locationId

  Defines the groups of which any student or teacher may be a member.

Instances

(Eq timeslotId, Eq locationId, Eq campus, Eq teacherId, Eq level, Eq synchronisationId, Eq teachingRatio, Eq stream) => Eq (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Defined in WeekDaze.ProblemConfiguration.ProblemParameters

Methods

(==) :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Bool

(/=) :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Bool

(Show timeslotId, Show locationId, Show campus, Show teacherId, Show synchronisationId, Show level, Show teachingRatio, Show stream) => Show (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Defined in WeekDaze.ProblemConfiguration.ProblemParameters

Methods

showsPrec :: Int -> ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> ShowS

show :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> String

showList :: [ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId] -> ShowS

(NFData campus, NFData level, NFData locationId, NFData stream, NFData synchronisationId, NFData teacherId, NFData teachingRatio, NFData timeslotId) => NFData (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Defined in WeekDaze.ProblemConfiguration.ProblemParameters

Methods

rnf :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> ()

(Default campus, Default stream, Eq campus, Eq stream, XmlPickler campus, XmlPickler level, XmlPickler locationId, XmlPickler stream, XmlPickler synchronisationId, XmlPickler teacherId, XmlPickler teachingRatio, XmlPickler timeslotId, Ord level, Ord locationId, Ord synchronisationId, Ord teacherId, Ord timeslotId, Real teachingRatio, Show campus, Show level, Show synchronisationId, Show timeslotId) => XmlPickler (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Defined in WeekDaze.ProblemConfiguration.ProblemParameters

Methods

xpickle :: PU (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

(Enum timeslotId, Ord level, Ord locationId, Ord stream, Ord synchronisationId, Ord teacherId, Ord timeslotId, RealFrac teachingRatio, Show level, Show locationId, Show stream, Show synchronisationId, Show teacherId, Show teachingRatio, Show timeslotId) => SelfValidator (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Defined in WeekDaze.ProblemConfiguration.ProblemParameters

Methods

getErrors :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> [String]

isValid :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Bool

(Enum timeslotId, Ord level, Ord synchronisationId, Ord teacherId, Ord timeslotId, RealFrac teachingRatio, Show level, Show synchronisationId, Show teacherId, Show timeslotId) => Configuration (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Defined in WeekDaze.ProblemConfiguration.ProblemParameters

Methods

issueWarnings :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> [String]

Constants

timeslotIdBoundsTag :: String

Used to qualify XML.

Functions

calculateNTimeslotsPerDay :: Enum timeslotId => Interval timeslotId -> NTimeslots

• Get the length of the list defined by the specified bounds.
• CAVEAT: this implementation accounts for the potential fence-post error when called for a closed interval of Integral timeslots, but will result in an equivalent error if (bizarrely) called for an interval of Fractional quantities. Regrettably, it can't be restricted to Integral, because it may legitimately be required to work with Char.

extractDistinctGroupMembership :: RealFrac teachingRatio => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Membership

Finds the set of groups, of which a human-resource claims membership.

findExcessTotalWorkloadByStudentBody :: (Enum timeslotId, Ord level, Ord synchronisationId, Ord timeslotId, RealFrac teachingRatio) => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Map StudentBody NTimeslots

Finds student-bodies, who've requested more subjects (both core & optional), than can be taught by the courses on offer, in the time allocated to tuition.

findHumanResourceIdsByGroupId :: (Ord teacherId, RealFrac teachingRatio) => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> (ResourceIdsByGroupId StudentBody, ResourceIdsByGroupId teacherId)

Finds the members (student-bodies, teachers) of each group.

findSynchronousMeetingsByTimeByStudentBodyMnemonic :: (Ord timeslotId, RealFrac teachingRatio) => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Map StudentBody (Map (Time timeslotId) [Id])

• For each student-body, identifies times at which they have attend more than one meeting. for any of the groups of which they're a member.
• Returns the offending group-ids.

findSynchronousMeetingsByTimeByTeacherId :: (Ord timeslotId, RealFrac teachingRatio) => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Map teacherId (Map (Time timeslotId) [Id])

• For each teacherId, identifies times at which they have attend more than one meeting. for any of the groups of which they're a member.
• Returns the offending group-ids.

reduceStudentBodyRegister :: (Ord level, Ord stream, Ord teachingRatio) => MnemonicSeparator -> ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Writer [[StudentBody]] (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

• Merges those student-bodies whose profiles are identical, into a student-body.
• Also writes the list of those students affected.

removeRedundantCourses :: Ord level => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Writer [(teacherId, Knowledge level)] (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

• Removes courses from the teacherRegister, which aren't required by any student.
• Writes an association-list of teacherId & any knowledge they offer for which there's no demand; where there's a requirement for all a teacher's knowledge, then no data is written for that teacher, rather than writing a null set.

removePointlessGroups :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Writer [Id] (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Remove any groups from the groupCatalogue which have zero meeting-times.

removeUnsubscribedGroups :: RealFrac teachingRatio => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Writer [Id] (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

Remove any groups from the groupCatalogue to which neither student-bodies nor teachers have subscribed.

mergeConstraintsOnSynchronisedCourses :: (Ord level, Ord synchronisationId, Ord teacherId, Ord timeslotId, Show synchronisationId, Show timeslotId) => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId

Proxies request to mergeConstraintsOnSynchronisedCourses.

disableAnyValidationInappropriateForTemporaryStudentBodyMerger :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Writer [String] (ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId)

• When temporary student-body mergers are permitted according to the execution-options, some problem-validation switches are inappropriate & should be disabled to prevent false positives.
• Also writes the names of any disabled switches.

Predicates

hasAnyFreePeriodPreference :: RealFrac teachingRatio => ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Bool

True if any student-body or teacher has a preference for the location of any free timeslots in their working day.

hasVariousMinimumConsecutiveLessons :: ProblemParameters campus level locationId stream synchronisationId teacherId teachingRatio timeslotId -> Bool

Whether courses offer different minimumConsecutiveLessons.