Index

_

__init__() (BackArcs method) (BloodGroupGenerator method) (CompatibilityChanceGenerator method) (CompatibilityGraph method) (CPRAGenerator method) (CycleAndChainModel method) (Donor method) (DonorCountGenerator method) (DonorGenerator method) (DynamicGenerator method) (DynamicInstance method) (DynamicSimulation method) (Edge method) (EffectiveTwoWay method) (Exchange method) (FloatGenerator method) (Instance method) (InstanceGenerator method) (InstanceSet method) (Level method) (Model method) (ModelledExchange method) (Objective method) (PICEF method) (Programme method) (RCVFStep method) (Recipient method) (RecipientGenerator method) (Solution method) (SolvingOptions method) (SolvingStatistics method) (ThreeWay method) (TimeStep method) (Transplant method) (TransplantCount method) (UKJson method) (UKScore method) (UKXML method) (Vertex method)

A

A (BloodGroup attribute) AB (BloodGroup attribute) activeDonors() (Instance method) activeRecipients() (Instance method) activeTransplants() (Instance method) add_alternate() (Exchange method) add_alternates() (Exchange method) add_embedded() (Exchange method) add_embeddeds() (Exchange method) addDonor() (CompatibilityGraph method) (Instance method) (Recipient method) addEdgeIn() (Vertex method) addEdgeOut() (Vertex method) addEdges() (CompatibilityGraph method) addObjectiveConstraint() (CycleAndChainModel method) (Model method) (PICEF method)

addProperty() (Edge method) addRecipient() (Instance method) addTransplant() (Donor method) (Instance method) adjacent() (Vertex method) age (Donor property) (Recipient property) all() (BloodGroup static method) allDonors() (Exchange method) (Instance method) allNDDs() (Instance method) allPairs() (Exchange method) allRecipients() (Exchange method) (Instance method) alternates (Exchange property)

B

B (BloodGroup attribute) backarc_exchanges_uk() (Exchange method) BackArcs (class in kep_solver.model) BloodGroup (class in kep_solver.entities) bloodGroup (Donor property) (Recipient property)

bloodGroupCompatible() (Donor method) BloodGroupGenerator (class in kep_solver.generation) build_alternates_and_embeds (Programme property) build_alternates_and_embeds() (in module kep_solver.graph) build_model() (CycleAndChainModel method) (PICEF method)

C

chain (Exchange property) chains (CycleAndChainModel property) (Model property) (PICEF property) compatibilityChance (Recipient property) CompatibilityChanceGenerator (class in kep_solver.generation) CompatibilityGraph (class in kep_solver.graph) config() (BloodGroupGenerator method) (CompatibilityChanceGenerator method) (CPRAGenerator method) (DonorCountGenerator method) (DonorGenerator method) (FloatGenerator method) (InstanceGenerator method) (RecipientGenerator method)

countSolutions() (CycleAndChainModel method) (PICEF method) cPRA (Recipient property) CPRAGenerator (class in kep_solver.generation) CycleAndChainModel (class in kep_solver.model) cycles (CycleAndChainModel property) (Model property) (PICEF property)

D

describe() (BackArcs method) (EffectiveTwoWay method) (Objective method) (ThreeWay method) (TransplantCount method) (UKScore method) description (Programme property) (TimeStep attribute) Donor (class in kep_solver.entities) donor (Edge property) (Transplant property) (Vertex property) donor() (Instance method) donor_details() (InstanceSet method) DonorCountGenerator (class in kep_solver.generation)

DonorGenerator (class in kep_solver.generation) donors (Instance attribute) donors() (Recipient method) donorVertex() (CompatibilityGraph method) dot() (CompatibilityGraph method) draw() (BloodGroupGenerator method) (CompatibilityChanceGenerator method) (CPRAGenerator method) (DonorCountGenerator method) (DonorGenerator method) (FloatGenerator method) (InstanceGenerator method) (RecipientGenerator method) DynamicGenerator (class in kep_solver.generation) DynamicInstance (class in kep_solver.entities) DynamicSimulation (class in kep_solver.programme)

E

Edge (class in kep_solver.graph) edges() (CompatibilityGraph method) edgesIn (Vertex property) edgesOut (Vertex property) edgeValue() (Objective method) (TransplantCount method) EffectiveTwoWay (class in kep_solver.model) embedded (Exchange property) end (Edge property)

EXACT (Sense attribute) Exchange (class in kep_solver.graph) exchange (ModelledExchange property) exchange_values() (CycleAndChainModel method) (Model method) (PICEF method) exchangeEdges() (CompatibilityGraph method) exchanges (CycleAndChainModel property) (Model property) (PICEF property)

F

failing_transplants (DynamicInstance attribute) findChains() (CompatibilityGraph method) findCycles() (CompatibilityGraph method) FloatGenerator (class in kep_solver.generation) from_json() (BloodGroupGenerator class method) (CompatibilityChanceGenerator class method) (CPRAGenerator class method) (DonorCountGenerator class method) (DonorGenerator class method) (FloatGenerator class method) (InstanceGenerator class method) (RecipientGenerator class method)

from_str() (BloodGroup static method)

G

generate() (DynamicGenerator method) getOptimal() (Programme method)

getProperty() (Edge method) getTransplantTo() (Donor method) graph (Model property)

H

hasBloodCompatibleDonor() (Recipient method) hasDonor() (CompatibilityGraph method) (Instance method)

hasParticipant() (Exchange method) hasRecipient() (CompatibilityGraph method) (Instance method) hasTransplant() (Exchange method)

I

id (Donor property) (Exchange property) (Recipient property) index (Vertex property) InPool (Status attribute) inPool() (Donor method) (Recipient method)

Instance (class in kep_solver.entities) InstanceGenerator (class in kep_solver.generation) InstanceSet (class in kep_solver.entities) is_available() (DynamicInstance method) is_integral (Objective attribute) (UKScore attribute) isNdd() (Vertex method)

J

JSON (OutputFormat attribute)

K

kep_solver module, [1] kep_solver.entities module kep_solver.fileio module kep_solver.generation module kep_solver.graph module

kep_solver.model module kep_solver.programme module kep_solver.published_generators module kep_solver.solving module KEPDataValidationException KEPSolveFail

L

Left (Status attribute) Level (class in kep_solver.solving) levels (SolvingStatistics attribute)

linear_value (Level attribute) longstr() (Donor method) (Recipient method)

M

make_compat_gen() (in module kep_solver.published_generators) MAX (Sense attribute) maxChainLength (Programme property) maxCycleLength (Programme property) MIN (Sense attribute) Model (class in kep_solver.model) ModelledExchange (class in kep_solver.programme) module kep_solver, [1] kep_solver.entities kep_solver.fileio kep_solver.generation kep_solver.graph kep_solver.model kep_solver.programme kep_solver.published_generators kep_solver.solving

N

ndd_arrivals (DynamicInstance attribute) ndd_departures (DynamicInstance attribute) ndd_temporary_departures (DynamicInstance attribute) need_alt_embed (BackArcs attribute) (EffectiveTwoWay attribute) (Objective attribute)

NotYetArrived (Status attribute) num_backarcs_uk() (Exchange method) num_constraints (Level attribute) num_deactivated (RCVFStep attribute) num_variables (Level attribute) number_ndds() (CompatibilityGraph method) numSolutions (Solution property)

O

O (BloodGroup attribute) Objective (class in kep_solver.model) objective_value() (CycleAndChainModel method) (PICEF method)

objective_values (CycleAndChainModel property) (PICEF property) objectives (Programme property) OutputFormat (class in kep_solver.entities)

P

pairedWith() (Recipient method) parse_json() (in module kep_solver.fileio) parse_xml() (in module kep_solver.fileio) parse_yaml() (in module kep_solver.fileio)

PICEF (class in kep_solver.model) possible (Solution property) Programme (class in kep_solver.programme) property (Donor attribute) (Recipient attribute)

R

rcvf_steps (Level attribute) RCVFStep (class in kep_solver.solving) read_compressed() (in module kep_solver.fileio) read_file() (in module kep_solver.fileio) read_json() (in module kep_solver.fileio) read_xml() (in module kep_solver.fileio) read_yaml() (in module kep_solver.fileio) Recipient (class in kep_solver.entities) recipient (Donor property) (Transplant property)

recipient() (Instance method) recipient_arrivals (DynamicInstance attribute) recipient_departures (DynamicInstance attribute) recipient_details() (InstanceSet method) recipient_temporary_departures (DynamicInstance attribute) RecipientGenerator (class in kep_solver.generation) recipients (Instance attribute) reset() (DynamicSimulation method) run() (DynamicSimulation method)

S

selected (Solution property) Selected (Status attribute) sense (BackArcs property) Sense (class in kep_solver.model) sense (EffectiveTwoWay property) (Objective property) (ThreeWay property) (TransplantCount property) (UKScore property) sink() (Vertex static method) size (CompatibilityGraph property) Solution (class in kep_solver.programme)

solve() (CycleAndChainModel method) (Model method) (PICEF method) solve_single() (Programme method) solver (SolvingOptions attribute) SolvingOptions (class in kep_solver.solving) SolvingStatistics (class in kep_solver.solving) start (Edge property) Status (class in kep_solver.entities) status (Donor attribute) (Recipient attribute) supports_full_details (Model attribute) (PICEF attribute)

T

target (RCVFStep attribute) ThreeWay (class in kep_solver.model) time (RCVFStep attribute) (TimeStep attribute) times (Solution property) (SolvingStatistics attribute) TimeStep (class in kep_solver.solving) to_string() (UKJson method) (UKXML method)

toConstraint() (Sense method) toObjective() (Sense method) Transplant (class in kep_solver.entities) TransplantCount (class in kep_solver.model) Transplanted (Status attribute) transplantPairs() (Exchange method) transplants (Instance property) transplants() (Donor method)

U

UK_age_score() (in module kep_solver.model) uk_nhs_generator2022() (in module kep_solver.published_generators) UKJson (class in kep_solver.fileio)

UKScore (class in kep_solver.model) UKXML (class in kep_solver.fileio) useRCVF (SolvingOptions attribute) useRCVFAtLevel() (SolvingOptions method)

V

value() (BackArcs method) (EffectiveTwoWay method) (Objective method) (ThreeWay method) (TransplantCount method) (UKScore method)

values (ModelledExchange property) (Solution property) Vertex (class in kep_solver.graph) vertices (CompatibilityGraph property) (Exchange property)

W

weight (Transplant property) write() (UKJson method) (UKXML method)

writeFile() (Instance method) writeFileJson() (Instance method) writeFileXml() (Instance method) writeFileYaml() (Instance method)

X

XML (OutputFormat attribute)

Y

YAML (OutputFormat attribute)