WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

AUTHOR

Dr. Alistair Ward

DESCRIPTION

• Defines the weightings, associated with each of the soft-constraints used to compare & select between alternative timetables.
• Hard-constraints (e.g. that a student or teacher can't be in more than one place at a time, or that the capacity of a location can't be exceeded), are never violated, & so don't need to be quantified for subsequent comparison.

Types

Type-synonyms

Data-types

data TimetableCriteriaWeights w

The weight of criteria used to select a timetable from alternatives.

Constructors

MkTimetableCriteriaWeights

Fields

• getWeightOfMaximiseComplianceWithFreePeriodPreferences :: CriterionWeight w

  A timetable is preferred, when it complies with any free time-slot preference, of student-bodies & teachers.

• getWeightOfMaximiseMeanRatioOfStudentClassSizeToLocationCapacity :: CriterionWeight w

  A timetable is preferred, when the mean over all bookings, of the ratio of the size of the student-class to the location's capacity, is greatest.

• getWeightOfMaximiseMeanStudentClassSize :: CriterionWeight w

  A timetable is preferred, when the mean over the size of student-classes, relative to the total number of students, is greatest.

• getWeightOfMaximiseSynchronisationOfSynchronisedCourses :: CriterionWeight w

  A timetable is preferred, when the lessons of synchronised courses are consistently synchronised.

• getWeightOfMaximiseWeightedMeanStudentBodyUtilisationRatio :: CriterionWeight w

  A timetable is preferred, when the mean over all student-bodies, of their utilisation-ratio, is maximised. It doesn't distinguish between core & optional subjects like minimiseMeanRatioOfIncompletelyBookedCoreKnowledge & minimiseMeanRatioOfIncompletelyBookedOptionalKnowledge, but it does value partially booked courses.

• getWeightOfMinimiseAverageAbsoluteDeviationFromIdealTimeslotRequest :: CriterionWeight w

  A timetable is preferred, when lessons are booked close to any ideal timeslot-request for their course. CAVEAT: excessive weight makes it preferable to take the penalty from getWeightOfMinimiseMeanRatioOfIncompletelyBookedCoreKnowledge or getWeightOfMinimiseMeanRatioOfIncompletelyBookedOptionalKnowledge, by not scheduling a lesson if the available time-slots are far from any specified ideal.

• getWeightOfMinimiseDispersionOfStudentFreePeriodsPerDay :: CriterionWeight w

  A timetable is preferred, when students' free periods are spread evenly across their working-week.

• getWeightOfMinimiseDispersionOfTeacherFreePeriodsPerDay :: CriterionWeight w

  A timetable is preferred, when teachers' free periods are spread evenly across their working-week.

• getWeightOfMinimiseDispersionOfTeacherWorkload :: CriterionWeight w

  A timetable is preferred, when the relative workload between all teachers, is similar.

• getWeightOfMinimiseMeanInterCampusMigrationsOfStudents :: CriterionWeight w

  A timetable is preferred, when the average over all students, of the number of inter-campus migrations in a week, is minimised.

• getWeightOfMinimiseMeanInterCampusMigrationsOfTeachers :: CriterionWeight w

  A timetable is preferred, when the average over all teachers, of the number of inter-campus migrations in a week, is minimised.

• getWeightOfMinimiseMeanLocationChangesOfTeachers :: CriterionWeight w

  A timetable is preferred, when the average over all teachers, of the number of changes in their location in a week, is minimised; cf. minimiseMeanLocusOperandiOfTeachers, which merely counts the number of distinct locations used.

• getWeightOfMinimiseMeanLocusOperandiOfTeachers :: CriterionWeight w

  A timetable is preferred, when the average over all teachers, of the size of their locus-operandi, is minimised; based merely on the number of locations, rather than the distance or the number of changes, between them.

• getWeightOfMinimiseMeanRatioOfIncompletelyBookedCoreKnowledge :: CriterionWeight w

  A timetable is preferred, when the average over all student-bodies, of the ratio of incompletely booked core knowledge-requirements, to all requirements, is minimised. All incomplete courses are valued equally, regardless of the extent.

• getWeightOfMinimiseMeanRatioOfIncompletelyBookedOptionalKnowledge :: CriterionWeight w

  A timetable is preferred, when the average over all student-bodies, of the ratio of incompletely booked optional knowledge-requirements, to all requirements, is minimised. All incomplete courses are valued equally, regardless of the extent; cf. maximiseWeightedMeanStudentBodyUtilisationRatio.

• getWeightOfMinimiseMeanStudentBodyCombinationsPerLesson :: CriterionWeight w

  A timetable is preferred, when the average number of combinations of student-class per lesson-definition, is minimised; ideally a student-body always studies a subject, in a class composed from the same other student-bodies.

• getWeightOfMinimiseRatioOfConsecutiveEqualLessons :: CriterionWeight w

  A timetable is preferred, when blocks of consecutive identical lessons are booked, whose length most closely corresponds, to that requested for the course to which they belong.

• getWeightOfMinimiseRatioOfSeparatedEqualLessonsWithinAnyDay :: CriterionWeight w

  A timetable is preferred, when the lessons of any course, are on any day, booked in one contiguous block.

Instances

Eq w => Eq (TimetableCriteriaWeights w)

Defined in WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

Methods

(==) :: TimetableCriteriaWeights w -> TimetableCriteriaWeights w -> Bool

(/=) :: TimetableCriteriaWeights w -> TimetableCriteriaWeights w -> Bool

Show w => Show (TimetableCriteriaWeights w)

Defined in WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

Methods

showsPrec :: Int -> TimetableCriteriaWeights w -> ShowS

show :: TimetableCriteriaWeights w -> String

showList :: [TimetableCriteriaWeights w] -> ShowS

NFData criterionWeight => NFData (TimetableCriteriaWeights criterionWeight)

Defined in WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

Methods

rnf :: TimetableCriteriaWeights criterionWeight -> ()

Num w => Default (TimetableCriteriaWeights w)

Defined in WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

Methods

def :: TimetableCriteriaWeights w

(XmlPickler w, Ord w, Real w) => XmlPickler (TimetableCriteriaWeights w)

Defined in WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

Methods

xpickle :: PU (TimetableCriteriaWeights w)

(Eq w, Num w) => SelfValidator (TimetableCriteriaWeights w)

Defined in WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

Methods

getErrors :: TimetableCriteriaWeights w -> [String]

isValid :: TimetableCriteriaWeights w -> Bool

(Eq criterionWeight, Num criterionWeight) => CriterionWeights (TimetableCriteriaWeights criterionWeight)

Defined in WeekDaze.ExecutionConfiguration.TimetableCriteriaWeights

Methods

areAllZero :: TimetableCriteriaWeights criterionWeight -> Bool

Constants

associationList :: [(String, TimetableCriteriaWeights w -> CriterionWeight w)]

The ordered list of tags & accessors.

tag :: String

Used to qualify XML.

weightOfMaximiseComplianceWithFreePeriodPreferencesTag :: String

Used to qualify XML.

weightOfMaximiseMeanRatioOfStudentClassSizeToLocationCapacityTag :: String

Used to qualify XML.

weightOfMaximiseMeanStudentClassSizeTag :: String

Used to qualify XML.

weightOfMaximiseSynchronisationOfSynchronisedCoursesTag :: String

Used to qualify XML.

weightOfMaximiseWeightedMeanStudentBodyUtilisationRatioTag :: String

Used to qualify XML.

weightOfMinimiseAverageAbsoluteDeviationFromIdealTimeslotRequestTag :: String

Used to qualify XML.

weightOfMinimiseDispersionOfStudentFreePeriodsPerDayTag :: String

Used to qualify XML.

weightOfMinimiseDispersionOfTeacherFreePeriodsPerDayTag :: String

Used to qualify XML.

weightOfMinimiseDispersionOfTeacherWorkloadTag :: String

Used to qualify XML.

weightOfMinimiseMeanInterCampusMigrationsOfStudentsTag :: String

Used to qualify XML.

weightOfMinimiseMeanInterCampusMigrationsOfTeachersTag :: String

Used to qualify XML.

weightOfMinimiseMeanLocationChangesOfTeachersTag :: String

Used to qualify XML.

weightOfMinimiseMeanLocusOperandiOfTeachersTag :: String

Used to qualify XML.

weightOfMinimiseMeanRatioOfIncompletelyBookedCoreKnowledgeTag :: String

Used to qualify XML.

weightOfMinimiseMeanRatioOfIncompletelyBookedOptionalKnowledgeTag :: String

Used to qualify XML.

weightOfMinimiseMeanStudentBodyCombinationsPerLessonTag :: String

Used to qualify XML.

weightOfMinimiseRatioOfConsecutiveEqualLessonsTag :: String

Used to qualify XML.

weightOfMinimiseRatioOfSeparatedEqualLessonsWithinAnyDayTag :: String

Used to qualify XML.

Functions

calculateWeightedMean

Arguments

:: (Fractional weightedMean, Real criterionValue, Real criterionWeight)

=> TimetableCriteriaWeights criterionWeight

-> Criterion criterionValue

complianceWithFreePeriodPreferences: maximum when each unallocated time-slot complies with the preferences of both student-bodies & teachers.

-> Criterion criterionValue

classSizeOverLocationCapacity: maximum when location which has been booked, is completely filled by the student-class.

-> Criterion criterionValue

A timetable is preferred, when the mean over the size of student-classes, relative to the total number of students, is greatest.

-> Criterion criterionValue

synchronisationOfSynchronisedCourses: maximum if the lessons for all synchronised courses, are synchronised.

-> Criterion criterionValue

weightedMeanStudentBodyUtilisationRatio: maximum if all student-bodies are fully utilised.

-> Criterion criterionValue

averageAbsoluteDeviationFromIdealTimeslotRequest: maximum if all lessons, whose course specifies an ideal time-slot, have been booked exactly on it, falling towards minimum as the mean absolute deviation increases.

-> Criterion criterionValue

dispersionOfStudentFreePeriodsPerDay: maximum when the deviation in the number of free student-periods per day is zero, falling towards minimum when they all fall on one day.

-> Criterion criterionValue

dispersionOfTeacherFreePeriodsPerDay: maximum when the deviation in the number of free teacher-periods per day is zero, falling towards minimum when they all fall on one day.

-> Criterion criterionValue

dispersionOfTeacherWorkload: maximum when the deviation in the workload between teachers is zero, falling towards minimum as their workloads move away from the mean.

-> Criterion criterionValue

meanInterCampusMigrationsOfStudents: maximum when each student migrates to a different campus between each timeslot.

-> Criterion criterionValue

meanInterCampusMigrationsOfTeachers: maximum when each teacher migrates to a different campus between each timeslot.

-> Criterion criterionValue

meanLocationChangesOfTeachers: maximum when the location of each teacher changes at every time-slot, falling towards minimum as each lesson is taught at the same location.

-> Criterion criterionValue

meanLocusOperandiOfTeachers: maximum when the locus-operandi of each teacher is just one location, falling towards minimum as each lesson taught is in a different location.

-> Criterion criterionValue

meanRatioOfIncompletelyBookedCoreKnowledge: maximum when all of a student-body's required core subjects are completely booked, falling towards minimum when none are met.

-> Criterion criterionValue

meanRatioOfIncompletelyBookedOptionalKnowledge: maximum when all of a student-body's required optional subjects are completely booked, falling towards minimum when none are met.

-> Criterion criterionValue

meanStudentBodyCombinationsPerLesson: maximum when each student-body studies a subject, as a member of a constant student-class, falling towards minimum as the mean number of different student-body-combinations per subject rises.

-> Criterion criterionValue

ratioOfConsecutiveEqualLessons: maximum when blocks of consecutive identical lessons are booked, whose length equals that requested for the course to which they belong.

-> Criterion criterionValue

ratioOfSeparatedEqualLessonsWithinAnyDay: maximum when only one contiguous block of lessons in any subject, has been booked each day, falling towards minimum where separated blocks of equal lessons occur within any one day.

-> Writer [Maybe criterionValue] weightedMean

The individual criteria values, & their weighted mean.

• Returns the weighted sum of the specified criteria, divided by the sum of the weights.
• The magnitude of each criterion should be in the same range, so that none dominates the total, thus making the total a clear measure of the value attributed to each.
• The magnitude of the value of each criterion should be independent of the dimensions of the timetable (observerIds, days per week, time-slots per day), so that should any of these change, the balance between criteria doesn't shift; i.e. they should be dimensionless.

Mutators

zeroWeightOfMaximiseComplianceWithFreePeriodPreferences :: Num w => Mutator w

zeroWeightOfMaximiseSynchronisationOfSynchronisedCourses :: Num w => Mutator w

zeroWeightOfMinimiseAverageAbsoluteDeviationFromIdealTimeslotRequest :: Num w => Mutator w

zeroWeightOfMinimiseDispersionOfStudentFreePeriodsPerDay :: Num w => Mutator w

zeroWeightOfMinimiseMeanInterCampusMigrationsOfStudents :: Num w => Mutator w

zeroWeightOfMinimiseMeanInterCampusMigrationsOfTeachers :: Num w => Mutator w

zeroWeightOfMinimiseMeanLocationChangesOfTeachers :: Num w => Mutator w

zeroWeightOfMinimiseMeanLocusOperandiOfTeachers :: Num w => Mutator w

zeroWeightOfMinimiseMeanRatioOfIncompletelyBookedOptionalKnowledge :: Num w => Mutator w

zeroWeightOfMinimiseMeanStudentBodyCombinationsPerLesson :: Num w => Mutator w

zeroWeightOfMinimiseRatioOfConsecutiveEqualLessons :: Num w => Mutator w

zeroWeightOfMinimiseRatioOfSeparatedEqualLessonsWithinAnyDay :: Num w => Mutator w