Document the ORCAAgent linear program functions

MengeCrowdSim / Menge

The source code for the Menge crowd simulation framework

Apache License 2.0

139 stars 64 forks source link

Document the ORCAAgent linear program functions #131

Open curds01 opened 5 years ago

curds01 commented 5 years ago

The linear programs are somewhat inscrutable. This documents the linearProgram1() method. It gives a better overview of the purpose and parameters and then provides detailed mathematical derivations in the implementation.

Readers of the code had expressed confusion on its implementation (https://github.com/MengeCrowdSim/Menge/issues/130). This captures the clarification, in code.

This change is

curds01 commented 5 years ago

cc @dkal3. Just to let you know I've embedded it in the code.