diff --git a/README.md b/README.md index d64c813..f847484 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@ # conflict-range -A formalised **closed form** for the minimal conflict range of a read/result -pair, together with a C++20 translation and its test harness. +A closed-form algorithm that computes the minimal conflict range for an observed +range read and result, based on the semantics used by FoundationDB. -Given a database, a range read (two selectors plus offsets, either traversal -direction), and the keys a transaction observed, `Statement.closedForm` computes -a minimal sound conflict range: a set of keys that is sufficient to detect every -conflicting write, and none of whose proper subranges is sufficient. +See `Statement.lean` for definitions and the headline claim that the algorithm's +output is minimal. Intuitively, the minimal range is the smallest range that +preserves serializability (i.e. pinning this range pins the validity of any +inference you can make from the observed range read and result), and the key set +is unique: any two minimal ranges denote the same set of keys, though their +endpoints may differ. + +See `cpp/README.md` for a C++20 translation of the algorithm +(`cpp/src/literal.cpp`) and an equivalent optimized implementation for readable +inputs (`cpp/src/fast.cpp`). + +The rest of this README documents the Lean proof and the C++/test support for +these claims. ## Layout