Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Document GeneratedAcir::more_than_eq_comparison #2085

Merged
merged 4 commits into from
Aug 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -680,8 +680,20 @@ impl GeneratedAcir {
/// - `1` if lhs >= rhs
/// - `0` otherwise
///
/// See [R1CS Workshop - Section 10](https://github.com/mir-protocol/r1cs-workshop/blob/master/workshop.pdf)
/// for an explanation.
/// We essentially computes the sign bit of `b-a`
/// For this we sign-extend `b-a` with `c = 2^{max_bits} - (b - a)`, since both `a` and `b` are less than `2^{max_bits}`
/// Then we get the bit sign of `c`, the 2-complement representation of `(b-a)`, which is a `max_bits+1` integer,
/// by doing the euclidean division `c / 2^{max_bits}`
///
/// To see why it really works;
/// We first note that `c` is an integer of `(max_bits+1)` bits. Therefore,
/// if `b-a>0`, then `c < 2^{max_bits}`, so the division by `2^{max_bits}` will give `0`
/// If `b-a<=0`, then `c >= 2^{max_bits}`, so the division by `2^{max_bits}` will give `1`.
///
/// In other words, `1` means `a >= b` and `0` means `b > a`.
/// The important thing here is that `c` does not overflow nor underflow the field;
/// - By construction we have `c >= 0`, so there is no underflow
/// - We assert at the beginning that `2^{max_bits+1}` does not overflow the field, so neither c.
pub(crate) fn more_than_eq_comparison(
&mut self,
a: &Expression,
Expand Down