kep_solver package

Submodules

• kep_solver.entities module
  • KEPDataValidationException
  • KEPSolveFail
  • BloodGroup
    • BloodGroup.O
    • BloodGroup.A
    • BloodGroup.B
    • BloodGroup.AB
    • BloodGroup.all()
    • BloodGroup.from_str()
  • Status
    • Status.InPool
    • Status.Left
    • Status.TemporarilyLeft
    • Status.Selected
    • Status.NotYetArrived
    • Status.Transplanted
  • Recipient
    • Recipient.__init__()
    • Recipient.status
    • Recipient.property
    • Recipient.longstr()
    • Recipient.id
    • Recipient.age
    • Recipient.cPRA
    • Recipient.bloodGroup
    • Recipient.compatibilityChance
    • Recipient.inPool()
    • Recipient.addDonor()
    • Recipient.donors()
    • Recipient.hasBloodCompatibleDonor()
    • Recipient.pairedWith()
  • Donor
    • Donor.__init__()
    • Donor.status
    • Donor.property
    • Donor.longstr()
    • Donor.id
    • Donor.age
    • Donor.bloodGroup
    • Donor.recipient
    • Donor.inPool()
    • Donor.bloodGroupCompatible()
    • Donor.addTransplant()
    • Donor.getTransplantTo()
    • Donor.transplants()
  • Transplant
    • Transplant.__init__()
    • Transplant.donor
    • Transplant.recipient
    • Transplant.weight
  • OutputFormat
    • OutputFormat.JSON
    • OutputFormat.XML
    • OutputFormat.YAML
  • Instance
    • Instance.donors
    • Instance.recipients
    • Instance.transplants
    • Instance.activeTransplants()
    • Instance.addDonor()
    • Instance.recipient()
    • Instance.addRecipient()
    • Instance.allRecipients()
    • Instance.activeRecipients()
    • Instance.hasRecipient()
    • Instance.addTransplant()
    • Instance.allDonors()
    • Instance.allNDDs()
    • Instance.activeDonors()
    • Instance.hasDonor()
    • Instance.donor()
    • Instance.writeFile()
    • Instance.writeFileXml()
    • Instance.writeFileJson()
    • Instance.writeFileJsonv1()
    • Instance.writeFileJsonv2()
    • Instance.writeFileYaml()
    • Instance.__init__()
  • InstanceSet
    • InstanceSet.__init__()
    • InstanceSet.donor_details()
    • InstanceSet.recipient_details()
  • DynamicInstance
    • DynamicInstance.__init__()
    • DynamicInstance.recipient_arrivals
    • DynamicInstance.recipient_departures
    • DynamicInstance.recipient_temporary_departures
    • DynamicInstance.ndd_arrivals
    • DynamicInstance.ndd_departures
    • DynamicInstance.ndd_temporary_departures
    • DynamicInstance.failing_transplants
    • DynamicInstance.is_available()
• kep_solver.fileio module
  • read_json()
  • parse_json()
  • parse_json_v1()
  • parse_json_v2()
  • read_xml()
  • parse_xml()
  • read_yaml()
  • parse_yaml()
  • read_compressed()
  • read_file()
  • UKJson
    • UKJson.__init__()
    • UKJson.to_string()
    • UKJson.write()
  • UKXML
    • UKXML.__init__()
    • UKXML.to_string()
    • UKXML.write()
  • write_dynamic_results()
• kep_solver.generation module
  • BloodGroupGenerator
    • BloodGroupGenerator.__init__()
    • BloodGroupGenerator.draw()
    • BloodGroupGenerator.config()
    • BloodGroupGenerator.from_json()
  • DonorCountGenerator
    • DonorCountGenerator.__init__()
    • DonorCountGenerator.draw()
    • DonorCountGenerator.config()
    • DonorCountGenerator.from_json()
  • DonorGenerator
    • DonorGenerator.__init__()
    • DonorGenerator.draw()
    • DonorGenerator.config()
    • DonorGenerator.from_json()
  • FloatGenerator
    • FloatGenerator.__init__()
    • FloatGenerator.draw()
    • FloatGenerator.config()
    • FloatGenerator.from_json()
  • CompatibilityChanceGenerator
    • CompatibilityChanceGenerator.__init__()
    • CompatibilityChanceGenerator.draw()
    • CompatibilityChanceGenerator.config()
    • CompatibilityChanceGenerator.from_json()
  • CPRAGenerator
    • CPRAGenerator.__init__()
    • CPRAGenerator.draw()
    • CPRAGenerator.config()
    • CPRAGenerator.from_json()
  • RecipientGenerator
    • RecipientGenerator.__init__()
    • RecipientGenerator.draw()
    • RecipientGenerator.config()
    • RecipientGenerator.from_json()
  • InstanceGenerator
    • InstanceGenerator.__init__()
    • InstanceGenerator.draw()
    • InstanceGenerator.config()
    • InstanceGenerator.from_json()
  • DynamicGenerator
    • DynamicGenerator.__init__()
    • DynamicGenerator.generate()
• kep_solver.graph module
  • Vertex
    • Vertex.__init__()
    • Vertex.index
    • Vertex.isNdd()
    • Vertex.donor
    • Vertex.addEdgeIn()
    • Vertex.addEdgeOut()
    • Vertex.edgesIn
    • Vertex.edgesOut
    • Vertex.adjacent()
    • Vertex.sink()
  • Exchange
    • Exchange.__init__()
    • Exchange.id
    • Exchange.vertices
    • Exchange.chain
    • Exchange.allDonors()
    • Exchange.allRecipients()
    • Exchange.allPairs()
    • Exchange.hasParticipant()
    • Exchange.hasTransplant()
    • Exchange.transplantPairs()
    • Exchange.backarc_exchanges_uk()
    • Exchange.num_backarcs_uk()
    • Exchange.alternates
    • Exchange.add_alternate()
    • Exchange.add_alternates()
    • Exchange.embedded
    • Exchange.add_embedded()
    • Exchange.add_embeddeds()
  • Edge
    • Edge.__init__()
    • Edge.donor
    • Edge.start
    • Edge.end
    • Edge.addProperty()
    • Edge.getProperty()
  • CompatibilityGraph
    • CompatibilityGraph.__init__()
    • CompatibilityGraph.size
    • CompatibilityGraph.vertices
    • CompatibilityGraph.edges()
    • CompatibilityGraph.number_ndds()
    • CompatibilityGraph.hasDonor()
    • CompatibilityGraph.hasRecipient()
    • CompatibilityGraph.exchangeEdges()
    • CompatibilityGraph.addDonor()
    • CompatibilityGraph.donorVertex()
    • CompatibilityGraph.addEdges()
    • CompatibilityGraph.findChains()
    • CompatibilityGraph.findCycles()
    • CompatibilityGraph.dot()
  • build_alternates_and_embeds()
• kep_solver.model module
  • Sense
    • Sense.MAX
    • Sense.MIN
    • Sense.EXACT
    • Sense.toConstraint()
    • Sense.toObjective()
  • Objective
    • Objective.need_alt_embed
    • Objective.is_integral
    • Objective.__init__()
    • Objective.edgeValue()
    • Objective.value()
    • Objective.describe()
    • Objective.sense
  • TransplantCount
    • TransplantCount.__init__()
    • TransplantCount.edgeValue()
    • TransplantCount.value()
    • TransplantCount.describe()
    • TransplantCount.sense
  • EffectiveTwoWay
    • EffectiveTwoWay.need_alt_embed
    • EffectiveTwoWay.__init__()
    • EffectiveTwoWay.value()
    • EffectiveTwoWay.describe()
    • EffectiveTwoWay.sense
  • BackArcs
    • BackArcs.need_alt_embed
    • BackArcs.__init__()
    • BackArcs.value()
    • BackArcs.describe()
    • BackArcs.sense
  • UK_age_score()
  • UKScore
    • UKScore.is_integral
    • UKScore.__init__()
    • UKScore.value()
    • UKScore.describe()
    • UKScore.sense
  • ThreeWay
    • ThreeWay.__init__()
    • ThreeWay.value()
    • ThreeWay.describe()
    • ThreeWay.sense
  • nWayExchanges
    • nWayExchanges.__init__()
    • nWayExchanges.value()
    • nWayExchanges.describe()
    • nWayExchanges.sense
  • nWayCycles
    • nWayCycles.__init__()
    • nWayCycles.edgeValue()
    • nWayCycles.value()
    • nWayCycles.describe()
    • nWayCycles.sense
  • Model
    • Model.supports_full_details
    • Model.__init__()
    • Model.cycles
    • Model.chains
    • Model.exchanges
    • Model.exchange_values()
    • Model.graph
    • Model.addExtraConstraints()
    • Model.addObjectiveConstraint()
    • Model.solve()
  • PICEF
    • PICEF.supports_full_details
    • PICEF.__init__()
    • PICEF.cycles
    • PICEF.chains
    • PICEF.exchanges
    • PICEF.exchange_values()
    • PICEF.build_model()
    • PICEF.addExtraConstraints()
    • PICEF.addObjectiveConstraint()
    • PICEF.countSolutions()
    • PICEF.solve()
    • PICEF.objective_values
    • PICEF.objective_value()
  • CycleAndChainModel
    • CycleAndChainModel.__init__()
    • CycleAndChainModel.cycles
    • CycleAndChainModel.chains
    • CycleAndChainModel.exchanges
    • CycleAndChainModel.exchange_values()
    • CycleAndChainModel.build_model()
    • CycleAndChainModel.addExtraConstraints()
    • CycleAndChainModel.addObjectiveConstraint()
    • CycleAndChainModel.countSolutions()
    • CycleAndChainModel.solve()
    • CycleAndChainModel.objective_values
    • CycleAndChainModel.objective_value()
• kep_solver.programme module
  • ModelledExchange
    • ModelledExchange.__init__()
    • ModelledExchange.exchange
    • ModelledExchange.values
  • Solution
    • Solution.__init__()
    • Solution.times
    • Solution.selected
    • Solution.values
    • Solution.possible
    • Solution.numSolutions
  • Programme
    • Programme.__init__()
    • Programme.build_alternates_and_embeds
    • Programme.description
    • Programme.objectives
    • Programme.maxCycleLength
    • Programme.maxChainLength
    • Programme.getOptimal()
    • Programme.solve_single()
  • DynamicSimulation
    • DynamicSimulation.__init__()
    • DynamicSimulation.reset()
    • DynamicSimulation.run()
• kep_solver.published_generators module
  • make_compat_gen()
  • uk_nhs_generator2022()
• kep_solver.solving module
  • RCVFStep
    • RCVFStep.target
    • RCVFStep.num_deactivated
    • RCVFStep.time
    • RCVFStep.__init__()
  • Level
    • Level.num_variables
    • Level.num_constraints
    • Level.linear_value
    • Level.rcvf_steps
    • Level.__init__()
  • TimeStep
    • TimeStep.description
    • TimeStep.__init__()
    • TimeStep.time
  • SolvingStatistics
    • SolvingStatistics.__init__()
    • SolvingStatistics.times
    • SolvingStatistics.levels
  • SolvingOptions
    • SolvingOptions.__init__()
    • SolvingOptions.solver
    • SolvingOptions.useRCVF
    • SolvingOptions.useRCVFAtLevel()

Module contents