X-Git-Url: https://mattmccutchen.net/match/match.git/blobdiff_plain/93082682db1a115cfe8b485d30df6e4856207d4b..8723ed6adebc35a25ca240acdb587444c85fb44f:/program/PMConfig.hs

diff --git a/program/PMConfig.hs b/program/PMConfig.hs
index 20a380f..ecbe1cb 100644
--- a/program/PMConfig.hs
+++ b/program/PMConfig.hs
@@ -3,6 +3,12 @@ module PMConfig where
 import PMInstance
 import IMinCostFlow
 
+-- A PMConfig structure has a bunch of configuration values used by
+-- many functions in PMInstanceGenerator, ProposalMatcher, and Evaluation, which
+-- take a PMConfig as their first argument.  Module PMDefaults defines a sane
+-- default configuration `pmDefaults'; it can be used as-is or individual fields
+-- can be overridden, e.g., pmDefaults{loadTolerance = 2} .  See module
+-- PMDefaults for documentation of each field.
 data PMConfig = PMConfig {
 	minCostFlow :: MinCostFlowImpl,
 	reviewsEachProposal :: Int,
@@ -17,5 +23,7 @@ data PMConfig = PMConfig {
 	marginalVeryBoringCost :: Wt -> Wt,
 	assignmentCost :: Wt -> Wt,
 	knowledgeableBonus :: Wt,
-	expertBonus :: Wt
+	expertBonus :: Wt,
+	numTopics :: Int,
+	topicZipfExponent :: Wt
 }