WeekDaze.ExecutionConfiguration.ExecutionOptions

AUTHOR

Dr. Alistair Ward

DESCRIPTION

Defines the data which drives the solution-mechanism, as opposed to that which either defines the problem or describes the presentation of the solution.

Types

Type-synonyms

type RandomSeed = Int

A seed from which to construct a pseudo-random number-generator.

type PermitTemporaryStudentBodyMerger = Bool

Whether to permit student-bodies to be temporarily merged for a lesson.

type ReduceStudentBodyRegister = Bool

Whether to automatically merge student-bodies with identical profiles.

type RemoveRedundantCourses = Bool

Whether to remove courses for which there's zero demand.

Data-types

data ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio

Encapsulates the data which drives the implementation.

Constructors

MkExecutionOptions

Fields

• getEvolutionStrategies :: EvolutionStrategies fecundityDecayRatio populationDiversityRatio

  The extent to which various strategies are applied, in an attempt to evolve the timetable.

• getMaybeHint :: Maybe Hint

  Optionally define either the order in which a timetable's axes are traversed during construction of the initial deterministic solution or a path to a file from which the initial StudentView.Timetable.Timetable can be read; the default is to perform all traverses, & select the best.

• getMaybeRandomSeed :: Maybe RandomSeed

  Optionally seed the pseudo-random number-generator to produce a repeatable sequence.

• getOptimiseLessonCriteriaWeights :: OptimiseLessonCriteriaWeights criterionWeight

  Whether & how to optimise the weights of lesson-criteria by maximising the weighted mean of timetable-criteria for the initial deterministic timetable.

• getLessonCriteriaWeights :: LessonCriteriaWeights criterionWeight

  The weight associated with criteria used to select a lesson, at a specific time-coordinate in the timetable.

• getPermitTemporaryStudentBodyMerger :: PermitTemporaryStudentBodyMerger

  Whether to permit a temporary merger between student-bodies, to permit a teacher & location to be shared for the duration of a course.

• getReduceStudentBodyRegister :: ReduceStudentBodyRegister

  Whether to permanently merge student-bodies with identical profiles, thus reducing the number of independently schedulable entities.

• getRemoveRedundantCourses :: RemoveRedundantCourses

  Whether to remove any courses offered, which aren't required by any student.

• getRemovePointlessGroups :: Bool

  Whether to remove groups from the group-catalogue, for which zero meetings have been timetable.

• getRemoveUnsubscribedGroups :: Bool

  Whether to remove groups from the group-catalogue, to which neither student-bodies nor teachers have subscribed.

• getTimetableCriteriaWeights :: TimetableCriteriaWeights criterionWeight

  The weight associated with criteria used to evaluate a timetable, during optimisation.

• getZeroInappropriateOptions :: Bool

  Whether to zero the weight of each lesson-criterion & timetable-criterion, & the fecundity of each evolution-strategy, which is either inappropriate for, or irrelevant to, the specified problem-parameters.

Instances

(Eq fecundityDecayRatio, Eq populationDiversityRatio, Eq criterionWeight) => Eq (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

Defined in WeekDaze.ExecutionConfiguration.ExecutionOptions

Methods

(==) :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> Bool

(/=) :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> Bool

(Show fecundityDecayRatio, Show populationDiversityRatio, Show criterionWeight) => Show (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

Defined in WeekDaze.ExecutionConfiguration.ExecutionOptions

Methods

showsPrec :: Int -> ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> ShowS

show :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> String

showList :: [ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio] -> ShowS

(NFData criterionWeight, NFData fecundityDecayRatio, NFData populationDiversityRatio) => NFData (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

Defined in WeekDaze.ExecutionConfiguration.ExecutionOptions

Methods

rnf :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> ()

(Fractional criterionWeight, Fractional fecundityDecayRatio, Fractional populationDiversityRatio) => Default (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

Defined in WeekDaze.ExecutionConfiguration.ExecutionOptions

Methods

def :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio

(Fractional criterionWeight, Fractional fecundityDecayRatio, Fractional populationDiversityRatio, XmlPickler criterionWeight, XmlPickler fecundityDecayRatio, XmlPickler populationDiversityRatio, Ord fecundityDecayRatio, Ord populationDiversityRatio, Real criterionWeight, Show criterionWeight, Show fecundityDecayRatio, Show populationDiversityRatio) => XmlPickler (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

Defined in WeekDaze.ExecutionConfiguration.ExecutionOptions

Methods

xpickle :: PU (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

(Num fecundityDecayRatio, Num populationDiversityRatio, Ord fecundityDecayRatio, Ord populationDiversityRatio, Real criterionWeight, Show criterionWeight, Show fecundityDecayRatio, Show populationDiversityRatio) => SelfValidator (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

Defined in WeekDaze.ExecutionConfiguration.ExecutionOptions

Methods

getErrors :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> [String]

isValid :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> Bool

(Eq criterionWeight, Num criterionWeight) => Configuration (ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio)

Defined in WeekDaze.ExecutionConfiguration.ExecutionOptions

Methods

issueWarnings :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> [String]

Constants

inputStudentViewTimetableTag :: String

Used to qualify XML.

permitTemporaryStudentBodyMergerTag :: String

Used to qualify SQL & XML.

randomSeedTag :: String

Used to qualify SQL & XML.

reduceStudentBodyRegisterTag :: String

Used to qualify SQL & XML.

removeRedundantCoursesTag :: String

Used to qualify SQL & XML.

removePointlessGroupsTag :: String

Used to qualify SQL & XML.

removeUnsubscribedGroupsTag :: String

Used to qualify SQL & XML.

zeroInappropriateOptionsTag :: String

Used to qualify SQL & XML.

Functions

Mutators

setPermitTemporaryStudentBodyMerger :: Num criterionWeight => PermitTemporaryStudentBodyMerger -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

• Mutator.
• If student-bodies can be temporarily merged, allowing the size of student-classes to grow, then there's no obvious advantage to fitting this transient class-size to either the capacity of the location or to any maximum class-size defined for the course; so getWeightOfMaximiseStudentClassSizeOverLocationCapacity & getWeightOfMaximiseStudentClassSizeOverCourseClassSize aren't relevant, equally if student-bodies can't be merged, then synchronous identical lessons are permissible, so there's no point trying to promote them via getWeightOfAreResourcesReused.
• Alternatively, if student-bodies can't be temporarily merged into a variety of student-classes, then there's no concept of either getWeightOfMinimiseStudentBodyCombinations or getWeightOfMinimiseMeanStudentBodyCombinationsPerLesson.

setSynchronisedCourseMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setSynchronisedCourseByDayMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setExcessRunlengthMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setFecundityDecayRatio :: fecundityDecayRatio -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setHomogeneousStudentViewLessonMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setIncompleteCourseMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setMinimumPopulationDiversityRatio :: populationDiversityRatio -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setMaybeNInitialScouts :: Maybe NTimetables -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setSingletonStudentClassMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setSplitSessionMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setStudentBodyCombinationMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setStudentViewTimetableForDayMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setStudentViewTimetableForWeekMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

setSynchronousLessonMutationFecundity :: TimetableBreederFecundity -> Mutator criterionWeight fecundityDecayRatio populationDiversityRatio

Mutator.

Predicates

hintWasSpecified :: ExecutionOptions criterionWeight fecundityDecayRatio populationDiversityRatio -> (Bool, Bool)

True if a (traversalOrder, input file-path) was specified.