Barretenberg
The ZK-SNARK library at the core of Aztec
Loading...
Searching...
No Matches
bigfield_impl.hpp
Go to the documentation of this file.
1// === AUDIT STATUS ===
2// internal: { status: Complete, auditors: [Suyash], commit: }
3// external_1: { status: not started, auditors: [], commit: }
4// external_2: { status: not started, auditors: [], commit: }
5// =====================
6
7#pragma once
8
13#include <cstdint>
14#include <tuple>
15
16#include "../circuit_builders/circuit_builders.hpp"
17#include "bigfield.hpp"
18
19#include "../field/field.hpp"
21
22namespace bb::stdlib {
23
24template <typename Builder, typename T>
26 : context(parent_context)
27 , binary_basis_limbs{ Limb(field_t<Builder>(parent_context, bb::fr(0))),
28 Limb(field_t<Builder>(parent_context, bb::fr(0))),
29 Limb(field_t<Builder>(parent_context, bb::fr(0))),
30 Limb(field_t<Builder>(parent_context, bb::fr(0))) }
31 , prime_basis_limb(context, 0)
32{}
33
34template <typename Builder, typename T>
36 : context(parent_context)
37 , binary_basis_limbs{ Limb(field_t<Builder>(parent_context, bb::fr(value.slice(0, NUM_LIMB_BITS)))),
38 Limb(field_t<Builder>(parent_context, bb::fr(value.slice(NUM_LIMB_BITS, NUM_LIMB_BITS * 2)))),
39 Limb(field_t<Builder>(parent_context,
40 bb::fr(value.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 3)))),
41 Limb(field_t<Builder>(parent_context,
42 bb::fr(value.slice(NUM_LIMB_BITS * 3, NUM_LIMB_BITS * 4)))) }
43 , prime_basis_limb(context, value)
44{
46}
47
48template <typename Builder, typename T>
50 const field_t<Builder>& high_bits_in,
51 const bool can_overflow,
52 const size_t maximum_bitlength)
53{
54 BB_ASSERT_EQ(low_bits_in.is_constant(), high_bits_in.is_constant());
55 BB_ASSERT((can_overflow == true && maximum_bitlength == 0) ||
56 (can_overflow == false && (maximum_bitlength == 0 || maximum_bitlength > (3 * NUM_LIMB_BITS))));
57
58 // Check that the values of two parts are within specified bounds
59 BB_ASSERT_LT(uint256_t(low_bits_in.get_value()), uint256_t(1) << (NUM_LIMB_BITS * 2));
60 BB_ASSERT_LT(uint256_t(high_bits_in.get_value()), uint256_t(1) << (NUM_LIMB_BITS * 2));
61
62 context = low_bits_in.context == nullptr ? high_bits_in.context : low_bits_in.context;
67 if (!low_bits_in.is_constant()) {
68 // Decompose the low bits into 2 limbs and range constrain them.
69 const auto limb_witnesses =
70 decompose_non_native_field_double_width_limb(context, low_bits_in.get_witness_index());
71 limb_0.witness_index = limb_witnesses[0];
72 limb_1.witness_index = limb_witnesses[1];
73 } else {
74 uint256_t slice_0 = uint256_t(low_bits_in.additive_constant).slice(0, NUM_LIMB_BITS);
75 uint256_t slice_1 = uint256_t(low_bits_in.additive_constant).slice(NUM_LIMB_BITS, 2 * NUM_LIMB_BITS);
76 limb_0 = field_t(context, bb::fr(slice_0));
77 limb_1 = field_t(context, bb::fr(slice_1));
78 }
79
80 // If we wish to continue working with this element with lazy reductions - i.e. not moding out again after each
81 // addition we apply a more limited range - 2^s for smallest s such that p<2^s (this is the case can_overflow ==
82 // false)
83 uint64_t num_last_limb_bits = (can_overflow) ? NUM_LIMB_BITS : NUM_LAST_LIMB_BITS;
84
85 // if maximum_bitlength is set, this supercedes can_overflow
86 if (maximum_bitlength > 0) {
87 BB_ASSERT_GT(maximum_bitlength, 3 * NUM_LIMB_BITS);
88 BB_ASSERT_LTE(maximum_bitlength, 4 * NUM_LIMB_BITS);
89 num_last_limb_bits = maximum_bitlength - (3 * NUM_LIMB_BITS);
90 }
91 // We create the high limb values similar to the low limb ones above
92 const uint64_t num_high_limb_bits = NUM_LIMB_BITS + num_last_limb_bits;
93 if (!high_bits_in.is_constant()) {
94 // Decompose the high bits into 2 limbs and range constrain them.
95 const auto limb_witnesses = decompose_non_native_field_double_width_limb(
96 context, high_bits_in.get_witness_index(), static_cast<size_t>(num_high_limb_bits));
97 limb_2.witness_index = limb_witnesses[0];
98 limb_3.witness_index = limb_witnesses[1];
99 } else {
100 uint256_t slice_2 = uint256_t(high_bits_in.additive_constant).slice(0, NUM_LIMB_BITS);
101 uint256_t slice_3 = uint256_t(high_bits_in.additive_constant).slice(NUM_LIMB_BITS, num_high_limb_bits);
102 limb_2 = field_t(context, bb::fr(slice_2));
103 limb_3 = field_t(context, bb::fr(slice_3));
104 }
105 binary_basis_limbs[0] = Limb(limb_0, DEFAULT_MAXIMUM_LIMB);
106 binary_basis_limbs[1] = Limb(limb_1, DEFAULT_MAXIMUM_LIMB);
107 binary_basis_limbs[2] = Limb(limb_2, DEFAULT_MAXIMUM_LIMB);
108 if (maximum_bitlength > 0) {
109 uint256_t max_limb_value = (uint256_t(1) << (maximum_bitlength - (3 * NUM_LIMB_BITS))) - 1;
110 binary_basis_limbs[3] = Limb(limb_3, max_limb_value);
111 } else {
112 binary_basis_limbs[3] =
113 Limb(limb_3, can_overflow ? DEFAULT_MAXIMUM_LIMB : DEFAULT_MAXIMUM_MOST_SIGNIFICANT_LIMB);
114 }
115 prime_basis_limb = low_bits_in + (high_bits_in * shift_2);
116 auto new_tag = OriginTag(low_bits_in.tag, high_bits_in.tag);
117 set_origin_tag(new_tag);
118}
119
120template <typename Builder, typename T>
122 : context(other.context)
123 , binary_basis_limbs{ other.binary_basis_limbs[0],
124 other.binary_basis_limbs[1],
125 other.binary_basis_limbs[2],
126 other.binary_basis_limbs[3] }
127 , prime_basis_limb(other.prime_basis_limb)
128{}
129
130template <typename Builder, typename T>
132 : context(other.context)
133 , binary_basis_limbs{ other.binary_basis_limbs[0],
134 other.binary_basis_limbs[1],
135 other.binary_basis_limbs[2],
136 other.binary_basis_limbs[3] }
137 , prime_basis_limb(other.prime_basis_limb)
138{}
139
140template <typename Builder, typename T>
142 const uint512_t& value,
143 const bool can_overflow,
144 const size_t maximum_bitlength)
145{
146 BB_ASSERT((can_overflow == true && maximum_bitlength == 0) ||
147 (can_overflow == false && (maximum_bitlength == 0 || maximum_bitlength > (3 * NUM_LIMB_BITS))));
149 limbs[0] = value.slice(0, NUM_LIMB_BITS).lo;
150 limbs[1] = value.slice(NUM_LIMB_BITS, NUM_LIMB_BITS * 2).lo;
151 limbs[2] = value.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 3).lo;
152 limbs[3] = value.slice(NUM_LIMB_BITS * 3, NUM_LIMB_BITS * 4).lo;
153
154 field_t<Builder> limb_0(ctx);
155 field_t<Builder> limb_1(ctx);
156 field_t<Builder> limb_2(ctx);
157 field_t<Builder> limb_3(ctx);
158 field_t<Builder> prime_limb(ctx);
159 limb_0.witness_index = ctx->add_variable(bb::fr(limbs[0]));
160 limb_1.witness_index = ctx->add_variable(bb::fr(limbs[1]));
161 limb_2.witness_index = ctx->add_variable(bb::fr(limbs[2]));
162 limb_3.witness_index = ctx->add_variable(bb::fr(limbs[3]));
163 prime_limb.witness_index = ctx->add_variable(limb_0.get_value() + limb_1.get_value() * shift_1 +
164 limb_2.get_value() * shift_2 + limb_3.get_value() * shift_3);
165 // evaluate prime basis limb with addition gate that taps into the 4th wire in the next gate
166 ctx->create_big_add_gate({ limb_1.get_witness_index(),
167 limb_2.get_witness_index(),
168 limb_3.get_witness_index(),
169 prime_limb.get_witness_index(),
170 shift_1,
171 shift_2,
172 shift_3,
173 -1,
174 0 },
175 true);
176 // NOTE(https://github.com/AztecProtocol/barretenberg/issues/879): Optimisation opportunity to use a single gate
177 // (and remove dummy gate). Currently, dummy gate is necessary for preceeding big add gate as these gates fall in
178 // the arithmetic block. More details on the linked Github issue.
179 ctx->create_unconstrained_gate(
180 ctx->blocks.arithmetic, ctx->zero_idx(), ctx->zero_idx(), ctx->zero_idx(), limb_0.get_witness_index());
181
182 uint64_t num_last_limb_bits = (can_overflow) ? NUM_LIMB_BITS : NUM_LAST_LIMB_BITS;
183
184 bigfield result(ctx);
185 result.binary_basis_limbs[0] = Limb(limb_0, DEFAULT_MAXIMUM_LIMB);
186 result.binary_basis_limbs[1] = Limb(limb_1, DEFAULT_MAXIMUM_LIMB);
187 result.binary_basis_limbs[2] = Limb(limb_2, DEFAULT_MAXIMUM_LIMB);
188 result.binary_basis_limbs[3] =
189 Limb(limb_3, can_overflow ? DEFAULT_MAXIMUM_LIMB : DEFAULT_MAXIMUM_MOST_SIGNIFICANT_LIMB);
190
191 // if maximum_bitlength is set, this supercedes can_overflow
192 if (maximum_bitlength > 0) {
193 BB_ASSERT_GT(maximum_bitlength, 3 * NUM_LIMB_BITS);
194 num_last_limb_bits = maximum_bitlength - (3 * NUM_LIMB_BITS);
195 uint256_t max_limb_value = (uint256_t(1) << num_last_limb_bits) - 1;
196 result.binary_basis_limbs[3].maximum_value = max_limb_value;
197 }
198 result.prime_basis_limb = prime_limb;
199 ctx->range_constrain_two_limbs(limb_0.get_witness_index(),
200 limb_1.get_witness_index(),
201 static_cast<size_t>(NUM_LIMB_BITS),
202 static_cast<size_t>(NUM_LIMB_BITS),
203 "bigfield::create_from_u512_as_witness: limb 0 or 1 too large");
204 ctx->range_constrain_two_limbs(limb_2.get_witness_index(),
205 limb_3.get_witness_index(),
206 static_cast<size_t>(NUM_LIMB_BITS),
207 static_cast<size_t>(num_last_limb_bits),
208 "bigfield::create_from_u512_as_witness: limb 2 or 3 too large");
209
210 // Mark the element as coming out of nowhere
211 result.set_free_witness_tag();
212
213 return result;
214}
215
216template <typename Builder, typename T> bigfield<Builder, T>::bigfield(const byte_array<Builder>& bytes)
217{
218 BB_ASSERT_EQ(bytes.size(), 32U); // we treat input as a 256-bit big integer
219 const auto split_byte_into_nibbles = [](Builder* ctx, const field_t<Builder>& split_byte) {
220 const uint64_t byte_val = uint256_t(split_byte.get_value()).data[0];
221 const uint64_t lo_nibble_val = byte_val & 15ULL;
222 const uint64_t hi_nibble_val = byte_val >> 4;
223
224 const field_t<Builder> lo_nibble(witness_t<Builder>(ctx, lo_nibble_val));
225 const field_t<Builder> hi_nibble(witness_t<Builder>(ctx, hi_nibble_val));
226 lo_nibble.create_range_constraint(4, "bigfield: lo_nibble too large");
227 hi_nibble.create_range_constraint(4, "bigfield: hi_nibble too large");
228
229 const uint256_t hi_nibble_shift = uint256_t(1) << 4;
230 const field_t<Builder> sum = lo_nibble + (hi_nibble * hi_nibble_shift);
231 sum.assert_equal(split_byte);
232 lo_nibble.set_origin_tag(split_byte.tag);
233 hi_nibble.set_origin_tag(split_byte.tag);
234 return std::make_pair(lo_nibble, hi_nibble);
235 };
236
237 const auto reconstruct_two_limbs = [&split_byte_into_nibbles](Builder* ctx,
238 const field_t<Builder>& hi_bytes,
239 const field_t<Builder>& lo_bytes,
240 const field_t<Builder>& split_byte) {
241 const auto [lo_nibble, hi_nibble] = split_byte_into_nibbles(ctx, split_byte);
242
243 const uint256_t hi_bytes_shift = uint256_t(1) << 4;
244 const uint256_t lo_nibble_shift = uint256_t(1) << 64;
245 field_t<Builder> hi_limb = hi_nibble + hi_bytes * hi_bytes_shift;
246 field_t<Builder> lo_limb = lo_bytes + lo_nibble * lo_nibble_shift;
247 return std::make_pair(lo_limb, hi_limb);
248 };
249 Builder* ctx = bytes.get_context();
250
251 // The input bytes are interpreted as a 256-bit integer, which is split into 4 limbs as follows:
252 //
253 // overlap byte overlap byte
254 // ↓ ↓
255 // [ b31 b30 ... b25 b24 | b23 | b22 b21 ... b16 b15 | b14 b13 ... b8 b7 | b06 | b5 b4 ... b1 b0 ]
256 // |--------------------------|--------------------------|-----------------------|----------------------|
257 // ↑ 68 bits ↑ 68 bits ↑ 68 bits ↑ 52 bits ↑
258 // [ limb l0 | limb l1 | limb l2 | limb l3 ]
259 //
260 const field_t<Builder> hi_8_bytes(bytes.slice(0, 6));
261 const field_t<Builder> mid_split_byte(bytes.slice(6, 1));
262 const field_t<Builder> mid_8_bytes(bytes.slice(7, 8));
263
264 const field_t<Builder> lo_8_bytes(bytes.slice(15, 8));
265 const field_t<Builder> lo_split_byte(bytes.slice(23, 1));
266 const field_t<Builder> lolo_8_bytes(bytes.slice(24, 8));
267
268 const auto [limb0, limb1] = reconstruct_two_limbs(ctx, lo_8_bytes, lolo_8_bytes, lo_split_byte);
269 const auto [limb2, limb3] = reconstruct_two_limbs(ctx, hi_8_bytes, mid_8_bytes, mid_split_byte);
270
271 const auto res = bigfield::unsafe_construct_from_limbs(limb0, limb1, limb2, limb3, true);
272
273 const auto num_last_limb_bits = 256 - (NUM_LIMB_BITS * 3);
274 res.binary_basis_limbs[3].maximum_value = (uint64_t(1) << num_last_limb_bits) - 1;
275 *this = res;
276 set_origin_tag(bytes.get_origin_tag());
277}
278
279template <typename Builder, typename T> bigfield<Builder, T>& bigfield<Builder, T>::operator=(const bigfield& other)
280{
281 if (this == &other) {
282 return *this;
283 }
284 context = other.context;
285 binary_basis_limbs[0] = other.binary_basis_limbs[0];
286 binary_basis_limbs[1] = other.binary_basis_limbs[1];
287 binary_basis_limbs[2] = other.binary_basis_limbs[2];
288 binary_basis_limbs[3] = other.binary_basis_limbs[3];
289 prime_basis_limb = other.prime_basis_limb;
290 return *this;
291}
293template <typename Builder, typename T> bigfield<Builder, T>& bigfield<Builder, T>::operator=(bigfield&& other) noexcept
294{
295 context = other.context;
296 binary_basis_limbs[0] = other.binary_basis_limbs[0];
297 binary_basis_limbs[1] = other.binary_basis_limbs[1];
298 binary_basis_limbs[2] = other.binary_basis_limbs[2];
299 binary_basis_limbs[3] = other.binary_basis_limbs[3];
300 prime_basis_limb = other.prime_basis_limb;
301 return *this;
302}
303
304template <typename Builder, typename T> uint512_t bigfield<Builder, T>::get_value() const
305{
306 uint512_t t0 = uint256_t(binary_basis_limbs[0].element.get_value());
307 uint512_t t1 = uint256_t(binary_basis_limbs[1].element.get_value());
308 uint512_t t2 = uint256_t(binary_basis_limbs[2].element.get_value());
309 uint512_t t3 = uint256_t(binary_basis_limbs[3].element.get_value());
310 return t0 + (t1 << (NUM_LIMB_BITS)) + (t2 << (2 * NUM_LIMB_BITS)) + (t3 << (3 * NUM_LIMB_BITS));
313template <typename Builder, typename T> uint512_t bigfield<Builder, T>::get_maximum_value() const
314{
315 uint512_t t0 = uint512_t(binary_basis_limbs[0].maximum_value);
316 uint512_t t1 = uint512_t(binary_basis_limbs[1].maximum_value) << NUM_LIMB_BITS;
317 uint512_t t2 = uint512_t(binary_basis_limbs[2].maximum_value) << (NUM_LIMB_BITS * 2);
318 uint512_t t3 = uint512_t(binary_basis_limbs[3].maximum_value) << (NUM_LIMB_BITS * 3);
319 return t0 + t1 + t2 + t3;
320}
321
322template <typename Builder, typename T>
324 const uint256_t& other_maximum_value) const
325{
326 reduction_check();
327 BB_ASSERT_LTE(uint512_t(other_maximum_value) + uint512_t(binary_basis_limbs[0].maximum_value),
328 uint512_t(get_maximum_unreduced_limb_value()));
329 // needed cause a constant doesn't have a valid context
330 Builder* ctx = context ? context : other.context;
331
332 if (is_constant() && other.is_constant()) {
333 return bigfield(ctx, uint256_t((get_value() + uint256_t(other.get_value())) % modulus_u512));
334 }
335
336 bigfield result;
337 // If the original value is constant, we have to reinitialize the higher limbs to be witnesses when adding a witness
338 if (is_constant()) {
339 auto context = other.context;
340 for (size_t i = 1; i < NUM_LIMBS; i++) {
341 // Construct a witness element from the original constant limb
342 result.binary_basis_limbs[i] =
343 Limb(field_t<Builder>::from_witness(context, binary_basis_limbs[i].element.get_value()),
344 binary_basis_limbs[i].maximum_value);
345 // Ensure it is fixed
346 result.binary_basis_limbs[i].element.fix_witness();
347 result.context = ctx;
348 }
349 } else {
350
351 // if this element is a witness, then all limbs will be witnesses
352 result = *this;
353 }
354 result.binary_basis_limbs[0].maximum_value = binary_basis_limbs[0].maximum_value + other_maximum_value;
355
356 result.binary_basis_limbs[0].element = binary_basis_limbs[0].element + other;
357 result.prime_basis_limb = prime_basis_limb + other;
358 result.set_origin_tag(OriginTag(get_origin_tag(), other.tag));
359 return result;
360}
362template <typename Builder, typename T>
364{
365 reduction_check();
366 other.reduction_check();
367 // needed cause a constant doesn't have a valid context
368 Builder* ctx = context ? context : other.context;
369
370 if (is_constant() && other.is_constant()) {
371 auto result = bigfield(ctx, uint256_t((get_value() + other.get_value()) % modulus_u512));
372 result.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
373 return result;
374 }
375 bigfield result(ctx);
376 result.binary_basis_limbs[0].maximum_value =
377 binary_basis_limbs[0].maximum_value + other.binary_basis_limbs[0].maximum_value;
378 result.binary_basis_limbs[1].maximum_value =
379 binary_basis_limbs[1].maximum_value + other.binary_basis_limbs[1].maximum_value;
380 result.binary_basis_limbs[2].maximum_value =
381 binary_basis_limbs[2].maximum_value + other.binary_basis_limbs[2].maximum_value;
382 result.binary_basis_limbs[3].maximum_value =
383 binary_basis_limbs[3].maximum_value + other.binary_basis_limbs[3].maximum_value;
384
385 // If both the elements are witnesses, we use an optimized addition trick that uses 4 gates instead of 5.
386 //
387 // Naively, we would need 5 gates to add two bigfield elements: 4 gates to add the binary basis limbs and
388 // 1 gate to add the prime basis limbs.
389 //
390 // In the optimized version, we fit 15 witnesses into 4 gates (4 + 4 + 4 + 3 = 15), and we add the prime basis limbs
391 // and one of the binary basis limbs in the first gate.
392 // gate 1: z.limb_0 = x.limb_0 + y.limb_0 && z.prime_limb = x.prime_limb + y.prime_limb
393 // gate 2: z.limb_1 = x.limb_1 + y.limb_1
394 // gate 3: z.limb_2 = x.limb_2 + y.limb_2
395 // gate 4: z.limb_3 = x.limb_3 + y.limb_3
396 //
397 bool both_witness = !is_constant() && !other.is_constant();
398 bool both_prime_limb_multiplicative_constant_one =
399 (prime_basis_limb.multiplicative_constant == 1 && other.prime_basis_limb.multiplicative_constant == 1);
400 if (both_prime_limb_multiplicative_constant_one && both_witness) {
401 bool limbconst = is_constant() || other.is_constant() ||
402 field_ct::witness_indices_match(prime_basis_limb, other.prime_basis_limb);
403 if (!limbconst) {
404 // Extract witness indices and multiplicative constants for binary basis limbs
405 std::array<std::pair<uint32_t, bb::fr>, NUM_LIMBS> x_scaled;
406 std::array<std::pair<uint32_t, bb::fr>, NUM_LIMBS> y_scaled;
409 for (size_t i = 0; i < NUM_LIMBS; ++i) {
410 const auto& x_limb = binary_basis_limbs[i].element;
411 const auto& y_limb = other.binary_basis_limbs[i].element;
412
413 x_scaled[i] = { x_limb.witness_index, x_limb.multiplicative_constant };
414 y_scaled[i] = { y_limb.witness_index, y_limb.multiplicative_constant };
415 c_adds[i] = bb::fr(x_limb.additive_constant + y_limb.additive_constant);
416 }
417
418 // Extract witness indices for prime basis limb
419 uint32_t x_prime(prime_basis_limb.witness_index);
420 uint32_t y_prime(other.prime_basis_limb.witness_index);
421 bb::fr c_prime(prime_basis_limb.additive_constant + other.prime_basis_limb.additive_constant);
422
423 const auto output_witnesses =
424 ctx->evaluate_non_native_field_addition({ x_scaled[0], y_scaled[0], c_adds[0] },
425 { x_scaled[1], y_scaled[1], c_adds[1] },
426 { x_scaled[2], y_scaled[2], c_adds[2] },
427 { x_scaled[3], y_scaled[3], c_adds[3] },
428 { x_prime, y_prime, c_prime });
429
430 result.binary_basis_limbs[0].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[0]);
431 result.binary_basis_limbs[1].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[1]);
432 result.binary_basis_limbs[2].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[2]);
433 result.binary_basis_limbs[3].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[3]);
434 result.prime_basis_limb = field_t<Builder>::from_witness_index(ctx, output_witnesses[4]);
435 result.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
436 return result;
437 }
439
440 // If one of the elements is a constant or its prime limb does not have a multiplicative constant of 1, we
441 // use the standard addition method. This will not use additional gates because field addition with one constant
442 // does not require any additional gates.
443 result.binary_basis_limbs[0].element = binary_basis_limbs[0].element + other.binary_basis_limbs[0].element;
444 result.binary_basis_limbs[1].element = binary_basis_limbs[1].element + other.binary_basis_limbs[1].element;
445 result.binary_basis_limbs[2].element = binary_basis_limbs[2].element + other.binary_basis_limbs[2].element;
446 result.binary_basis_limbs[3].element = binary_basis_limbs[3].element + other.binary_basis_limbs[3].element;
447 result.prime_basis_limb = prime_basis_limb + other.prime_basis_limb;
448
449 result.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
450 return result;
451}
452
453template <typename Builder, typename T>
455{
456 reduction_check();
457 add_a.reduction_check();
458 add_b.reduction_check();
459
460 Builder* ctx = (context == nullptr) ? (add_a.context == nullptr ? add_b.context : add_a.context) : context;
461
462 if (is_constant() && add_a.is_constant() && add_b.is_constant()) {
463 auto result = bigfield(ctx, uint256_t((get_value() + add_a.get_value() + add_b.get_value()) % modulus_u512));
464 result.set_origin_tag(OriginTag(this->get_origin_tag(), add_a.get_origin_tag(), add_b.get_origin_tag()));
465 return result;
466 }
467
468 bigfield result(ctx);
469 result.binary_basis_limbs[0].maximum_value = binary_basis_limbs[0].maximum_value +
470 add_a.binary_basis_limbs[0].maximum_value +
471 add_b.binary_basis_limbs[0].maximum_value;
472 result.binary_basis_limbs[1].maximum_value = binary_basis_limbs[1].maximum_value +
473 add_a.binary_basis_limbs[1].maximum_value +
474 add_b.binary_basis_limbs[1].maximum_value;
475 result.binary_basis_limbs[2].maximum_value = binary_basis_limbs[2].maximum_value +
476 add_a.binary_basis_limbs[2].maximum_value +
477 add_b.binary_basis_limbs[2].maximum_value;
478 result.binary_basis_limbs[3].maximum_value = binary_basis_limbs[3].maximum_value +
479 add_a.binary_basis_limbs[3].maximum_value +
480 add_b.binary_basis_limbs[3].maximum_value;
481
482 result.binary_basis_limbs[0].element =
483 binary_basis_limbs[0].element.add_two(add_a.binary_basis_limbs[0].element, add_b.binary_basis_limbs[0].element);
484 result.binary_basis_limbs[1].element =
485 binary_basis_limbs[1].element.add_two(add_a.binary_basis_limbs[1].element, add_b.binary_basis_limbs[1].element);
486 result.binary_basis_limbs[2].element =
487 binary_basis_limbs[2].element.add_two(add_a.binary_basis_limbs[2].element, add_b.binary_basis_limbs[2].element);
488 result.binary_basis_limbs[3].element =
489 binary_basis_limbs[3].element.add_two(add_a.binary_basis_limbs[3].element, add_b.binary_basis_limbs[3].element);
490 result.prime_basis_limb = prime_basis_limb.add_two(add_a.prime_basis_limb, add_b.prime_basis_limb);
491 result.set_origin_tag(OriginTag(this->get_origin_tag(), add_a.get_origin_tag(), add_b.get_origin_tag()));
492 return result;
493}
494
495template <typename Builder, typename T>
497{
498 Builder* ctx = context ? context : other.context;
499 reduction_check();
500 other.reduction_check();
501
502 if (is_constant() && other.is_constant()) {
503 uint512_t left = get_value() % modulus_u512;
504 uint512_t right = other.get_value() % modulus_u512;
505 uint512_t out = (left + modulus_u512 - right) % modulus_u512;
506
507 auto result = bigfield(ctx, uint256_t(out.lo));
508 result.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
509 return result;
510 }
511
512 if (other.is_constant()) {
513 uint512_t right = other.get_value() % modulus_u512;
514 uint512_t neg_right = (modulus_u512 - right) % modulus_u512;
515 bigfield summand = bigfield(ctx, uint256_t(neg_right.lo));
516 summand.set_origin_tag(OriginTag(other.get_origin_tag()));
517 return operator+(summand);
518 }
519
537 bigfield result(ctx);
538
547 uint256_t limb_0_maximum_value = other.binary_basis_limbs[0].maximum_value;
549 // Compute maximum shift factor for limb_0
550 uint64_t limb_0_borrow_shift = std::max(limb_0_maximum_value.get_msb() + 1, NUM_LIMB_BITS);
551
552 // Compute the maximum negative value of limb_1, including the bits limb_0 may need to borrow
553 uint256_t limb_1_maximum_value =
554 other.binary_basis_limbs[1].maximum_value + (uint256_t(1) << (limb_0_borrow_shift - NUM_LIMB_BITS));
555
556 // repeat the above for the remaining limbs
557 uint64_t limb_1_borrow_shift = std::max(limb_1_maximum_value.get_msb() + 1, NUM_LIMB_BITS);
558 uint256_t limb_2_maximum_value =
559 other.binary_basis_limbs[2].maximum_value + (uint256_t(1) << (limb_1_borrow_shift - NUM_LIMB_BITS));
560 uint64_t limb_2_borrow_shift = std::max(limb_2_maximum_value.get_msb() + 1, NUM_LIMB_BITS);
561
562 uint256_t limb_3_maximum_value =
563 other.binary_basis_limbs[3].maximum_value + (uint256_t(1) << (limb_2_borrow_shift - NUM_LIMB_BITS));
564
573 uint1024_t constant_to_add_factor =
574 (uint1024_t(limb_3_maximum_value) << (NUM_LIMB_BITS * 3)) / uint1024_t(modulus_u512) + uint1024_t(1);
575 uint512_t constant_to_add = constant_to_add_factor.lo * modulus_u512;
576
601 uint256_t t0(uint256_t(1) << limb_0_borrow_shift);
602 uint256_t t1((uint256_t(1) << limb_1_borrow_shift) - (uint256_t(1) << (limb_0_borrow_shift - NUM_LIMB_BITS)));
603 uint256_t t2((uint256_t(1) << limb_2_borrow_shift) - (uint256_t(1) << (limb_1_borrow_shift - NUM_LIMB_BITS)));
604 uint256_t t3(uint256_t(1) << (limb_2_borrow_shift - NUM_LIMB_BITS));
605
610 uint256_t to_add_0 = uint256_t(constant_to_add.slice(0, NUM_LIMB_BITS)) + t0;
611 uint256_t to_add_1 = uint256_t(constant_to_add.slice(NUM_LIMB_BITS, NUM_LIMB_BITS * 2)) + t1;
612 uint256_t to_add_2 = uint256_t(constant_to_add.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 3)) + t2;
613 uint256_t to_add_3 = uint256_t(constant_to_add.slice(NUM_LIMB_BITS * 3, NUM_LIMB_BITS * 4)) - t3;
614
618 result.binary_basis_limbs[0].maximum_value = binary_basis_limbs[0].maximum_value + to_add_0;
619 result.binary_basis_limbs[1].maximum_value = binary_basis_limbs[1].maximum_value + to_add_1;
620 result.binary_basis_limbs[2].maximum_value = binary_basis_limbs[2].maximum_value + to_add_2;
621 result.binary_basis_limbs[3].maximum_value = binary_basis_limbs[3].maximum_value + to_add_3;
622
626 result.binary_basis_limbs[0].element = binary_basis_limbs[0].element + bb::fr(to_add_0);
627 result.binary_basis_limbs[1].element = binary_basis_limbs[1].element + bb::fr(to_add_1);
628 result.binary_basis_limbs[2].element = binary_basis_limbs[2].element + bb::fr(to_add_2);
629 result.binary_basis_limbs[3].element = binary_basis_limbs[3].element + bb::fr(to_add_3);
630
631 bool both_witness = !is_constant() && !other.is_constant();
632 bool both_prime_limb_multiplicative_constant_one =
633 (prime_basis_limb.multiplicative_constant == 1 && other.prime_basis_limb.multiplicative_constant == 1);
634 if (both_prime_limb_multiplicative_constant_one && both_witness) {
635 bool limbconst = is_constant() || other.is_constant() ||
636 field_ct::witness_indices_match(prime_basis_limb, other.prime_basis_limb);
637
638 if (!limbconst) {
639 // Extract witness indices and multiplicative constants for binary basis limbs
640 std::array<std::pair<uint32_t, bb::fr>, NUM_LIMBS> x_scaled;
641 std::array<std::pair<uint32_t, bb::fr>, NUM_LIMBS> y_scaled;
643
644 for (size_t i = 0; i < NUM_LIMBS; ++i) {
645 const auto& x_limb = result.binary_basis_limbs[i].element;
646 const auto& y_limb = other.binary_basis_limbs[i].element;
647
648 x_scaled[i] = { x_limb.witness_index, x_limb.multiplicative_constant };
649 y_scaled[i] = { y_limb.witness_index, y_limb.multiplicative_constant };
650 c_diffs[i] = bb::fr(x_limb.additive_constant - y_limb.additive_constant);
651 }
652
653 // Extract witness indices for prime basis limb
654 uint32_t x_prime(prime_basis_limb.witness_index);
655 uint32_t y_prime(other.prime_basis_limb.witness_index);
656 bb::fr c_prime(prime_basis_limb.additive_constant - other.prime_basis_limb.additive_constant);
657 uint512_t constant_to_add_mod_native = (constant_to_add) % prime_basis.modulus;
658 c_prime += bb::fr(constant_to_add_mod_native.lo);
659
660 const auto output_witnesses =
661 ctx->evaluate_non_native_field_subtraction({ x_scaled[0], y_scaled[0], c_diffs[0] },
662 { x_scaled[1], y_scaled[1], c_diffs[1] },
663 { x_scaled[2], y_scaled[2], c_diffs[2] },
664 { x_scaled[3], y_scaled[3], c_diffs[3] },
665 { x_prime, y_prime, c_prime });
666
667 result.binary_basis_limbs[0].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[0]);
668 result.binary_basis_limbs[1].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[1]);
669 result.binary_basis_limbs[2].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[2]);
670 result.binary_basis_limbs[3].element = field_t<Builder>::from_witness_index(ctx, output_witnesses[3]);
671 result.prime_basis_limb = field_t<Builder>::from_witness_index(ctx, output_witnesses[4]);
672
673 result.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
674 return result;
675 }
676 }
677
678 result.binary_basis_limbs[0].element -= other.binary_basis_limbs[0].element;
679 result.binary_basis_limbs[1].element -= other.binary_basis_limbs[1].element;
680 result.binary_basis_limbs[2].element -= other.binary_basis_limbs[2].element;
681 result.binary_basis_limbs[3].element -= other.binary_basis_limbs[3].element;
682
686 uint512_t constant_to_add_mod_native = (constant_to_add) % prime_basis.modulus;
687 field_t prime_basis_to_add(ctx, bb::fr(constant_to_add_mod_native.lo));
688 result.prime_basis_limb = prime_basis_limb + prime_basis_to_add;
689 result.prime_basis_limb -= other.prime_basis_limb;
690 return result;
691}
692
693template <typename Builder, typename T>
695{
696 // First we do basic reduction checks of individual elements
697 reduction_check();
698 other.reduction_check();
699 Builder* ctx = context ? context : other.context;
700 // Now we can actually compute the quotient and remainder values
701 const auto [quotient_value, remainder_value] = compute_quotient_remainder_values(*this, other, {});
702 bigfield remainder;
703 bigfield quotient;
704 // If operands are constant, define result as a constant value and return
705 if (is_constant() && other.is_constant()) {
706 remainder = bigfield(ctx, uint256_t(remainder_value.lo));
707 remainder.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
708 return remainder;
709 } else {
710 // when writing a*b = q*p + r we wish to enforce r<2^s for smallest s such that p<2^s
711 // hence the second constructor call is with can_overflow=false. This will allow using r in more additions
712 // mod 2^t without needing to apply the mod, where t=4*NUM_LIMB_BITS
713
714 // Check if the product overflows CRT or the quotient can't be contained in a range proof and reduce
715 // accordingly
716 auto [reduction_required, num_quotient_bits] =
717 get_quotient_reduction_info({ get_maximum_value() }, { other.get_maximum_value() }, {});
718 if (reduction_required) {
719 if (get_maximum_value() > other.get_maximum_value()) {
720 self_reduce();
721 } else {
722 other.self_reduce();
723 }
724 return (*this).operator*(other);
725 }
726 quotient = create_from_u512_as_witness(ctx, quotient_value, false, num_quotient_bits);
727 remainder = create_from_u512_as_witness(ctx, remainder_value);
728 };
729
730 // Call `evaluate_multiply_add` to validate the correctness of our computed quotient and remainder
731 unsafe_evaluate_multiply_add(*this, other, {}, quotient, { remainder });
732
733 remainder.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
734 return remainder;
735}
736
737template <typename Builder, typename T>
739{
740
741 return internal_div({ *this }, other, true);
742}
751template <typename Builder, typename T>
753{
754 BB_ASSERT_GT(terms.size(), 0U);
755
756 if (terms.size() == 1) {
757 return terms[0];
758 }
759
760 bigfield acc = terms[0];
761 for (size_t i = 1; i < (terms.size() + 1) / 2; i++) {
762 acc = acc.add_two(terms[2 * i - 1], terms[2 * i]);
763 }
764 if ((terms.size() & 1) == 0) {
765 acc += terms[terms.size() - 1];
766 }
767 return acc;
768}
769
779template <typename Builder, typename T>
781 const bigfield& denominator,
782 bool check_for_zero)
783{
784 BB_ASSERT_LT(numerators.size(), MAXIMUM_SUMMAND_COUNT);
785 if (numerators.empty()) {
786 if (check_for_zero) {
787 // We do not want to trigger division by zero in the empty sum case
788 denominator.assert_is_not_equal(zero());
789 }
790 return bigfield<Builder, T>(denominator.get_context(), uint256_t(0));
791 }
792
793 denominator.reduction_check();
794 Builder* ctx = denominator.context;
795 uint512_t numerator_values(0);
796 bool numerator_constant = true;
797 OriginTag tag = denominator.get_origin_tag();
798 for (const auto& numerator_element : numerators) {
799 ctx = (ctx == nullptr) ? numerator_element.get_context() : ctx;
800 numerator_element.reduction_check();
801 numerator_values += numerator_element.get_value();
802 numerator_constant = numerator_constant && (numerator_element.is_constant());
803 tag = OriginTag(tag, numerator_element.get_origin_tag());
804 }
805
806 // a / b = c
807 // => c * b = a mod p
808 const uint1024_t left = uint1024_t(numerator_values);
809 const uint1024_t right = uint1024_t(denominator.get_value());
810 const uint1024_t modulus(target_basis.modulus);
811 // We don't want to trigger the uint assert
812 uint512_t inverse_value(0);
813 if (right.lo != uint512_t(0)) {
814 inverse_value = right.lo.invmod(target_basis.modulus).lo;
815 }
816 uint1024_t inverse_1024(inverse_value);
817 inverse_value = ((left * inverse_1024) % modulus).lo;
818
819 const uint1024_t quotient_1024 =
820 (uint1024_t(inverse_value) * right + unreduced_zero().get_value() - left) / modulus;
821 const uint512_t quotient_value = quotient_1024.lo;
822
823 bigfield inverse;
824 bigfield quotient;
825 if (numerator_constant && denominator.is_constant()) {
826 if (check_for_zero) {
827 // We want to avoid division by zero in the constant case
828 BB_ASSERT(denominator.get_value() != uint512_t(0), "bigfield: division by zero in constant division");
829 }
830 inverse = bigfield(ctx, uint256_t(inverse_value));
831 inverse.set_origin_tag(tag);
832 return inverse;
833 } else {
834 // NOTE(https://github.com/AztecProtocol/aztec-packages/issues/15385): We can do a simplification when the
835 // denominator is constant. We can compute its inverse out-of-circuit and then multiply it with the numerator.
836 // We only add the check if the result is non-constant
837 std::vector<uint1024_t> numerator_max;
838 for (const auto& n : numerators) {
839 numerator_max.push_back(n.get_maximum_value());
840 }
841
842 auto [reduction_required, num_quotient_bits] =
843 get_quotient_reduction_info({ static_cast<uint512_t>(DEFAULT_MAXIMUM_REMAINDER) },
844 { denominator.get_maximum_value() },
845 { unreduced_zero() },
846 numerator_max);
847 if (reduction_required) {
848
849 denominator.self_reduce();
850 return internal_div(numerators, denominator, check_for_zero);
851 }
852 // We do this after the quotient check, since this creates gates and we don't want to do this twice
853 if (check_for_zero) {
854 denominator.assert_is_not_equal(zero());
855 }
856
857 quotient = create_from_u512_as_witness(ctx, quotient_value, false, num_quotient_bits);
858 inverse = create_from_u512_as_witness(ctx, inverse_value);
859 }
860
861 inverse.set_origin_tag(tag);
862 unsafe_evaluate_multiply_add(denominator, inverse, { unreduced_zero() }, quotient, numerators);
863 return inverse;
864}
865
872template <typename Builder, typename T>
874 const bigfield& denominator)
875{
876 return internal_div(numerators, denominator, false);
877}
878
879template <typename Builder, typename T>
881{
882 return internal_div({ *this }, denominator, false);
883}
884
890template <typename Builder, typename T>
892 const bigfield& denominator)
893{
894 return internal_div(numerators, denominator, true);
895}
896
897template <typename Builder, typename T> bigfield<Builder, T> bigfield<Builder, T>::sqr() const
898{
899 reduction_check();
900 Builder* ctx = context;
901
902 const auto [quotient_value, remainder_value] = compute_quotient_remainder_values(*this, *this, {});
903
904 bigfield remainder;
905 bigfield quotient;
906 if (is_constant()) {
907 remainder = bigfield(ctx, uint256_t(remainder_value.lo));
908 return remainder;
909 } else {
910
911 auto [reduction_required, num_quotient_bits] = get_quotient_reduction_info(
912 { get_maximum_value() }, { get_maximum_value() }, {}, { DEFAULT_MAXIMUM_REMAINDER });
913 if (reduction_required) {
914 self_reduce();
915 return sqr();
916 }
917
918 quotient = create_from_u512_as_witness(ctx, quotient_value, false, num_quotient_bits);
919 remainder = create_from_u512_as_witness(ctx, remainder_value);
920 };
921
922 unsafe_evaluate_square_add(*this, {}, quotient, remainder);
923 remainder.set_origin_tag(get_origin_tag());
924 return remainder;
925}
926
927template <typename Builder, typename T>
929{
930 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
931 reduction_check();
932
933 Builder* ctx = context;
934
936 bool add_constant = true;
937 for (const auto& add_element : to_add) {
938 add_element.reduction_check();
939 add_values += add_element.get_value();
940 add_constant = add_constant && (add_element.is_constant());
941 }
942
943 const uint1024_t left(get_value());
944 const uint1024_t right(get_value());
945 const uint1024_t add_right(add_values);
946 const uint1024_t modulus(target_basis.modulus);
947
948 bigfield remainder;
949 bigfield quotient;
950 if (is_constant()) {
951 if (add_constant) {
952
953 const auto [quotient_1024, remainder_1024] = (left * right + add_right).divmod(modulus);
954 remainder = bigfield(ctx, uint256_t(remainder_1024.lo.lo));
955 // Merge tags
956 OriginTag new_tag = get_origin_tag();
957 for (auto& element : to_add) {
958 new_tag = OriginTag(new_tag, element.get_origin_tag());
959 }
960 remainder.set_origin_tag(new_tag);
961 return remainder;
962 } else {
963
964 const auto [quotient_1024, remainder_1024] = (left * right).divmod(modulus);
965 std::vector<bigfield> new_to_add;
966 for (auto& add_element : to_add) {
967 new_to_add.push_back(add_element);
968 }
969
970 new_to_add.push_back(bigfield(ctx, remainder_1024.lo.lo));
971 return sum(new_to_add);
972 }
973 } else {
974
975 // Check the quotient fits the range proof
976 auto [reduction_required, num_quotient_bits] = get_quotient_reduction_info(
977 { get_maximum_value() }, { get_maximum_value() }, to_add, { DEFAULT_MAXIMUM_REMAINDER });
978
979 if (reduction_required) {
980 self_reduce();
981 return sqradd(to_add);
982 }
983 const auto [quotient_1024, remainder_1024] = (left * right + add_right).divmod(modulus);
984 uint512_t quotient_value = quotient_1024.lo;
985 uint256_t remainder_value = remainder_1024.lo.lo;
986
987 quotient = create_from_u512_as_witness(ctx, quotient_value, false, num_quotient_bits);
988 remainder = create_from_u512_as_witness(ctx, remainder_value);
989 };
990 OriginTag new_tag = get_origin_tag();
991 for (auto& element : to_add) {
992 new_tag = OriginTag(new_tag, element.get_origin_tag());
993 }
994 remainder.set_origin_tag(new_tag);
995 unsafe_evaluate_square_add(*this, to_add, quotient, remainder);
996 return remainder;
997}
998
999template <typename Builder, typename T> bigfield<Builder, T> bigfield<Builder, T>::pow(const uint32_t exponent) const
1000{
1001 // Just return one immediately
1002 if (exponent == 0) {
1003 return bigfield(uint256_t(1));
1004 }
1005
1006 // If this is a constant, compute result directly
1007 if (is_constant()) {
1008 auto base_val = get_value();
1009 uint512_t result_val = 1;
1010 uint512_t base = base_val % modulus_u512;
1011 uint32_t shifted_exponent = exponent;
1012
1013 // Fast modular exponentiation
1014 while (shifted_exponent > 0) {
1015 if (shifted_exponent & 1) {
1016 result_val = (uint1024_t(result_val) * uint1024_t(base) % uint1024_t(modulus_u512)).lo;
1017 }
1018 base = (uint1024_t(base) * uint1024_t(base) % uint1024_t(modulus_u512)).lo;
1019 shifted_exponent >>= 1;
1020 }
1021 return bigfield(this->context, uint256_t(result_val.lo));
1022 }
1023
1024 bool accumulator_initialized = false;
1025 bigfield accumulator;
1026 bigfield running_power = *this;
1027 uint32_t shifted_exponent = exponent;
1028
1029 // Square and multiply
1030 while (shifted_exponent != 0) {
1031 if (shifted_exponent & 1) {
1032 if (!accumulator_initialized) {
1033 accumulator = running_power;
1034 accumulator_initialized = true;
1035 } else {
1036 accumulator *= running_power;
1037 }
1038 }
1039 shifted_exponent >>= 1;
1040
1041 // Only square if there are more bits to process.
1042 // It is important to avoid squaring in the final iteration as it otherwise results in
1043 // unwanted gates and variables in the circuit.
1044 if (shifted_exponent != 0) {
1045 running_power = running_power.sqr();
1047 }
1048 return accumulator;
1049}
1050
1051template <typename Builder, typename T>
1053{
1054 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
1055 Builder* ctx = context ? context : to_mul.context;
1056 reduction_check();
1057 to_mul.reduction_check();
1058
1060 bool add_constant = true;
1061
1062 for (const auto& add_element : to_add) {
1063 add_element.reduction_check();
1064 add_values += add_element.get_value();
1065 add_constant = add_constant && (add_element.is_constant());
1066 }
1067
1068 const uint1024_t left(get_value());
1069 const uint1024_t mul_right(to_mul.get_value());
1070 const uint1024_t add_right(add_values);
1071 const uint1024_t modulus(target_basis.modulus);
1072
1073 const auto [quotient_1024, remainder_1024] = (left * mul_right + add_right).divmod(modulus);
1074
1075 const uint512_t quotient_value = quotient_1024.lo;
1076 const uint512_t remainder_value = remainder_1024.lo;
1077
1078 bigfield remainder;
1079 bigfield quotient;
1080 if (is_constant() && to_mul.is_constant() && add_constant) {
1081 remainder = bigfield(ctx, uint256_t(remainder_value.lo));
1082 return remainder;
1083 } else if (is_constant() && to_mul.is_constant()) {
1084 const auto [_, mul_remainder_1024] = (left * mul_right).divmod(modulus);
1085 std::vector<bigfield> to_add_copy(to_add);
1086 to_add_copy.push_back(bigfield(ctx, uint256_t(mul_remainder_1024.lo.lo)));
1087 return bigfield::sum(to_add_copy);
1088 } else {
1089 auto [reduction_required, num_quotient_bits] = get_quotient_reduction_info(
1090 { get_maximum_value() }, { to_mul.get_maximum_value() }, to_add, { DEFAULT_MAXIMUM_REMAINDER });
1091 if (reduction_required) {
1092 if (get_maximum_value() > to_mul.get_maximum_value()) {
1093 self_reduce();
1094 } else {
1095 to_mul.self_reduce();
1096 }
1097 return (*this).madd(to_mul, to_add);
1098 }
1099 quotient = create_from_u512_as_witness(ctx, quotient_value, false, num_quotient_bits);
1100 remainder = create_from_u512_as_witness(ctx, remainder_value);
1101 };
1102
1103 // We need to manually propagate the origin tag
1104 OriginTag new_tag = OriginTag(get_origin_tag(), to_mul.get_origin_tag());
1105 for (auto& element : to_add) {
1106 new_tag = OriginTag(new_tag, element.get_origin_tag());
1107 }
1108 remainder.set_origin_tag(new_tag);
1109 quotient.set_origin_tag(new_tag);
1110 unsafe_evaluate_multiply_add(*this, to_mul, to_add, quotient, { remainder });
1111
1112 return remainder;
1113}
1114
1126template <typename Builder, typename T>
1128 std::vector<bigfield>& mul_right,
1129 const std::vector<bigfield>& to_add)
1130{
1131 BB_ASSERT_EQ(mul_left.size(), mul_right.size());
1132 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
1133 BB_ASSERT_LTE(mul_left.size(), MAXIMUM_SUMMAND_COUNT);
1134
1135 const size_t number_of_products = mul_left.size();
1136 // Get the maximum values of elements
1137 std::vector<uint512_t> max_values_left;
1138 std::vector<uint512_t> max_values_right;
1139
1140 max_values_left.reserve(number_of_products);
1141 max_values_right.reserve(number_of_products);
1142 // Do regular reduction checks for all elements
1143 for (auto& left_element : mul_left) {
1144 left_element.reduction_check();
1145 max_values_left.emplace_back(left_element.get_maximum_value());
1146 }
1147
1148 for (auto& right_element : mul_right) {
1149 right_element.reduction_check();
1150 max_values_right.emplace_back(right_element.get_maximum_value());
1151 }
1153 // Perform CRT checks for the whole evaluation
1154 // 1. Check if we can overflow CRT modulus
1155 // 2. Check if the quotient actually fits in our range proof.
1156 // 3. If we haven't passed one of the checks, reduce accordingly, starting with the largest product
1157
1158 // We only get the bitlength of range proof if there is no reduction
1159 bool reduction_required = std::get<0>(
1160 get_quotient_reduction_info(max_values_left, max_values_right, to_add, { DEFAULT_MAXIMUM_REMAINDER }));
1161
1162 if (reduction_required) {
1163
1164 // We are out of luck and have to reduce the elements to keep the intermediate result below CRT modulus
1165 // For that we need to compute the maximum update - how much reducing each element is going to update the
1166 // quotient.
1167 // Contents of the tuple: | Qmax_before-Qmax_after | product number | argument number |
1169
1170 // We use this lambda function before the loop and in the loop itself
1171 // It computes the maximum value update from reduction of each element
1172 auto compute_updates = [](std::vector<std::tuple<uint1024_t, size_t, size_t>>& maxval_updates,
1173 std::vector<bigfield>& m_left,
1174 std::vector<bigfield>& m_right,
1175 size_t number_of_products) {
1176 maxval_updates.resize(0);
1177 maxval_updates.reserve(number_of_products * 2);
1178 // Compute all reduction differences
1179 for (size_t i = 0; i < number_of_products; i++) {
1180 uint1024_t original_left = static_cast<uint1024_t>(m_left[i].get_maximum_value());
1181 uint1024_t original_right = static_cast<uint1024_t>(m_right[i].get_maximum_value());
1182 uint1024_t original_product = original_left * original_right;
1183 if (m_left[i].is_constant()) {
1184 // If the multiplicand is constant, we can't reduce it, so the update is 0.
1185 maxval_updates.emplace_back(std::tuple<uint1024_t, size_t, size_t>(0, i, 0));
1186 } else {
1187 uint1024_t new_product = DEFAULT_MAXIMUM_REMAINDER * original_right;
1188 if (new_product > original_product) {
1189 throw_or_abort("bigfield: This should never happen");
1190 }
1191 maxval_updates.emplace_back(
1192 std::tuple<uint1024_t, size_t, size_t>(original_product - new_product, i, 0));
1193 }
1194 if (m_right[i].is_constant()) {
1195 // If the multiplicand is constant, we can't reduce it, so the update is 0.
1196 maxval_updates.emplace_back(std::tuple<uint1024_t, size_t, size_t>(0, i, 1));
1197 } else {
1198 uint1024_t new_product = DEFAULT_MAXIMUM_REMAINDER * original_left;
1199 if (new_product > original_product) {
1200 throw_or_abort("bigfield: This should never happen");
1201 }
1202 maxval_updates.emplace_back(
1203 std::tuple<uint1024_t, size_t, size_t>(original_product - new_product, i, 1));
1204 }
1205 }
1206 };
1207
1208 auto compare_update_tuples = [](std::tuple<uint1024_t, size_t, size_t>& left_element,
1210 return std::get<0>(left_element) > std::get<0>(right_element);
1211 };
1212
1213 // Now we loop through, reducing 1 element each time. This is costly in code, but allows us to use fewer
1214 // gates
1215
1216 while (reduction_required) {
1217 // Compute the possible reduction updates
1218 compute_updates(maximum_value_updates, mul_left, mul_right, number_of_products);
1219
1220 // Sort the vector, larger values first
1221 std::sort(maximum_value_updates.begin(), maximum_value_updates.end(), compare_update_tuples);
1222
1223 // We choose the largest update
1224 auto [update_size, largest_update_product_index, multiplicand_index] = maximum_value_updates[0];
1225 if (!update_size) {
1226 throw_or_abort("bigfield: Can't reduce further");
1227 }
1228 // Reduce the larger of the multiplicands that compose the product
1229 if (multiplicand_index == 0) {
1230 mul_left[largest_update_product_index].self_reduce();
1231 } else {
1232 mul_right[largest_update_product_index].self_reduce();
1233 }
1234
1235 for (size_t i = 0; i < number_of_products; i++) {
1236 max_values_left[i] = mul_left[i].get_maximum_value();
1237 max_values_right[i] = mul_right[i].get_maximum_value();
1238 }
1239 reduction_required = std::get<0>(
1240 get_quotient_reduction_info(max_values_left, max_values_right, to_add, { DEFAULT_MAXIMUM_REMAINDER }));
1241 }
1242
1243 // Now we have reduced everything exactly to the point of no overflow. There is probably a way to use even
1244 // fewer reductions, but for now this will suffice.
1245 }
1246}
1247
1257template <typename Builder, typename T>
1259 const std::vector<bigfield>& mul_right,
1260 const std::vector<bigfield>& to_add,
1261 bool fix_remainder_to_zero)
1262{
1263 BB_ASSERT_EQ(mul_left.size(), mul_right.size());
1264 BB_ASSERT_LTE(mul_left.size(), MAXIMUM_SUMMAND_COUNT);
1265 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
1266
1267 std::vector<bigfield> mutable_mul_left(mul_left);
1268 std::vector<bigfield> mutable_mul_right(mul_right);
1269
1270 const size_t number_of_products = mul_left.size();
1271
1272 const uint1024_t modulus(target_basis.modulus);
1273 uint1024_t worst_case_product_sum(0);
1274 uint1024_t add_right_constant_sum(0);
1275
1276 // First we do all constant optimizations
1277 bool add_constant = true;
1278 std::vector<bigfield> new_to_add;
1279
1280 OriginTag new_tag = OriginTag::constant(); // Initialize as CONSTANT so merging with input tags works correctly
1281 // Merge all tags. Do it in pairs (logically a submitted value can be masked by a challenge)
1282 for (auto [left_element, right_element] : zip_view(mul_left, mul_right)) {
1283 new_tag = OriginTag(new_tag, OriginTag(left_element.get_origin_tag(), right_element.get_origin_tag()));
1284 }
1285 for (auto& element : to_add) {
1286 new_tag = OriginTag(new_tag, element.get_origin_tag());
1287 }
1288
1289 for (const auto& add_element : to_add) {
1290 add_element.reduction_check();
1291 if (add_element.is_constant()) {
1292 add_right_constant_sum += uint1024_t(add_element.get_value());
1293 } else {
1294 add_constant = false;
1295 new_to_add.push_back(add_element);
1296 }
1297 }
1298
1299 // Compute the product sum
1300 // Optimize constant use
1301 uint1024_t sum_of_constant_products(0);
1302 std::vector<bigfield> new_input_left;
1303 std::vector<bigfield> new_input_right;
1304 bool product_sum_constant = true;
1305 for (size_t i = 0; i < number_of_products; i++) {
1306 if (mutable_mul_left[i].is_constant() && mutable_mul_right[i].is_constant()) {
1307 // If constant, just add to the sum
1308 sum_of_constant_products +=
1309 uint1024_t(mutable_mul_left[i].get_value()) * uint1024_t(mutable_mul_right[i].get_value());
1310 } else {
1311 // If not, add to nonconstant sum and remember the elements
1312 new_input_left.push_back(mutable_mul_left[i]);
1313 new_input_right.push_back(mutable_mul_right[i]);
1314 product_sum_constant = false;
1315 }
1316 }
1317
1318 Builder* ctx = nullptr;
1319 // Search through all multiplicands on the left
1320 for (auto& el : mutable_mul_left) {
1321 if (el.context) {
1322 ctx = el.context;
1323 break;
1324 }
1325 }
1326 // And on the right
1327 if (!ctx) {
1328 for (auto& el : mutable_mul_right) {
1329 if (el.context) {
1330 ctx = el.context;
1331 break;
1332 }
1333 }
1334 }
1335 if (product_sum_constant) {
1336 if (add_constant) {
1337 // Simply return the constant, no need unsafe_multiply_add
1338 const auto [quotient_1024, remainder_1024] =
1339 (sum_of_constant_products + add_right_constant_sum).divmod(modulus);
1340 BB_ASSERT(!fix_remainder_to_zero || remainder_1024 == 0);
1341 auto result = bigfield(ctx, uint256_t(remainder_1024.lo.lo));
1342 result.set_origin_tag(new_tag);
1343 return result;
1344 } else {
1345 const auto [quotient_1024, remainder_1024] =
1346 (sum_of_constant_products + add_right_constant_sum).divmod(modulus);
1347 uint256_t remainder_value = remainder_1024.lo.lo;
1348 bigfield result;
1349 if (remainder_value == uint256_t(0)) {
1350 // No need to add extra term to new_to_add
1351 result = sum(new_to_add);
1352 } else {
1353 // Add the constant term
1354 new_to_add.push_back(bigfield(ctx, uint256_t(remainder_value)));
1355 result = sum(new_to_add);
1356 }
1357 if (fix_remainder_to_zero) {
1358 result.self_reduce();
1359 result.assert_equal(zero());
1360 }
1361 result.set_origin_tag(new_tag);
1362 return result;
1363 }
1364 }
1365
1366 // Now that we know that there is at least 1 non-constant multiplication, we can start estimating reductions.
1367 BB_ASSERT(ctx != nullptr);
1368
1369 // Compute the constant term we're adding
1370 const auto [_, constant_part_remainder_1024] = (sum_of_constant_products + add_right_constant_sum).divmod(modulus);
1371 const uint256_t constant_part_remainder_256 = constant_part_remainder_1024.lo.lo;
1372
1373 if (constant_part_remainder_256 != uint256_t(0)) {
1374 new_to_add.push_back(bigfield(ctx, constant_part_remainder_256));
1375 }
1376 // Compute added sum
1377 uint1024_t add_right_final_sum(0);
1378 uint1024_t add_right_maximum(0);
1379 for (const auto& add_element : new_to_add) {
1380 // Technically not needed, but better to leave just in case
1381 add_element.reduction_check();
1382 add_right_final_sum += uint1024_t(add_element.get_value());
1383
1384 add_right_maximum += uint1024_t(add_element.get_maximum_value());
1385 }
1386 const size_t final_number_of_products = new_input_left.size();
1387
1388 // We need to check if it is possible to reduce the products enough
1389 worst_case_product_sum = uint1024_t(final_number_of_products) * uint1024_t(DEFAULT_MAXIMUM_REMAINDER) *
1390 uint1024_t(DEFAULT_MAXIMUM_REMAINDER);
1391
1392 // Check that we can actually reduce the products enough, this assert will probably never get triggered
1393 BB_ASSERT_LT(worst_case_product_sum + add_right_maximum, get_maximum_crt_product());
1394
1395 // We've collapsed all constants, checked if we can compute the sum of products in the worst case, time to check
1396 // if we need to reduce something
1397 perform_reductions_for_mult_madd(new_input_left, new_input_right, new_to_add);
1398 uint1024_t sum_of_products_final(0);
1399 for (size_t i = 0; i < final_number_of_products; i++) {
1400 sum_of_products_final += uint1024_t(new_input_left[i].get_value()) * uint1024_t(new_input_right[i].get_value());
1401 }
1402
1403 // Get the number of range proof bits for the quotient
1404 const size_t num_quotient_bits = get_quotient_max_bits({ DEFAULT_MAXIMUM_REMAINDER });
1405
1406 // Compute the quotient and remainder
1407 const auto [quotient_1024, remainder_1024] = (sum_of_products_final + add_right_final_sum).divmod(modulus);
1408
1409 // If we are establishing an identity and the remainder has to be zero, we need to check, that it actually is
1410
1411 if (fix_remainder_to_zero) {
1412 // This is not the only check. Circuit check is coming later :)
1413 BB_ASSERT_EQ(remainder_1024.lo, uint512_t(0));
1414 }
1415 const uint512_t quotient_value = quotient_1024.lo;
1416 const uint512_t remainder_value = remainder_1024.lo;
1417
1418 bigfield remainder;
1419 bigfield quotient;
1420 // Constrain quotient to mitigate CRT overflow attacks
1421 quotient = create_from_u512_as_witness(ctx, quotient_value, false, num_quotient_bits);
1422
1423 if (fix_remainder_to_zero) {
1424 remainder = zero();
1425 // remainder needs to be defined as wire value and not selector values to satisfy
1426 // Ultra's bigfield custom gates
1427 remainder.convert_constant_to_fixed_witness(ctx);
1428 } else {
1429 remainder = create_from_u512_as_witness(ctx, remainder_value);
1430 }
1431
1432 // We need to manually propagate the origin tag
1433 quotient.set_origin_tag(new_tag);
1434 remainder.set_origin_tag(new_tag);
1435
1436 unsafe_evaluate_multiple_multiply_add(new_input_left, new_input_right, new_to_add, quotient, { remainder });
1437
1438 return remainder;
1439}
1440
1446template <typename Builder, typename T>
1448 const bigfield& right_a,
1449 const bigfield& left_b,
1450 const bigfield& right_b,
1451 const std::vector<bigfield>& to_add)
1452{
1453 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
1454 left_a.reduction_check();
1455 right_a.reduction_check();
1456 left_b.reduction_check();
1457 right_b.reduction_check();
1458
1459 std::vector<bigfield> mul_left = { left_a, left_b };
1460 std::vector<bigfield> mul_right = { right_a, right_b };
1461
1462 return mult_madd(mul_left, mul_right, to_add);
1463}
1464
1483template <typename Builder, typename T>
1485 const std::vector<bigfield>& mul_right,
1486 const bigfield& divisor,
1487 const std::vector<bigfield>& to_sub,
1488 bool enable_divisor_nz_check)
1489{
1490 // Check the basics
1491 BB_ASSERT_EQ(mul_left.size(), mul_right.size());
1492 BB_ASSERT((divisor.get_value() % modulus_u512) != 0, "bigfield: Division by zero in msub_div");
1493
1494 OriginTag new_tag = divisor.get_origin_tag();
1495 for (auto [left_element, right_element] : zip_view(mul_left, mul_right)) {
1496 new_tag = OriginTag(new_tag, OriginTag(left_element.get_origin_tag(), right_element.get_origin_tag()));
1497 }
1498 for (auto& element : to_sub) {
1499 new_tag = OriginTag(new_tag, element.get_origin_tag());
1500 }
1501 // Get the context
1502 Builder* ctx = divisor.context;
1503 if (ctx == NULL) {
1504 for (auto& el : mul_left) {
1505 if (el.context != NULL) {
1506 ctx = el.context;
1507 break;
1508 }
1509 }
1510 }
1511 if (ctx == NULL) {
1512 for (auto& el : mul_right) {
1513 if (el.context != NULL) {
1514 ctx = el.context;
1515 break;
1516 }
1517 }
1518 }
1519 if (ctx == NULL) {
1520 for (auto& el : to_sub) {
1521 if (el.context != NULL) {
1522 ctx = el.context;
1523 break;
1524 }
1525 }
1526 }
1527 const size_t num_multiplications = mul_left.size();
1528 native product_native = 0;
1529 bool products_constant = true;
1530
1531 // This check is optional, because it is heavy and often we don't need it at all
1532 if (enable_divisor_nz_check) {
1533 divisor.assert_is_not_equal(zero());
1534 }
1535
1536 // Compute the sum of products
1537 for (size_t i = 0; i < num_multiplications; ++i) {
1538 const native mul_left_native(uint512_t(mul_left[i].get_value() % modulus_u512).lo);
1539 const native mul_right_native(uint512_t(mul_right[i].get_value() % modulus_u512).lo);
1540 product_native += (mul_left_native * -mul_right_native);
1541 products_constant = products_constant && mul_left[i].is_constant() && mul_right[i].is_constant();
1542 }
1543
1544 // Compute the sum of to_sub
1545 native sub_native(0);
1546 bool sub_constant = true;
1547 for (const auto& sub : to_sub) {
1548 sub_native += (uint512_t(sub.get_value() % modulus_u512).lo);
1549 sub_constant = sub_constant && sub.is_constant();
1550 }
1551
1552 native divisor_native(uint512_t(divisor.get_value() % modulus_u512).lo);
1553
1554 // Compute the result
1555 const native result_native = (product_native - sub_native) / divisor_native;
1556
1557 const uint1024_t result_value = uint1024_t(uint512_t(static_cast<uint256_t>(result_native)));
1558
1559 // If everything is constant, then we just return the constant
1560 if (sub_constant && products_constant && divisor.is_constant()) {
1561 auto result = bigfield(ctx, uint256_t(result_value.lo.lo));
1562 result.set_origin_tag(new_tag);
1563 return result;
1564 }
1565
1566 BB_ASSERT(ctx != NULL);
1567 // Create the result witness
1568 bigfield result = create_from_u512_as_witness(ctx, result_value.lo);
1569
1570 // We need to manually propagate the origin tag
1571 result.set_origin_tag(new_tag);
1572
1573 std::vector<bigfield> eval_left{ result };
1574 std::vector<bigfield> eval_right{ divisor };
1575 for (const auto& in : mul_left) {
1576 eval_left.emplace_back(in);
1577 }
1578 for (const auto& in : mul_right) {
1579 eval_right.emplace_back(in);
1580 }
1581
1582 mult_madd(eval_left, eval_right, to_sub, true);
1583
1584 return result;
1585}
1586
1587template <typename Builder, typename T>
1589{
1590 Builder* ctx = context ? context : predicate.context;
1591
1592 if (is_constant() && predicate.is_constant()) {
1593 auto result = *this;
1594 if (predicate.get_value()) {
1595 BB_ASSERT_LT(get_value(), modulus_u512);
1596 uint512_t out_val = (modulus_u512 - get_value()) % modulus_u512;
1597 result = bigfield(ctx, out_val.lo);
1598 }
1599 result.set_origin_tag(OriginTag(get_origin_tag(), predicate.get_origin_tag()));
1600 return result;
1601 }
1602 reduction_check();
1603
1604 // We want to check:
1605 // predicate = 1 ==> (0 - *this)
1606 // predicate = 0 ==> *this
1607 //
1608 // We just use the conditional_assign method to do this as it costs the same number of gates as computing
1609 // p * (0 - *this) + (1 - p) * (*this)
1610 //
1611 bigfield<Builder, T> negative_this = zero() - *this;
1612 bigfield<Builder, T> result = bigfield<Builder, T>::conditional_assign(predicate, negative_this, *this);
1613
1614 return result;
1615}
1616
1617template <typename Builder, typename T>
1619 const bool_t<Builder>& predicate) const
1620{
1621 // If the predicate is constant, the conditional selection can be done out of circuit
1622 if (predicate.is_constant()) {
1623 bigfield result = predicate.get_value() ? other : *this;
1624 result.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag(), predicate.get_origin_tag()));
1625 return result;
1626 }
1627
1628 // If both elements are the same, we can just return one of them
1629 auto is_limb_same = [](const field_ct& a, const field_ct& b) {
1630 const bool is_witness_index_same = field_ct::witness_indices_match(a, b);
1631 const bool is_add_constant_same = a.additive_constant == b.additive_constant;
1632 const bool is_mul_constant_same = a.multiplicative_constant == b.multiplicative_constant;
1633 return is_witness_index_same && is_add_constant_same && is_mul_constant_same;
1634 };
1635
1636 bool is_limb_0_same = is_limb_same(binary_basis_limbs[0].element, other.binary_basis_limbs[0].element);
1637 bool is_limb_1_same = is_limb_same(binary_basis_limbs[1].element, other.binary_basis_limbs[1].element);
1638 bool is_limb_2_same = is_limb_same(binary_basis_limbs[2].element, other.binary_basis_limbs[2].element);
1639 bool is_limb_3_same = is_limb_same(binary_basis_limbs[3].element, other.binary_basis_limbs[3].element);
1640 bool is_prime_limb_same = is_limb_same(prime_basis_limb, other.prime_basis_limb);
1641 if (is_limb_0_same && is_limb_1_same && is_limb_2_same && is_limb_3_same && is_prime_limb_same) {
1642 return *this;
1643 }
1644
1645 Builder* ctx = context ? context : (other.context ? other.context : predicate.context);
1646
1647 // For each limb, we must select:
1648 // `this` if predicate == 0
1649 // `other` if predicate == 1
1650 //
1651 // Thus, we compute the resulting limb as follows:
1652 // result.limb := predicate * (other.limb - this.limb) + this.limb.
1653 //
1654 // Note that each call to `madd` will add a gate as predicate is a witness at this point.
1655 // There can be edge cases where `this` and `other` are both constants and only differ in one limb.
1656 // In such a case, the `madd` for the differing limb will be a no-op (i.e., redundant gate), as the
1657 // difference will be zero. For example,
1658 // binary limbs prime limb
1659 // this: (0x5, 0x1, 0x0, 0x0) (0x100000000000000005)
1660 // other: (0x7, 0x1, 0x0, 0x0) (0x100000000000000007)
1661 // Here, the `madd` for the second, third and fourth binary limbs will be a no-op, as the difference
1662 // between `this` and `other` is zero for those limbs.
1663 //
1664 // We allow this to happen because we want to maintain limb consistency (i.e., all limbs either witness or
1665 // constant).
1666 field_ct binary_limb_0 = field_ct(predicate).madd(
1667 other.binary_basis_limbs[0].element - binary_basis_limbs[0].element, binary_basis_limbs[0].element);
1668 field_ct binary_limb_1 = field_ct(predicate).madd(
1669 other.binary_basis_limbs[1].element - binary_basis_limbs[1].element, binary_basis_limbs[1].element);
1670 field_ct binary_limb_2 = field_ct(predicate).madd(
1671 other.binary_basis_limbs[2].element - binary_basis_limbs[2].element, binary_basis_limbs[2].element);
1672 field_ct binary_limb_3 = field_ct(predicate).madd(
1673 other.binary_basis_limbs[3].element - binary_basis_limbs[3].element, binary_basis_limbs[3].element);
1674 field_ct prime_limb = field_ct(predicate).madd(other.prime_basis_limb - prime_basis_limb, prime_basis_limb);
1675
1676 bigfield result(ctx);
1677 // the maximum of the maximal values of elements is large enough
1678 result.binary_basis_limbs[0] =
1679 Limb(binary_limb_0, std::max(binary_basis_limbs[0].maximum_value, other.binary_basis_limbs[0].maximum_value));
1680 result.binary_basis_limbs[1] =
1681 Limb(binary_limb_1, std::max(binary_basis_limbs[1].maximum_value, other.binary_basis_limbs[1].maximum_value));
1682 result.binary_basis_limbs[2] =
1683 Limb(binary_limb_2, std::max(binary_basis_limbs[2].maximum_value, other.binary_basis_limbs[2].maximum_value));
1684 result.binary_basis_limbs[3] =
1685 Limb(binary_limb_3, std::max(binary_basis_limbs[3].maximum_value, other.binary_basis_limbs[3].maximum_value));
1686 result.prime_basis_limb = prime_limb;
1687 result.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag(), predicate.tag));
1688 return result;
1689}
1690
1711template <typename Builder, typename T> bool_t<Builder> bigfield<Builder, T>::operator==(const bigfield& other) const
1712{
1713 Builder* ctx = context ? context : other.get_context();
1714 auto lhs = get_value() % modulus_u512;
1715 auto rhs = other.get_value() % modulus_u512;
1716 bool is_equal_raw = (lhs == rhs);
1717 if (is_constant() && other.is_constant()) {
1718 return is_equal_raw;
1719 }
1720
1721 // The context should not be null at this point.
1722 BB_ASSERT(ctx != NULL);
1723 bool_t<Builder> is_equal = witness_t<Builder>(ctx, is_equal_raw);
1724
1725 // We need to manually propagate the origin tag
1726 is_equal.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
1727
1728 bigfield diff = (*this) - other;
1729 native diff_native = native((diff.get_value() % modulus_u512).lo);
1730 native inverse_native = is_equal_raw ? 0 : diff_native.invert();
1731
1732 bigfield inverse = bigfield::from_witness(ctx, inverse_native);
1733
1734 // We need to manually propagate the origin tag
1735 inverse.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
1736
1737 bigfield multiplicand = bigfield::conditional_assign(is_equal, one(), inverse);
1738
1739 bigfield product = diff * multiplicand;
1740
1742
1743 product.prime_basis_limb.assert_equal(result);
1744 product.binary_basis_limbs[0].element.assert_equal(result);
1745 product.binary_basis_limbs[1].element.assert_equal(0);
1746 product.binary_basis_limbs[2].element.assert_equal(0);
1747 product.binary_basis_limbs[3].element.assert_equal(0);
1748 is_equal.set_origin_tag(OriginTag(get_origin_tag(), other.get_origin_tag()));
1749 return is_equal;
1750}
1751
1752template <typename Builder, typename T> void bigfield<Builder, T>::reduction_check() const
1753{
1754 if (is_constant()) {
1755 uint256_t reduced_value = (get_value() % modulus_u512).lo;
1756 bigfield reduced(context, uint256_t(reduced_value));
1757 // Save tags
1758 const auto origin_tags = std::vector({ binary_basis_limbs[0].element.get_origin_tag(),
1759 binary_basis_limbs[1].element.get_origin_tag(),
1760 binary_basis_limbs[2].element.get_origin_tag(),
1761 binary_basis_limbs[3].element.get_origin_tag(),
1762 prime_basis_limb.get_origin_tag() });
1763
1764 // Directly assign to mutable members (avoiding assignment operator)
1765 binary_basis_limbs[0] = reduced.binary_basis_limbs[0];
1766 binary_basis_limbs[1] = reduced.binary_basis_limbs[1];
1767 binary_basis_limbs[2] = reduced.binary_basis_limbs[2];
1768 binary_basis_limbs[3] = reduced.binary_basis_limbs[3];
1769 prime_basis_limb = reduced.prime_basis_limb;
1770
1771 // Preserve origin tags (useful in simulator)
1772 binary_basis_limbs[0].element.set_origin_tag(origin_tags[0]);
1773 binary_basis_limbs[1].element.set_origin_tag(origin_tags[1]);
1774 binary_basis_limbs[2].element.set_origin_tag(origin_tags[2]);
1775 binary_basis_limbs[3].element.set_origin_tag(origin_tags[3]);
1776 prime_basis_limb.set_origin_tag(origin_tags[4]);
1777 return;
1778 }
1779
1780 uint256_t maximum_unreduced_limb_value = get_maximum_unreduced_limb_value();
1781 bool limb_overflow_test_0 = binary_basis_limbs[0].maximum_value > maximum_unreduced_limb_value;
1782 bool limb_overflow_test_1 = binary_basis_limbs[1].maximum_value > maximum_unreduced_limb_value;
1783 bool limb_overflow_test_2 = binary_basis_limbs[2].maximum_value > maximum_unreduced_limb_value;
1784 bool limb_overflow_test_3 = binary_basis_limbs[3].maximum_value > maximum_unreduced_limb_value;
1785 if (get_maximum_value() > get_maximum_unreduced_value() || limb_overflow_test_0 || limb_overflow_test_1 ||
1786 limb_overflow_test_2 || limb_overflow_test_3) {
1787 self_reduce();
1788 }
1789}
1790
1791template <typename Builder, typename T> void bigfield<Builder, T>::sanity_check() const
1792{
1793
1794 uint256_t prohibited_limb_value = get_prohibited_limb_value();
1795 bool limb_overflow_test_0 = binary_basis_limbs[0].maximum_value > prohibited_limb_value;
1796 bool limb_overflow_test_1 = binary_basis_limbs[1].maximum_value > prohibited_limb_value;
1797 bool limb_overflow_test_2 = binary_basis_limbs[2].maximum_value > prohibited_limb_value;
1798 bool limb_overflow_test_3 = binary_basis_limbs[3].maximum_value > prohibited_limb_value;
1799 // max_val < sqrt(2^T * n)
1800 // Note this is a static assertion, so it is not checked at runtime
1801 BB_ASSERT(!(get_maximum_value() > get_prohibited_value() || limb_overflow_test_0 || limb_overflow_test_1 ||
1802 limb_overflow_test_2 || limb_overflow_test_3));
1803}
1804
1805template <typename Builder, typename T>
1806void bigfield<Builder, T>::assert_zero_if(const bool_t<Builder>& predicate, std::string const& msg) const
1807{
1808 // Assert that all limbs are zero when predicate is true
1809 const field_ct predicate_field = field_ct(predicate);
1810 (binary_basis_limbs[0].element * predicate_field).assert_is_zero(msg + ": binary limb 0 not zero");
1811 (binary_basis_limbs[1].element * predicate_field).assert_is_zero(msg + ": binary limb 1 not zero");
1812 (binary_basis_limbs[2].element * predicate_field).assert_is_zero(msg + ": binary limb 2 not zero");
1813 (binary_basis_limbs[3].element * predicate_field).assert_is_zero(msg + ": binary limb 3 not zero");
1814 (prime_basis_limb * predicate_field).assert_is_zero(msg + ": prime limb not zero");
1815}
1816
1817// Underneath performs unsafe_assert_less_than(modulus)
1818// create a version with mod 2^t element part in [0,p-1]
1819// After range-constraining to size 2^s, we check (p-1)-a is non-negative as integer.
1820// We perform subtraction using carries on blocks of size 2^b. The operations inside the blocks are done mod r
1821// Including the effect of carries the operation inside each limb is in the range [-2^b-1,2^{b+1}]
1822// Assuming this values are all distinct mod r, which happens e.g. if r/2>2^{b+1}, then if all limb values are
1823// non-negative at the end of subtraction, we know the subtraction result is positive as integers and a<p
1824template <typename Builder, typename T> void bigfield<Builder, T>::assert_is_in_field(std::string const& msg) const
1825{
1826 assert_less_than(modulus, msg == "bigfield::assert_is_in_field" ? "bigfield::assert_less_than" : msg);
1827}
1828
1829// Asserts that the element is < upper_limit. We first range constrain the limbs and then calls
1830// unsafe_assert_less_than(upper_limit).
1831template <typename Builder, typename T>
1832void bigfield<Builder, T>::assert_less_than(const uint256_t& upper_limit, std::string const& msg) const
1833{
1834 // For constant bigfields, just verify the value is in range (no circuit constraints needed)
1835 if (is_constant()) {
1836 BB_ASSERT((get_value() % modulus_u512).lo < upper_limit, msg);
1837 return;
1838 }
1839
1840 bool is_default_msg = msg == "bigfield::assert_less_than";
1841
1842 // Range constrain the binary basis limbs of the element to respective limb sizes.
1843 // This is required because the comparison is done using subtractions, which can result in overflows.
1844 // Range constrain the first two limbs each to NUM_LIMB_BITS
1845 auto ctx = get_context();
1846 ctx->range_constrain_two_limbs(binary_basis_limbs[0].element.get_witness_index(),
1847 binary_basis_limbs[1].element.get_witness_index(),
1848 static_cast<size_t>(NUM_LIMB_BITS),
1849 static_cast<size_t>(NUM_LIMB_BITS),
1850 is_default_msg ? "bigfield::assert_less_than: limb 0 or 1 too large" : msg);
1851
1852 // Range constrain the last two limbs to NUM_LIMB_BITS and NUM_LAST_LIMB_BITS
1853 ctx->range_constrain_two_limbs(binary_basis_limbs[2].element.get_witness_index(),
1854 binary_basis_limbs[3].element.get_witness_index(),
1855 static_cast<size_t>(NUM_LIMB_BITS),
1856 static_cast<size_t>(NUM_LAST_LIMB_BITS),
1857 is_default_msg ? "bigfield::assert_less_than: limb 2 or 3 too large" : msg);
1858
1859 // Now we can check that the element is < upper_limit.
1860 unsafe_assert_less_than(upper_limit, is_default_msg ? "bigfield::unsafe_assert_less_than" : msg);
1861}
1862
1863// Return (a < b) as bool circuit type.
1864template <typename Builder, typename T>
1865bool_t<Builder> bigfield<Builder, T>::is_less_than(const uint256_t& upper_limit, std::string const& msg) const
1866{
1867 bool is_default_msg = msg == "bigfield::is_less_than";
1868
1869 Builder* ctx = get_context();
1870
1871 // Range constraint the limbs, this is required by the ranged_less_than function
1872 ctx->range_constrain_two_limbs(binary_basis_limbs[0].element.get_witness_index(),
1873 binary_basis_limbs[1].element.get_witness_index(),
1874 static_cast<size_t>(NUM_LIMB_BITS),
1875 static_cast<size_t>(NUM_LIMB_BITS),
1876 is_default_msg ? "bigfield::is_less_than: limb 0 or 1 too large" : msg);
1877
1878 ctx->range_constrain_two_limbs(binary_basis_limbs[2].element.get_witness_index(),
1879 binary_basis_limbs[3].element.get_witness_index(),
1880 static_cast<size_t>(NUM_LIMB_BITS),
1881 static_cast<size_t>(NUM_LAST_LIMB_BITS),
1882 is_default_msg ? "bigfield::is_less_than: limb 2 or 3 too large" : msg);
1883
1884 const uint256_t upper_limit_value_0 = upper_limit.slice(0, NUM_LIMB_BITS);
1885 const uint256_t upper_limit_value_1 = upper_limit.slice(NUM_LIMB_BITS, NUM_LIMB_BITS * 2);
1886 const uint256_t upper_limit_value_2 = upper_limit.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 3);
1887 const uint256_t upper_limit_value_3 =
1888 upper_limit.slice(NUM_LIMB_BITS * 3, (NUM_LIMB_BITS * 3) + NUM_LAST_LIMB_BITS);
1889
1890 bool_t<Builder> third_limb_is_smaller = binary_basis_limbs[3].element.template ranged_less_than<NUM_LAST_LIMB_BITS>(
1891 field_t<Builder>(upper_limit_value_3));
1892 bool_t<Builder> third_limb_is_equal = binary_basis_limbs[3].element == field_t<Builder>(upper_limit_value_3);
1893
1894 bool_t<Builder> second_limb_is_smaller =
1895 binary_basis_limbs[2].element.template ranged_less_than<NUM_LIMB_BITS>(field_t<Builder>(upper_limit_value_2));
1896 bool_t<Builder> second_limb_is_equal = binary_basis_limbs[2].element == field_t<Builder>(upper_limit_value_2);
1897
1898 bool_t<Builder> first_limb_is_smaller =
1899 binary_basis_limbs[1].element.template ranged_less_than<NUM_LIMB_BITS>(field_t<Builder>(upper_limit_value_1));
1900 bool_t<Builder> first_limb_is_equal = binary_basis_limbs[1].element == field_t<Builder>(upper_limit_value_1);
1901
1902 bool_t<Builder> zeroth_limb_is_smaller =
1903 binary_basis_limbs[0].element.template ranged_less_than<NUM_LIMB_BITS>(field_t<Builder>(upper_limit_value_0));
1904
1905 // Limb comparison: we start from the most-significant limb and proceed to the least-significant limb
1906 bool_t<Builder> result =
1907 third_limb_is_smaller || (third_limb_is_equal && second_limb_is_smaller) ||
1908 (third_limb_is_equal && second_limb_is_equal && first_limb_is_smaller) ||
1909 (third_limb_is_equal && second_limb_is_equal && first_limb_is_equal && zeroth_limb_is_smaller);
1910
1911 return result;
1912}
1913
1914// Reduces the element mod p. This is a strict reduction mod p, so the output is guaranteed to be < p.
1915template <typename Builder, typename T> void bigfield<Builder, T>::reduce_mod_target_modulus() const
1916{
1917 // First we lazy-reduce the element mod p, and constrain the output/remainder to be < 2^s where s = ceil(log2(p)).
1918 // This brings the element into the range [0, 2^s) such that the limbs of the reduced element are all range
1919 // constrained to < 2^b (last limb < 2^(s - 3b)).
1920 self_reduce();
1921
1922 // Then we constrain the element to be < target modulus using strict comparison.
1923 unsafe_assert_less_than(modulus);
1924}
1925
1926// Asserts that the element is < upper_limit. We mark this as unsafe because it assumes that the element is already
1927// range constrained to < 2^s where s = ceil(log2(p)).
1928template <typename Builder, typename T>
1929void bigfield<Builder, T>::unsafe_assert_less_than(const uint256_t& upper_limit, std::string const& msg) const
1930{
1931 // Warning: this assumes we have run circuit construction at least once in debug mode where large non reduced
1932 // constants are NOT allowed via ASSERT
1933 if (is_constant()) {
1934 BB_ASSERT_LT(get_value(), static_cast<uint512_t>(upper_limit));
1935 return;
1936 }
1937
1938 BB_ASSERT(upper_limit != 0);
1939 // The circuit checks that limit - this >= 0, so if we are doing a less_than comparison, we need to subtract 1
1940 // from the limit
1941 uint256_t strict_upper_limit = upper_limit - uint256_t(1);
1942 uint256_t value = get_value().lo;
1943
1944 const uint256_t upper_limit_value_0 = strict_upper_limit.slice(0, NUM_LIMB_BITS);
1945 const uint256_t upper_limit_value_1 = strict_upper_limit.slice(NUM_LIMB_BITS, NUM_LIMB_BITS * 2);
1946 const uint256_t upper_limit_value_2 = strict_upper_limit.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 3);
1947 const uint256_t upper_limit_value_3 = strict_upper_limit.slice(NUM_LIMB_BITS * 3, NUM_LIMB_BITS * 4);
1948
1949 const uint256_t val_0 = value.slice(0, NUM_LIMB_BITS);
1950 const uint256_t val_1 = value.slice(NUM_LIMB_BITS, NUM_LIMB_BITS * 2);
1951 const uint256_t val_2 = value.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 3);
1952
1953 bool borrow_0_value = val_0 > upper_limit_value_0;
1954 bool borrow_1_value = (val_1 + uint256_t(borrow_0_value)) > (upper_limit_value_1);
1955 bool borrow_2_value = (val_2 + uint256_t(borrow_1_value)) > (upper_limit_value_2);
1956
1957 field_t<Builder> upper_limit_0(context, upper_limit_value_0);
1958 field_t<Builder> upper_limit_1(context, upper_limit_value_1);
1959 field_t<Builder> upper_limit_2(context, upper_limit_value_2);
1960 field_t<Builder> upper_limit_3(context, upper_limit_value_3);
1961 bool_t<Builder> borrow_0(witness_t<Builder>(context, borrow_0_value));
1962 bool_t<Builder> borrow_1(witness_t<Builder>(context, borrow_1_value));
1963 bool_t<Builder> borrow_2(witness_t<Builder>(context, borrow_2_value));
1964 // Unset free witness tag because these are auxiliary witnesses
1965 borrow_0.unset_free_witness_tag();
1966 borrow_1.unset_free_witness_tag();
1967 borrow_2.unset_free_witness_tag();
1968
1969 // The way we use borrows here ensures that we are checking that upper_limit - binary_basis > 0.
1970 // We check that the result in each limb is > 0.
1971 // If the modulus part in this limb is smaller, we simply borrow the value from the higher limb.
1972 // The prover can rearrange the borrows the way they like. The important thing is that the borrows are
1973 // constrained.
1974 field_t<Builder> r0 =
1975 upper_limit_0 - binary_basis_limbs[0].element + (static_cast<field_t<Builder>>(borrow_0) * shift_1);
1976 field_t<Builder> r1 = upper_limit_1 - binary_basis_limbs[1].element +
1977 (static_cast<field_t<Builder>>(borrow_1) * shift_1) - static_cast<field_t<Builder>>(borrow_0);
1978 field_t<Builder> r2 = upper_limit_2 - binary_basis_limbs[2].element +
1979 (static_cast<field_t<Builder>>(borrow_2) * shift_1) - static_cast<field_t<Builder>>(borrow_1);
1980 field_t<Builder> r3 = upper_limit_3 - binary_basis_limbs[3].element - static_cast<field_t<Builder>>(borrow_2);
1981
1982 // We need to range constrain the r0,r1,r2,r3 values to ensure they are "small enough".
1983 get_context()->range_constrain_two_limbs(
1984 r0.get_witness_index(),
1985 r1.get_witness_index(),
1986 static_cast<size_t>(NUM_LIMB_BITS),
1987 static_cast<size_t>(NUM_LIMB_BITS),
1988 msg == "bigfield::unsafe_assert_less_than" ? "bigfield::unsafe_assert_less_than: r0 or r1 too large" : msg);
1989 get_context()->range_constrain_two_limbs(
1990 r2.get_witness_index(),
1991 r3.get_witness_index(),
1992 static_cast<size_t>(NUM_LIMB_BITS),
1993 static_cast<size_t>(NUM_LAST_LIMB_BITS),
1994 msg == "bigfield::unsafe_assert_less_than" ? "bigfield::unsafe_assert_less_than: r2 or r3 too large" : msg);
1995}
1996
1997// check elements are equal mod p by proving their integer difference is a multiple of p.
1998// This relies on the minus operator for a-b increasing a by a multiple of p large enough so diff is non-negative
1999// When one of the elements is a constant and another is a witness we check equality of limbs, so if the witness
2000// bigfield element is in an unreduced form, it needs to be reduced first. We don't have automatic reduced form
2001// detection for now, so it is up to the circuit writer to detect this
2002template <typename Builder, typename T>
2003void bigfield<Builder, T>::assert_equal(const bigfield& other, std::string const& msg) const
2004{
2005 Builder* ctx = this->context ? this->context : other.context;
2006 if (is_constant() && other.is_constant()) {
2007 std::cerr << "bigfield: calling assert equal on 2 CONSTANT bigfield elements...is this intended?" << std::endl;
2008 BB_ASSERT_EQ(get_value(), other.get_value(), "We expect constants to be less than the target modulus");
2009 return;
2010 } else if (other.is_constant()) {
2011 // NOTE(https://github.com/AztecProtocol/barretenberg/issues/998): This does a limb-wise integer
2012 // comparison, so `this` must already be in reduced form (value in [0, p)) before calling this method.
2013 // If `this = kp + r` and `other = r`, the limbs differ and an honest prover cannot satisfy the
2014 // constraints. Callers are responsible for calling self_reduce() first when necessary; we omit it
2015 // here to avoid adding spurious gates in the common case where `this` is already reduced.
2016 // `other` should never exceed the modulus by design; we assert this as a precaution.
2017 BB_ASSERT_LT(get_value(),
2018 modulus_u512,
2019 "bigfield::assert_equal: 'this' is not reduced (value >= p). Call self_reduce() before comparing "
2020 "against a constant.");
2021 BB_ASSERT_LT(other.get_value(), modulus_u512);
2022 field_t<Builder> t0 = (binary_basis_limbs[0].element - other.binary_basis_limbs[0].element);
2023 field_t<Builder> t1 = (binary_basis_limbs[1].element - other.binary_basis_limbs[1].element);
2024 field_t<Builder> t2 = (binary_basis_limbs[2].element - other.binary_basis_limbs[2].element);
2025 field_t<Builder> t3 = (binary_basis_limbs[3].element - other.binary_basis_limbs[3].element);
2026 field_t<Builder> t4 = (prime_basis_limb - other.prime_basis_limb);
2027 t0.assert_is_zero();
2028 t1.assert_is_zero();
2029 t2.assert_is_zero();
2030 t3.assert_is_zero();
2031 t4.assert_is_zero();
2032 return;
2033 } else if (is_constant()) {
2034 other.assert_equal(*this, msg);
2035 return;
2036 } else {
2037 // Catch the error if the reduced value of the two elements are not equal
2038 uint512_t lhs_reduced_value = get_value() % modulus_u512;
2039 uint512_t rhs_reduced_value = other.get_value() % modulus_u512;
2040 if ((lhs_reduced_value != rhs_reduced_value) && !get_context()->failed()) {
2041 get_context()->failure(msg);
2042 }
2043
2044 // Remove tags, we don't want to cause violations on assert_equal
2045 const auto original_tag = get_origin_tag();
2046 const auto other_original_tag = other.get_origin_tag();
2047 auto empty_tag = OriginTag::constant(); // Disable origin checking during intermediate operations
2048 set_origin_tag(empty_tag);
2049 other.set_origin_tag(empty_tag);
2050
2051 bigfield diff = *this - other;
2052 const uint512_t diff_val = diff.get_value();
2053 const uint512_t modulus(target_basis.modulus);
2054
2055 const auto [quotient_512, remainder_512] = (diff_val).divmod(modulus);
2056 if (remainder_512 != 0) {
2057 std::cerr << "bigfield: remainder not zero!" << std::endl;
2058 }
2059 bigfield quotient;
2060
2061 const size_t num_quotient_bits = get_quotient_max_bits({ 0 });
2062 quotient = bigfield(witness_t(ctx, fr(quotient_512.slice(0, NUM_LIMB_BITS * 2).lo)),
2063 witness_t(ctx, fr(quotient_512.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 4).lo)),
2064 false,
2065 num_quotient_bits);
2066 unsafe_evaluate_multiply_add(diff, { one() }, {}, quotient, { zero() });
2067
2068 // Restore tags
2069 set_origin_tag(original_tag);
2070 other.set_origin_tag(other_original_tag);
2071 }
2072}
2073
2074// construct a proof that points are different mod p, when they are different mod r
2075// WARNING: This method doesn't have perfect completeness - for points equal mod r (or with certain difference kp
2076// mod r) but different mod p, you can't construct a proof. The failure probability is at most
2077// (L + R + 1) / r where L = floor(a.max / p), R = floor(b.max / p), r = native field size (~2^254).
2078// With max bounded by 2^256 - 1 and p >= 2^249, we get L,R <= 127, so probability < 2^{-246}.
2079// Note also that the number of constraints depends on how
2080// much the values have overflown beyond p e.g. due to an addition chain The function is based on the following.
2081// Suppose a-b = 0 mod p. Then a-b = k*p for k in a range [-R,L] for largest L and R such that L*p>= a, R*p>=b.
2082// And also a-b = k*p mod r for such k. Thus we can verify a-b is non-zero mod p by taking the product of such values
2083// (a-b-kp) and showing it's non-zero mod r
2084template <typename Builder, typename T>
2085void bigfield<Builder, T>::assert_is_not_equal(const bigfield& other, std::string const& msg) const
2086{
2087 // Why would we use this for 2 constants? Turns out, in biggroup
2088 const auto get_overload_count = [target_modulus = modulus_u512](const uint512_t& maximum_value) {
2089 uint512_t target = target_modulus;
2090 size_t overload_count = 0;
2091 while (target <= maximum_value) {
2092 ++overload_count;
2093 target += target_modulus;
2094 }
2095 return overload_count;
2096 };
2097 const size_t lhs_overload_count = get_overload_count(get_maximum_value());
2098 const size_t rhs_overload_count = get_overload_count(other.get_maximum_value());
2099
2100 // if (a == b) then (a == b mod n)
2101 // to save gates, we only check that (a == b mod n)
2102
2103 // if numeric val of a = a' + p.q
2104 // we want to check (a' + p.q == b mod n)
2105 const field_t<Builder> base_diff = prime_basis_limb - other.prime_basis_limb;
2106 auto diff = base_diff;
2107 field_t<Builder> prime_basis(get_context(), modulus);
2108 field_t<Builder> prime_basis_accumulator = prime_basis;
2109 // Each loop iteration adds 1 gate
2110 // (prime_basis and prime_basis accumulator are constant so only the * operator adds a gate)
2111 for (size_t i = 0; i < lhs_overload_count; ++i) {
2112 diff = diff * (base_diff - prime_basis_accumulator);
2113 prime_basis_accumulator += prime_basis;
2114 }
2115 prime_basis_accumulator = prime_basis;
2116 for (size_t i = 0; i < rhs_overload_count; ++i) {
2117 diff = diff * (base_diff + prime_basis_accumulator);
2118 prime_basis_accumulator += prime_basis;
2119 }
2120 diff.assert_is_not_zero(msg);
2121}
2122
2123// We reduce an element's mod 2^t representation (t=4*NUM_LIMB_BITS) to size 2^s for smallest s with 2^s>p
2124// This is much cheaper than actually reducing mod p and suffices for addition chains (where we just need not to
2125// overflow 2^t) We also reduce any "spillage" inside the first 3 limbs, so that their range is NUM_LIMB_BITS and
2126// not larger
2127template <typename Builder, typename T> void bigfield<Builder, T>::self_reduce() const
2128{
2129 // Warning: this assumes we have run circuit construction at least once in debug mode where large non reduced
2130 // constants are disallowed via ASSERT
2131 if (is_constant()) {
2132 return;
2133 }
2134 OriginTag new_tag = get_origin_tag();
2135 const auto [quotient_value, remainder_value] = get_value().divmod(target_basis.modulus);
2136
2137 bigfield quotient(context);
2138
2139 uint512_t maximum_quotient_size = get_maximum_value() / target_basis.modulus;
2140 uint64_t maximum_quotient_bits = maximum_quotient_size.get_msb() + 1;
2141 if ((maximum_quotient_bits & 1ULL) == 1ULL) {
2142 ++maximum_quotient_bits;
2143 }
2144
2145 BB_ASSERT_LTE(maximum_quotient_bits, NUM_LIMB_BITS);
2146 uint32_t quotient_limb_index = context->add_variable(bb::fr(quotient_value.lo));
2147 field_t<Builder> quotient_limb = field_t<Builder>::from_witness_index(context, quotient_limb_index);
2148 context->create_limbed_range_constraint(quotient_limb.get_witness_index(),
2149 static_cast<size_t>(maximum_quotient_bits));
2150
2151 BB_ASSERT_LT((uint1024_t(1) << maximum_quotient_bits) * uint1024_t(modulus_u512) + DEFAULT_MAXIMUM_REMAINDER,
2152 get_maximum_crt_product());
2153 quotient.binary_basis_limbs[0] = Limb(quotient_limb, (uint256_t(1) << maximum_quotient_bits) - 1);
2157 quotient.prime_basis_limb = quotient_limb;
2158 // this constructor with can_overflow=false will enforce remainder of size<2^s
2159 bigfield remainder = bigfield(
2160 witness_t(context, fr(remainder_value.slice(0, NUM_LIMB_BITS * 2).lo)),
2161 witness_t(context, fr(remainder_value.slice(NUM_LIMB_BITS * 2, NUM_LIMB_BITS * 3 + NUM_LAST_LIMB_BITS).lo)));
2162
2163 unsafe_evaluate_multiply_add(*this, one(), {}, quotient, { remainder });
2164 binary_basis_limbs[0] =
2165 remainder.binary_basis_limbs[0]; // Combination of const method and mutable variables is good practice?
2166 binary_basis_limbs[1] = remainder.binary_basis_limbs[1];
2167 binary_basis_limbs[2] = remainder.binary_basis_limbs[2];
2168 binary_basis_limbs[3] = remainder.binary_basis_limbs[3];
2169 prime_basis_limb = remainder.prime_basis_limb;
2170 set_origin_tag(new_tag);
2171} // namespace stdlib
2172
2173template <typename Builder, typename T>
2175 const bigfield& input_to_mul,
2176 const std::vector<bigfield>& to_add,
2177 const bigfield& input_quotient,
2178 const std::vector<bigfield>& input_remainders)
2179{
2180
2181 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
2182 BB_ASSERT_LTE(input_remainders.size(), MAXIMUM_SUMMAND_COUNT);
2183 // Sanity checks
2184 input_left.sanity_check();
2185 input_to_mul.sanity_check();
2186 input_quotient.sanity_check();
2187 for (auto& el : to_add) {
2188 el.sanity_check();
2189 }
2190 for (auto& el : input_remainders) {
2191 el.sanity_check();
2192 }
2193
2194 std::vector<bigfield> remainders(input_remainders);
2195
2196 bigfield left = input_left;
2197 bigfield to_mul = input_to_mul;
2198 bigfield quotient = input_quotient;
2199
2200 // Either of the multiplicand must be a witness.
2201 BB_ASSERT(!left.is_constant() || !to_mul.is_constant());
2202 Builder* ctx = left.context ? left.context : to_mul.context;
2203
2204 // Compute the maximum value of the product of the two inputs: max(a * b)
2205 uint512_t max_ab_lo(0);
2206 uint512_t max_ab_hi(0);
2207 std::tie(max_ab_lo, max_ab_hi) = compute_partial_schoolbook_multiplication(left.get_binary_basis_limb_maximums(),
2209
2210 // Compute the maximum value of the product of the quotient and neg_modulus: max(q * p')
2211 uint512_t max_q_neg_p_lo(0);
2212 uint512_t max_q_neg_p_hi(0);
2213 std::tie(max_q_neg_p_lo, max_q_neg_p_hi) = compute_partial_schoolbook_multiplication(
2214 neg_modulus_mod_binary_basis_limbs_u256, quotient.get_binary_basis_limb_maximums());
2215
2216 // Compute the maximum value that needs to be borrowed from the hi limbs to the lo limb.
2217 // Check the README for the explanation of the borrow.
2218 uint256_t max_remainders_lo(0);
2219 for (const auto& remainder : input_remainders) {
2220 max_remainders_lo += remainder.binary_basis_limbs[0].maximum_value +
2221 (remainder.binary_basis_limbs[1].maximum_value << NUM_LIMB_BITS);
2222 }
2223
2224 // While performing the subtraction of remainder r as:
2225 //
2226 // (a * b + q * p') - (r)
2227 //
2228 // we want to ensure that the lower limbs do not underflow. So we add a borrow value
2229 // to the lower limbs and subtract it from the higher limbs. Naturally, such a borrow value
2230 // must be a multiple of 2^2L (where L = NUM_LIMB_BITS). Let borrow_lo_value be the value
2231 // borrowed from the hi limbs, then we must have:
2232 //
2233 // borrow_lo_value * 2^(2L) >= max_remainders_lo
2234 //
2235 // Thus, we can compute the minimum borrow_lo_value as:
2236 //
2237 // borrow_lo_value = ⌈ max_remainders_lo / 2^(2L) ⌉
2238 //
2239 uint256_t borrow_lo_value =
2240 (max_remainders_lo + ((uint256_t(1) << (2 * NUM_LIMB_BITS)) - 1)) >> (2 * NUM_LIMB_BITS);
2241 field_t<Builder> borrow_lo(ctx, bb::fr(borrow_lo_value));
2242
2243 uint512_t max_a0(0);
2244 uint512_t max_a1(0);
2245 for (size_t i = 0; i < to_add.size(); ++i) {
2246 max_a0 += to_add[i].binary_basis_limbs[0].maximum_value +
2247 (to_add[i].binary_basis_limbs[1].maximum_value << NUM_LIMB_BITS);
2248 max_a1 += to_add[i].binary_basis_limbs[2].maximum_value +
2249 (to_add[i].binary_basis_limbs[3].maximum_value << NUM_LIMB_BITS);
2250 }
2251 const uint512_t max_lo = max_ab_lo + max_q_neg_p_lo + max_remainders_lo + max_a0;
2252 const uint512_t max_lo_carry = max_lo >> (2 * NUM_LIMB_BITS);
2253 const uint512_t max_hi = max_ab_hi + max_q_neg_p_hi + max_a1 + max_lo_carry;
2254
2255 uint64_t max_lo_bits = (max_lo.get_msb() + 1);
2256 uint64_t max_hi_bits = max_hi.get_msb() + 1;
2257
2258 BB_ASSERT(max_lo_bits > (2 * NUM_LIMB_BITS));
2259 BB_ASSERT(max_hi_bits > (2 * NUM_LIMB_BITS));
2260
2261 uint64_t carry_lo_msb = max_lo_bits - (2 * NUM_LIMB_BITS);
2262 uint64_t carry_hi_msb = max_hi_bits - (2 * NUM_LIMB_BITS);
2263
2264 // The custom bigfield multiplication gate requires inputs are witnesses.
2265 // If we're using constant values, instantiate them as circuit variables
2266 //
2267 // Explanation:
2268 // The bigfield multiplication gate expects witnesses and disallows circuit constants
2269 // because allowing circuit constants would lead to complex circuit logic to support
2270 // different combinations of constant and witness inputs. Particularly, bigfield multiplication
2271 // gate enforces constraints of the form: a * b - q * p + r = 0, where:
2272 //
2273 // input left a = (a3 || a2 || a1 || a0)
2274 // input right b = (b3 || b2 || b1 || b0)
2275 // quotient q = (q3 || q2 || q1 || q0)
2276 // remainder r = (r3 || r2 || r1 || r0)
2277 //
2278 // | a1 | b1 | r0 | lo_0 | <-- product gate 1: check lo_0
2279 // | a0 | b0 | a3 | b3 |
2280 // | a2 | b2 | r3 | hi_0 |
2281 // | a1 | b1 | r2 | hi_1 |
2282 //
2283 // Example constaint: lo_0 = (a1 * b0 + a0 * b1) * 2^b + (a0 * b0) - r0
2284 // ==> w4 = (w1 * w'2 + w'1 * w2) * 2^b + (w'1 * w'2) - w3
2285 //
2286 // If a, b both are witnesses, this special gate performs 3 field multiplications per gate.
2287 // If b was a constant, then we would need to no field multiplications, but instead update the
2288 // the limbs of a with multiplicative and additive constants. This just makes the circuit logic
2289 // more complex, so we disallow constants. If there are constants, we convert them to fixed witnesses (at the
2290 // expense of 1 extra gate per constant).
2291 //
2292 const auto convert_constant_to_fixed_witness = [ctx](const bigfield& input) {
2293 bigfield output(input);
2294 // Save the original tag before converting to witnesses
2295 auto original_tag = input.get_origin_tag();
2296 output.prime_basis_limb =
2297 field_t<Builder>::from_witness_index(ctx, ctx->put_constant_variable(input.prime_basis_limb.get_value()));
2299 ctx, ctx->put_constant_variable(input.binary_basis_limbs[0].element.get_value()));
2301 ctx, ctx->put_constant_variable(input.binary_basis_limbs[1].element.get_value()));
2303 ctx, ctx->put_constant_variable(input.binary_basis_limbs[2].element.get_value()));
2305 ctx, ctx->put_constant_variable(input.binary_basis_limbs[3].element.get_value()));
2306 output.context = ctx;
2307 // Restore the original tag after converting to witnesses
2308 output.set_origin_tag(original_tag);
2309 return output;
2310 };
2311 if (left.is_constant()) {
2312 left = convert_constant_to_fixed_witness(left);
2313 }
2314 if (to_mul.is_constant()) {
2315 to_mul = convert_constant_to_fixed_witness(to_mul);
2316 }
2317 if (quotient.is_constant()) {
2318 quotient = convert_constant_to_fixed_witness(quotient);
2319 }
2320 if (remainders[0].is_constant()) {
2321 remainders[0] = convert_constant_to_fixed_witness(remainders[0]);
2322 }
2323
2324 std::vector<field_t<Builder>> limb_0_accumulator{ remainders[0].binary_basis_limbs[0].element };
2325 std::vector<field_t<Builder>> limb_2_accumulator{ remainders[0].binary_basis_limbs[2].element };
2326 std::vector<field_t<Builder>> prime_limb_accumulator{ remainders[0].prime_basis_limb };
2327 for (size_t i = 1; i < remainders.size(); ++i) {
2328 limb_0_accumulator.emplace_back(remainders[i].binary_basis_limbs[0].element);
2329 limb_0_accumulator.emplace_back(remainders[i].binary_basis_limbs[1].element * shift_1);
2330 limb_2_accumulator.emplace_back(remainders[i].binary_basis_limbs[2].element);
2331 limb_2_accumulator.emplace_back(remainders[i].binary_basis_limbs[3].element * shift_1);
2332 prime_limb_accumulator.emplace_back(remainders[i].prime_basis_limb);
2333 }
2334 for (const auto& add : to_add) {
2335 limb_0_accumulator.emplace_back(-add.binary_basis_limbs[0].element);
2336 limb_0_accumulator.emplace_back(-add.binary_basis_limbs[1].element * shift_1);
2337 limb_2_accumulator.emplace_back(-add.binary_basis_limbs[2].element);
2338 limb_2_accumulator.emplace_back(-add.binary_basis_limbs[3].element * shift_1);
2339 prime_limb_accumulator.emplace_back(-add.prime_basis_limb);
2340 }
2341
2342 const auto& t0 = remainders[0].binary_basis_limbs[1].element;
2343 const auto& t1 = remainders[0].binary_basis_limbs[3].element;
2344 bool needs_normalize = (t0.additive_constant != 0 || t0.multiplicative_constant != 1);
2345 needs_normalize = needs_normalize || (t1.additive_constant != 0 || t1.multiplicative_constant != 1);
2346
2347 if (needs_normalize) {
2348 limb_0_accumulator.emplace_back(remainders[0].binary_basis_limbs[1].element * shift_1);
2349 limb_2_accumulator.emplace_back(remainders[0].binary_basis_limbs[3].element * shift_1);
2350 }
2351
2352 std::array<field_t<Builder>, NUM_LIMBS> remainder_limbs{
2353 field_t<Builder>::accumulate(limb_0_accumulator),
2354 needs_normalize ? field_t<Builder>::from_witness_index(ctx, ctx->zero_idx())
2355 : remainders[0].binary_basis_limbs[1].element,
2356 field_t<Builder>::accumulate(limb_2_accumulator),
2357 needs_normalize ? field_t<Builder>::from_witness_index(ctx, ctx->zero_idx())
2358 : remainders[0].binary_basis_limbs[3].element,
2359 };
2360 field_t<Builder> remainder_prime_limb = field_t<Builder>::accumulate(prime_limb_accumulator);
2361
2366 {
2367 remainder_limbs[0].get_witness_index(),
2368 remainder_limbs[1].get_witness_index(),
2369 remainder_limbs[2].get_witness_index(),
2370 remainder_limbs[3].get_witness_index(),
2371 },
2372 { neg_modulus_mod_binary_basis_limbs[0],
2373 neg_modulus_mod_binary_basis_limbs[1],
2374 neg_modulus_mod_binary_basis_limbs[2],
2375 neg_modulus_mod_binary_basis_limbs[3] },
2376 };
2377
2378 // N.B. this method DOES NOT evaluate the prime field component of the non-native field mul
2379 const auto [lo_idx, hi_idx] = ctx->evaluate_non_native_field_multiplication(witnesses);
2380
2382 to_mul.prime_basis_limb,
2383 quotient.prime_basis_limb * negative_prime_modulus_mod_native_basis,
2384 -remainder_prime_limb,
2385 "bigfield: prime limb identity failed");
2386
2387 field_t lo = field_t<Builder>::from_witness_index(ctx, lo_idx) + borrow_lo;
2389
2390 // if both the hi and lo output limbs have less than 70 bits, we can use our custom
2391 // limb accumulation gate (accumulates 2 field elements, each composed of 5 14-bit limbs, in 3 gates)
2392 if (carry_lo_msb <= 70 && carry_hi_msb <= 70) {
2393 ctx->range_constrain_two_limbs(hi.get_witness_index(),
2394 lo.get_witness_index(),
2395 static_cast<size_t>(carry_hi_msb),
2396 static_cast<size_t>(carry_lo_msb),
2397 "bigfield::unsafe_evaluate_multiply_add: carries too large");
2398 } else {
2399 hi.create_range_constraint(static_cast<size_t>(carry_hi_msb), "bigfield: carry_hi too large");
2400 lo.create_range_constraint(static_cast<size_t>(carry_lo_msb), "bigfield: carry_lo too large");
2401 }
2402}
2403
2404template <typename Builder, typename T>
2406 const std::vector<bigfield>& input_right,
2407 const std::vector<bigfield>& to_add,
2408 const bigfield& input_quotient,
2409 const std::vector<bigfield>& input_remainders)
2410{
2411 BB_ASSERT_EQ(input_left.size(), input_right.size());
2412 BB_ASSERT_LTE(input_left.size(), MAXIMUM_SUMMAND_COUNT);
2413 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
2414 BB_ASSERT_LTE(input_remainders.size(), MAXIMUM_SUMMAND_COUNT);
2415
2416 // Sanity checks
2417 bool is_left_constant = true;
2418 for (auto& el : input_left) {
2419 el.sanity_check();
2420 is_left_constant &= el.is_constant();
2421 }
2422 bool is_right_constant = true;
2423 for (auto& el : input_right) {
2424 el.sanity_check();
2425 is_right_constant &= el.is_constant();
2426 }
2427 for (auto& el : to_add) {
2428 el.sanity_check();
2429 }
2430 input_quotient.sanity_check();
2431 for (auto& el : input_remainders) {
2432 el.sanity_check();
2433 }
2434
2435 // We must have at least one left or right multiplicand as witnesses.
2436 BB_ASSERT(!is_left_constant || !is_right_constant);
2437
2438 std::vector<bigfield> remainders(input_remainders);
2439 std::vector<bigfield> left(input_left);
2440 std::vector<bigfield> right(input_right);
2441 bigfield quotient = input_quotient;
2442 const size_t num_multiplications = input_left.size();
2443
2444 // Fetch the context
2445 Builder* ctx = nullptr;
2446 for (const auto& el : input_left) {
2447 if (el.context) {
2448 ctx = el.context;
2449 break;
2450 }
2451 }
2452 if (ctx == nullptr) {
2453 for (const auto& el : input_right) {
2454 if (el.context) {
2455 ctx = el.context;
2456 break;
2457 }
2458 }
2459 }
2460 BB_ASSERT(ctx != nullptr);
2461
2468 uint512_t max_lo = 0;
2469 uint512_t max_hi = 0;
2470
2471 // Compute the maximum value that needs to be borrowed from the hi limbs to the lo limb.
2472 // Check the README for the explanation of the borrow.
2473 uint256_t max_remainders_lo(0);
2474 for (const auto& remainder : input_remainders) {
2475 max_remainders_lo += remainder.binary_basis_limbs[0].maximum_value +
2476 (remainder.binary_basis_limbs[1].maximum_value << NUM_LIMB_BITS);
2477 }
2478
2479 // While performing the subtraction of (sum of) remainder(s) as:
2480 //
2481 // (Σi ai * bi + q * p') - (Σj rj)
2482 //
2483 // we want to ensure that the lower limbs do not underflow. So we add a borrow value
2484 // to the lower limbs and subtract it from the higher limbs. Naturally, such a borrow value
2485 // must be a multiple of 2^2L (where L = NUM_LIMB_BITS). Let borrow_lo_value be the value
2486 // borrowed from the hi limbs, then we must have:
2487 //
2488 // borrow_lo_value * 2^(2L) >= max_remainders_lo
2489 //
2490 // Thus, we can compute the minimum borrow_lo_value as:
2491 //
2492 // borrow_lo_value = ⌈ max_remainders_lo / 2^(2L) ⌉
2493 //
2494 uint256_t borrow_lo_value =
2495 (max_remainders_lo + ((uint256_t(1) << (2 * NUM_LIMB_BITS)) - 1)) >> (2 * NUM_LIMB_BITS);
2496 field_t<Builder> borrow_lo(ctx, bb::fr(borrow_lo_value));
2497
2498 // Compute the maximum value of the quotient times modulus.
2499 const auto [max_q_neg_p_lo, max_q_neg_p_hi] = compute_partial_schoolbook_multiplication(
2500 neg_modulus_mod_binary_basis_limbs_u256, quotient.get_binary_basis_limb_maximums());
2501
2502 // update max_lo, max_hi with quotient limb product terms.
2503 max_lo += max_q_neg_p_lo + max_remainders_lo;
2504 max_hi += max_q_neg_p_hi;
2505
2506 // Compute maximum value of addition terms in `to_add` and add to max_lo, max_hi
2507 uint512_t max_a0(0);
2508 uint512_t max_a1(0);
2509 for (size_t i = 0; i < to_add.size(); ++i) {
2510 max_a0 += to_add[i].binary_basis_limbs[0].maximum_value +
2511 (to_add[i].binary_basis_limbs[1].maximum_value << NUM_LIMB_BITS);
2512 max_a1 += to_add[i].binary_basis_limbs[2].maximum_value +
2513 (to_add[i].binary_basis_limbs[3].maximum_value << NUM_LIMB_BITS);
2514 }
2515 max_lo += max_a0;
2516 max_hi += max_a1;
2517
2518 // Compute the maximum value of our multiplication products and add to max_lo, max_hi
2519 for (size_t i = 0; i < num_multiplications; ++i) {
2520 const auto [product_lo, product_hi] = compute_partial_schoolbook_multiplication(
2521 left[i].get_binary_basis_limb_maximums(), right[i].get_binary_basis_limb_maximums());
2522 max_lo += product_lo;
2523 max_hi += product_hi;
2524 }
2525
2526 const uint512_t max_lo_carry = max_lo >> (2 * NUM_LIMB_BITS);
2527 max_hi += max_lo_carry;
2528 // Compute the maximum number of bits in `max_lo` and `max_hi` - this defines the range constraint values we
2529 // will need to apply to validate our product
2530 uint64_t max_lo_bits = (max_lo.get_msb() + 1);
2531 uint64_t max_hi_bits = max_hi.get_msb() + 1;
2532
2533 // The custom bigfield multiplication gate requires inputs are witnesses.
2534 // If we're using constant values, instantiate them as circuit variables
2535 //
2536 // Explanation:
2537 // The bigfield multiplication gate expects witnesses and disallows circuit constants
2538 // because allowing circuit constants would lead to complex circuit logic to support
2539 // different combinations of constant and witness inputs. Particularly, bigfield multiplication
2540 // gate enforces constraints of the form: a * b - q * p + r = 0, where:
2541 //
2542 // input left a = (a3 || a2 || a1 || a0)
2543 // input right b = (b3 || b2 || b1 || b0)
2544 // quotient q = (q3 || q2 || q1 || q0)
2545 // remainder r = (r3 || r2 || r1 || r0)
2546 //
2547 // | a1 | b1 | r0 | lo_0 | <-- product gate 1: check lo_0
2548 // | a0 | b0 | a3 | b3 |
2549 // | a2 | b2 | r3 | hi_0 |
2550 // | a1 | b1 | r2 | hi_1 |
2551 //
2552 // Example constaint: lo_0 = (a1 * b0 + a0 * b1) * 2^b + (a0 * b0) - r0
2553 // ==> w4 = (w1 * w'2 + w'1 * w2) * 2^b + (w'1 * w'2) - w3
2554 //
2555 // If a, b both are witnesses, this special gate performs 3 field multiplications per gate.
2556 // If b was a constant, then we would need to no field multiplications, but instead update the
2557 // the limbs of a with multiplicative and additive constants. This just makes the circuit logic
2558 // more complex, so we disallow constants. If there are constants, we convert them to fixed witnesses (at the
2559 // expense of 1 extra gate per constant).
2560 //
2561 const auto convert_constant_to_fixed_witness = [ctx](const bigfield& input) {
2562 BB_ASSERT(input.is_constant());
2563 bigfield output(input);
2564 // Save the original tag before converting to witnesses
2565 auto original_tag = input.get_origin_tag();
2566 output.prime_basis_limb =
2567 field_t<Builder>::from_witness_index(ctx, ctx->put_constant_variable(input.prime_basis_limb.get_value()));
2569 ctx, ctx->put_constant_variable(input.binary_basis_limbs[0].element.get_value()));
2571 ctx, ctx->put_constant_variable(input.binary_basis_limbs[1].element.get_value()));
2573 ctx, ctx->put_constant_variable(input.binary_basis_limbs[2].element.get_value()));
2575 ctx, ctx->put_constant_variable(input.binary_basis_limbs[3].element.get_value()));
2576 output.context = ctx;
2577 // Restore the original tag after converting to witnesses
2578 output.set_origin_tag(original_tag);
2579 return output;
2580 };
2581
2582 // evalaute a nnf mul and add into existing lohi output for our extra product terms
2583 // we need to add the result of (left_b * right_b) into lo_1_idx and hi_1_idx
2584 // our custom gate evaluates: ((a * b) + (q * neg_modulus) - r) / 2^{136} = lo + hi * 2^{136}
2585 // where q is a 'quotient' bigfield and neg_modulus is defined by selector polynomial values
2586 // The custom gate costs 7 constraints, which is cheaper than computing `a * b` using multiplication +
2587 // addition gates But....we want to obtain `left_a * right_b + lo_1 + hi_1 * 2^{136} = lo + hi * 2^{136}` If
2588 // we set `neg_modulus = [2^{136}, 0, 0, 0]` and `q = [lo_1, 0, hi_1, 0]`, then we will add `lo_1` into
2589 // `lo`, and `lo_1/2^{136} + hi_1` into `hi`. we can then subtract off `lo_1/2^{136}` from `hi`, by setting
2590 // `r = [0, 0, lo_1, 0]` This saves us 2 addition gates as we don't have to add together the outputs of two
2591 // calls to `evaluate_non_native_field_multiplication`
2592 std::vector<field_t<Builder>> limb_0_accumulator;
2593 std::vector<field_t<Builder>> limb_2_accumulator;
2594 std::vector<field_t<Builder>> prime_limb_accumulator;
2595
2596 for (size_t i = 0; i < num_multiplications; ++i) {
2597 if (left[i].is_constant()) {
2598 left[i] = convert_constant_to_fixed_witness(left[i]);
2599 }
2600 if (right[i].is_constant()) {
2601 right[i] = convert_constant_to_fixed_witness(right[i]);
2602 }
2603
2604 if (i > 0) {
2606 left[i].get_binary_basis_limb_witness_indices(),
2607 right[i].get_binary_basis_limb_witness_indices(),
2608 };
2609
2610 const auto [lo_2_idx, hi_2_idx] = ctx->queue_partial_non_native_field_multiplication(mul_witnesses);
2611
2614 // Set CONSTANT tags so these intermediate results are absorbed during tag merging
2615 // The final tag will come from the remainders which have properly merged tags from mult_madd
2616 auto const_tag = OriginTag::constant();
2617 lo_2.set_origin_tag(const_tag);
2618 hi_2.set_origin_tag(const_tag);
2619
2620 limb_0_accumulator.emplace_back(-lo_2);
2621 limb_2_accumulator.emplace_back(-hi_2);
2622 prime_limb_accumulator.emplace_back(-(left[i].prime_basis_limb * right[i].prime_basis_limb));
2623 }
2624 }
2625 if (quotient.is_constant()) {
2626 quotient = convert_constant_to_fixed_witness(quotient);
2627 }
2628
2629 bool no_remainders = remainders.empty();
2630 if (!no_remainders) {
2631 limb_0_accumulator.emplace_back(remainders[0].binary_basis_limbs[0].element);
2632 limb_2_accumulator.emplace_back(remainders[0].binary_basis_limbs[2].element);
2633 prime_limb_accumulator.emplace_back(remainders[0].prime_basis_limb);
2634 }
2635 for (size_t i = 1; i < remainders.size(); ++i) {
2636 limb_0_accumulator.emplace_back(remainders[i].binary_basis_limbs[0].element);
2637 limb_0_accumulator.emplace_back(remainders[i].binary_basis_limbs[1].element * shift_1);
2638 limb_2_accumulator.emplace_back(remainders[i].binary_basis_limbs[2].element);
2639 limb_2_accumulator.emplace_back(remainders[i].binary_basis_limbs[3].element * shift_1);
2640 prime_limb_accumulator.emplace_back(remainders[i].prime_basis_limb);
2641 }
2642 for (const auto& add : to_add) {
2643 limb_0_accumulator.emplace_back(-add.binary_basis_limbs[0].element);
2644 limb_0_accumulator.emplace_back(-add.binary_basis_limbs[1].element * shift_1);
2645 limb_2_accumulator.emplace_back(-add.binary_basis_limbs[2].element);
2646 limb_2_accumulator.emplace_back(-add.binary_basis_limbs[3].element * shift_1);
2647 prime_limb_accumulator.emplace_back(-add.prime_basis_limb);
2648 }
2649
2650 field_t<Builder> accumulated_lo = field_t<Builder>::accumulate(limb_0_accumulator);
2651 field_t<Builder> accumulated_hi = field_t<Builder>::accumulate(limb_2_accumulator);
2652 if (accumulated_lo.is_constant()) {
2653 accumulated_lo =
2654 field_t<Builder>::from_witness_index(ctx, ctx->put_constant_variable(accumulated_lo.get_value()));
2655 }
2656 if (accumulated_hi.is_constant()) {
2657 accumulated_hi =
2658 field_t<Builder>::from_witness_index(ctx, ctx->put_constant_variable(accumulated_hi.get_value()));
2659 }
2660 field_t<Builder> remainder1 = no_remainders ? field_t<Builder>::from_witness_index(ctx, ctx->zero_idx())
2661 : remainders[0].binary_basis_limbs[1].element;
2662 if (remainder1.is_constant()) {
2663 remainder1 = field_t<Builder>::from_witness_index(ctx, ctx->put_constant_variable(remainder1.get_value()));
2664 }
2665 field_t<Builder> remainder3 = no_remainders ? field_t<Builder>::from_witness_index(ctx, ctx->zero_idx())
2666 : remainders[0].binary_basis_limbs[3].element;
2667 if (remainder3.is_constant()) {
2668 remainder3 = field_t<Builder>::from_witness_index(ctx, ctx->put_constant_variable(remainder3.get_value()));
2669 }
2670 std::array<field_t<Builder>, NUM_LIMBS> remainder_limbs{
2671 accumulated_lo,
2672 remainder1,
2673 accumulated_hi,
2674 remainder3,
2675 };
2676 field_t<Builder> remainder_prime_limb = field_t<Builder>::accumulate(prime_limb_accumulator);
2677
2679 left[0].get_binary_basis_limb_witness_indices(),
2680 right[0].get_binary_basis_limb_witness_indices(),
2682 {
2683 remainder_limbs[0].get_witness_index(),
2684 remainder_limbs[1].get_witness_index(),
2685 remainder_limbs[2].get_witness_index(),
2686 remainder_limbs[3].get_witness_index(),
2687 },
2688 { neg_modulus_mod_binary_basis_limbs[0],
2689 neg_modulus_mod_binary_basis_limbs[1],
2690 neg_modulus_mod_binary_basis_limbs[2],
2691 neg_modulus_mod_binary_basis_limbs[3] },
2692 };
2693
2694 const auto [lo_1_idx, hi_1_idx] = ctx->evaluate_non_native_field_multiplication(witnesses);
2695
2696 field_t<Builder>::evaluate_polynomial_identity(left[0].prime_basis_limb,
2697 right[0].prime_basis_limb,
2698 quotient.prime_basis_limb * negative_prime_modulus_mod_native_basis,
2699 -remainder_prime_limb,
2700 "bigfield: prime limb identity failed");
2701
2702 field_t lo = field_t<Builder>::from_witness_index(ctx, lo_1_idx) + borrow_lo;
2704
2705 BB_ASSERT(max_lo_bits > (2 * NUM_LIMB_BITS));
2706 BB_ASSERT(max_hi_bits > (2 * NUM_LIMB_BITS));
2707
2708 uint64_t carry_lo_msb = max_lo_bits - (2 * NUM_LIMB_BITS);
2709 uint64_t carry_hi_msb = max_hi_bits - (2 * NUM_LIMB_BITS);
2710
2711 // if both the hi and lo output limbs have less than 70 bits, we can use our custom
2712 // limb accumulation gate (accumulates 2 field elements, each composed of 5 14-bit limbs, in 3 gates)
2713 if (carry_lo_msb <= 70 && carry_hi_msb <= 70) {
2714 ctx->range_constrain_two_limbs(hi.get_witness_index(),
2715 lo.get_witness_index(),
2716 static_cast<size_t>(carry_hi_msb),
2717 static_cast<size_t>(carry_lo_msb),
2718 "bigfield::unsafe_evaluate_multiply_add: carries too large");
2719 } else {
2720 hi.create_range_constraint(static_cast<size_t>(carry_hi_msb), "bigfield: carry_hi too large");
2721 lo.create_range_constraint(static_cast<size_t>(carry_lo_msb), "bigfield: carry_lo too large");
2722 }
2723}
2724
2725template <typename Builder, typename T>
2727 const std::vector<bigfield>& to_add,
2728 const bigfield& quotient,
2729 const bigfield& remainder)
2730{
2731 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
2732
2733 // Suppose input is:
2734 // x = (x3 || x2 || x1 || x0)
2735 //
2736 // x * x = (x0 * x0) +
2737 // (2 • x0 * x1) • 2^b +
2738 // (2 • x0 * x2 + x1 * x1) • 2^{2b} +
2739 // (2 • x0 * x3 + 2 • x1 * x2) • 2^{3b}.
2740 //
2741 // We need 6 multiplications to compute the above, which can be computed using two custom multiplication gates.
2742 // Since each custom bigfield gate can compute 3, we can compute the above using 2 custom multiplication gates
2743 // (as against 3 gates if we used the current bigfield multiplication gate).
2744 // We however avoid this optimization for now and end up using the existing bigfield multiplication gate.
2745 //
2746 unsafe_evaluate_multiply_add(left, left, to_add, quotient, { remainder });
2747}
2748
2749template <typename Builder, typename T>
2751 const bigfield& a, const bigfield& b, const std::vector<bigfield>& to_add)
2752{
2753 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
2754
2756 for (const auto& add_element : to_add) {
2757 add_element.reduction_check();
2758 add_values += add_element.get_value();
2759 }
2760
2761 const uint1024_t left(a.get_value());
2762 const uint1024_t right(b.get_value());
2763 const uint1024_t add_right(add_values);
2764 const uint1024_t modulus(target_basis.modulus);
2765
2766 const auto [quotient_1024, remainder_1024] = (left * right + add_right).divmod(modulus);
2767
2768 return { quotient_1024.lo, remainder_1024.lo };
2769}
2770
2771template <typename Builder, typename T>
2773 const std::vector<uint512_t>& bs,
2774 const std::vector<uint512_t>& to_add)
2775{
2776 BB_ASSERT_EQ(as.size(), bs.size());
2777 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
2778
2780 for (const auto& add_element : to_add) {
2781 add_values += add_element;
2782 }
2783 uint1024_t product_sum(0);
2784 for (size_t i = 0; i < as.size(); i++) {
2785 product_sum += uint1024_t(as[i]) * uint1024_t(bs[i]);
2786 }
2787 const uint1024_t add_right(add_values);
2788 const uint1024_t modulus(target_basis.modulus);
2789
2790 const auto [quotient_1024, remainder_1024] = (product_sum + add_right).divmod(modulus);
2791
2792 return quotient_1024.lo;
2793}
2794template <typename Builder, typename T>
2796 const std::vector<uint512_t>& bs_max,
2797 const std::vector<bigfield>& to_add,
2798 const std::vector<uint1024_t>& remainders_max)
2799{
2800 BB_ASSERT_EQ(as_max.size(), bs_max.size());
2801
2802 BB_ASSERT_LTE(to_add.size(), MAXIMUM_SUMMAND_COUNT);
2803 BB_ASSERT_LTE(as_max.size(), MAXIMUM_SUMMAND_COUNT);
2804 BB_ASSERT_LTE(remainders_max.size(), MAXIMUM_SUMMAND_COUNT);
2805
2806 // Check if the product sum can overflow CRT modulus
2807 if (mul_product_overflows_crt_modulus(as_max, bs_max, to_add)) {
2808 return std::pair<bool, size_t>(true, 0);
2809 }
2810 const size_t num_quotient_bits = get_quotient_max_bits(remainders_max);
2811 std::vector<uint512_t> to_add_max;
2812 for (auto& added_element : to_add) {
2813 to_add_max.push_back(added_element.get_maximum_value());
2814 }
2815 // Get maximum value of quotient
2816 const uint512_t maximum_quotient = compute_maximum_quotient_value(as_max, bs_max, to_add_max);
2817
2818 // Check if the quotient can fit into the range proof
2819 if (maximum_quotient >= (uint512_t(1) << num_quotient_bits)) {
2820 return std::pair<bool, size_t>(true, 0);
2821 }
2822 return std::pair<bool, size_t>(false, num_quotient_bits);
2823}
2824
2825template <typename Builder, typename T>
2828{
2829 const uint512_t b0_inner = (a_limbs[1] * b_limbs[0]);
2830 const uint512_t b1_inner = (a_limbs[0] * b_limbs[1]);
2831 const uint512_t c0_inner = (a_limbs[1] * b_limbs[1]);
2832 const uint512_t c1_inner = (a_limbs[2] * b_limbs[0]);
2833 const uint512_t c2_inner = (a_limbs[0] * b_limbs[2]);
2834 const uint512_t d0_inner = (a_limbs[3] * b_limbs[0]);
2835 const uint512_t d1_inner = (a_limbs[2] * b_limbs[1]);
2836 const uint512_t d2_inner = (a_limbs[1] * b_limbs[2]);
2837 const uint512_t d3_inner = (a_limbs[0] * b_limbs[3]);
2838
2839 const uint512_t r0_inner = (a_limbs[0] * b_limbs[0]); // c0 := a0 * b0
2840 const uint512_t r1_inner = b0_inner + b1_inner; // c1 := a1 * b0 + a0 * b1
2841 const uint512_t r2_inner = c0_inner + c1_inner + c2_inner; // c2 := a2 * b0 + a1 * b1 + a0 * b2
2842 const uint512_t r3_inner = d0_inner + d1_inner + d2_inner + d3_inner; // c3 := a3 * b0 + a2 * b1 + a1 * b2 + a0 * b3
2843 const uint512_t lo_val = r0_inner + (r1_inner << NUM_LIMB_BITS); // lo := c0 + c1 * 2^b
2844 const uint512_t hi_val = r2_inner + (r3_inner << NUM_LIMB_BITS); // hi := c2 + c3 * 2^b
2845 return std::pair<uint512_t, uint512_t>(lo_val, hi_val);
2846}
2847
2857template <typename Builder, typename T>
2859 const uint32_t limb_idx,
2860 const size_t num_limb_bits)
2861{
2862 BB_ASSERT_LT(uint256_t(ctx->get_variable(limb_idx)), (uint256_t(1) << num_limb_bits));
2863 constexpr bb::fr LIMB_MASK = (uint256_t(1) << NUM_LIMB_BITS) - 1;
2864 const uint256_t value = ctx->get_variable(limb_idx);
2865 const uint256_t low = value & LIMB_MASK;
2866 const uint256_t hi = value >> NUM_LIMB_BITS;
2867 BB_ASSERT_EQ(low + (hi << NUM_LIMB_BITS), value);
2868
2869 const uint32_t low_idx = ctx->add_variable(bb::fr(low));
2870 const uint32_t hi_idx = ctx->add_variable(bb::fr(hi));
2871
2872 BB_ASSERT_GT(num_limb_bits, NUM_LIMB_BITS);
2873 const size_t lo_bits = NUM_LIMB_BITS;
2874 const size_t hi_bits = num_limb_bits - NUM_LIMB_BITS;
2875 ctx->range_constrain_two_limbs(
2876 low_idx, hi_idx, lo_bits, hi_bits, "decompose_non_native_field_double_width_limb: limbs too large");
2877
2878 // Constrain: original == low + hi * 2^NUM_LIMB_BITS
2882 field_t<Builder>::evaluate_linear_identity(original, -lo_field, -hi_field * shift_1, field_t<Builder>(0));
2883
2884 return std::array<uint32_t, 2>{ low_idx, hi_idx };
2885}
2886
2887} // namespace bb::stdlib
#define BB_ASSERT(expression,...)
Definition assert.hpp:70
#define BB_ASSERT_GT(left, right,...)
Definition assert.hpp:113
#define BB_ASSERT_EQ(actual, expected,...)
Definition assert.hpp:83
#define BB_ASSERT_LTE(left, right,...)
Definition assert.hpp:158
#define BB_ASSERT_LT(left, right,...)
Definition assert.hpp:143
constexpr uint256_t slice(uint64_t start, uint64_t end) const
constexpr uint64_t get_msb() const
constexpr uintx slice(const uint64_t start, const uint64_t end) const
Definition uintx.hpp:81
constexpr uint64_t get_msb() const
Definition uintx.hpp:68
static void unsafe_evaluate_multiple_multiply_add(const std::vector< bigfield > &input_left, const std::vector< bigfield > &input_right, const std::vector< bigfield > &to_add, const bigfield &input_quotient, const std::vector< bigfield > &input_remainders)
Evaluate a relation involving multiple multiplications and additions.
static bigfield conditional_assign(const bool_t< Builder > &predicate, const bigfield &lhs, const bigfield &rhs)
Definition bigfield.hpp:568
static bigfield msub_div(const std::vector< bigfield > &mul_left, const std::vector< bigfield > &mul_right, const bigfield &divisor, const std::vector< bigfield > &to_sub, bool enable_divisor_nz_check=true)
Builder * get_context() const
Definition bigfield.hpp:689
bigfield operator*(const bigfield &other) const
Evaluate a non-native field multiplication: (a * b = c mod p) where p == target_basis....
bigfield conditional_select(const bigfield &other, const bool_t< Builder > &predicate) const
Create an element which is equal to either this or other based on the predicate.
static bigfield div_check_denominator_nonzero(const std::vector< bigfield > &numerators, const bigfield &denominator)
static bigfield sum(const std::vector< bigfield > &terms)
Create constraints for summing these terms.
bigfield(const field_t< Builder > &low_bits, const field_t< Builder > &high_bits, const bool can_overflow=false, const size_t maximum_bitlength=0)
Constructs a new bigfield object from two field elements representing the low and high bits.
static void unsafe_evaluate_square_add(const bigfield &left, const std::vector< bigfield > &to_add, const bigfield &quotient, const bigfield &remainder)
Evaluate a square with several additions.
bigfield madd(const bigfield &to_mul, const std::vector< bigfield > &to_add) const
Compute a * b + ...to_add = c mod p.
bigfield conditional_negate(const bool_t< Builder > &predicate) const
static bigfield mult_madd(const std::vector< bigfield > &mul_left, const std::vector< bigfield > &mul_right, const std::vector< bigfield > &to_add, bool fix_remainder_to_zero=false)
void set_origin_tag(const bb::OriginTag &tag) const
Definition bigfield.hpp:691
uint512_t get_value() const
void assert_is_in_field(std::string const &msg="bigfield::assert_is_in_field") const
static bigfield internal_div(const std::vector< bigfield > &numerators, const bigfield &denominator, bool check_for_zero)
void assert_less_than(const uint256_t &upper_limit, std::string const &msg="bigfield::assert_less_than") const
bigfield add_to_lower_limb(const field_t< Builder > &other, const uint256_t &other_maximum_value) const
Add a field element to the lower limb. CAUTION (the element has to be constrained before using this f...
void set_free_witness_tag()
Set the free witness flag for the bigfield.
Definition bigfield.hpp:718
bigfield & operator=(const bigfield &other)
void convert_constant_to_fixed_witness(Builder *builder)
Definition bigfield.hpp:665
uint512_t get_maximum_value() const
std::array< uint256_t, NUM_LIMBS > get_binary_basis_limb_maximums()
Get the maximum values of the binary basis limbs.
static uint512_t compute_maximum_quotient_value(const std::vector< uint512_t > &as, const std::vector< uint512_t > &bs, const std::vector< uint512_t > &to_add)
Compute the maximum possible value of quotient of a*b+\sum(to_add)
bigfield sqradd(const std::vector< bigfield > &to_add) const
Square and add operator, computes a * a + ...to_add = c mod p.
bigfield add_two(const bigfield &add_a, const bigfield &add_b) const
Create constraints for summing three bigfield elements efficiently.
std::array< uint32_t, NUM_LIMBS > get_binary_basis_limb_witness_indices() const
Get the witness indices of the (normalized) binary basis limbs.
Definition bigfield.hpp:965
bb::OriginTag get_origin_tag() const
Definition bigfield.hpp:706
static bigfield from_witness(Builder *ctx, const bb::field< T > &input)
Definition bigfield.hpp:297
void reduction_check() const
Check if the bigfield element needs to be reduced.
void assert_zero_if(const bool_t< Builder > &predicate, std::string const &msg="bigfield::assert_zero_if failed") const
static constexpr uint256_t modulus
Definition bigfield.hpp:315
bool_t< Builder > is_less_than(const uint256_t &upper_limit, std::string const &msg="bigfield::is_less_than") const
static bigfield dual_madd(const bigfield &left_a, const bigfield &right_a, const bigfield &left_b, const bigfield &right_b, const std::vector< bigfield > &to_add)
bigfield sqr() const
Square operator, computes a * a = c mod p.
static void perform_reductions_for_mult_madd(std::vector< bigfield > &mul_left, std::vector< bigfield > &mul_right, const std::vector< bigfield > &to_add)
Performs individual reductions on the supplied elements as well as more complex reductions to prevent...
bool is_constant() const
Check if the bigfield is constant, i.e. its prime limb is constant.
Definition bigfield.hpp:603
static std::array< uint32_t, 2 > decompose_non_native_field_double_width_limb(Builder *ctx, const uint32_t limb_idx, const size_t num_limb_bits=(2 *NUM_LIMB_BITS))
Decompose a single witness into two limbs, range constrained to NUM_LIMB_BITS (68) and num_limb_bits ...
void reduce_mod_target_modulus() const
static std::pair< uint512_t, uint512_t > compute_quotient_remainder_values(const bigfield &a, const bigfield &b, const std::vector< bigfield > &to_add)
Compute the quotient and remainder values for dividing (a * b + (to_add[0] + ... + to_add[-1])) with ...
void unsafe_assert_less_than(const uint256_t &upper_limit, std::string const &msg="bigfield::unsafe_assert_less_than") const
Assert that the current bigfield is less than the given upper limit.
bigfield operator+(const bigfield &other) const
Adds two bigfield elements. Inputs are reduced to the modulus if necessary. Requires 4 gates if both ...
void assert_equal(const bigfield &other, std::string const &msg="bigfield::assert_equal") const
static bigfield create_from_u512_as_witness(Builder *ctx, const uint512_t &value, const bool can_overflow=false, const size_t maximum_bitlength=0)
Creates a bigfield element from a uint512_t. Bigfield element is constructed as a witness and not a c...
bigfield pow(const uint32_t exponent) const
Raise the bigfield element to the power of (out-of-circuit) exponent.
static std::pair< bool, size_t > get_quotient_reduction_info(const std::vector< uint512_t > &as_max, const std::vector< uint512_t > &bs_max, const std::vector< bigfield > &to_add, const std::vector< uint1024_t > &remainders_max={ DEFAULT_MAXIMUM_REMAINDER })
Check for 2 conditions (CRT modulus is overflown or the maximum quotient doesn't fit into range proof...
static bigfield unsafe_construct_from_limbs(const field_t< Builder > &a, const field_t< Builder > &b, const field_t< Builder > &c, const field_t< Builder > &d, const bool can_overflow=false)
Construct a bigfield element from binary limbs that are already reduced.
Definition bigfield.hpp:158
void sanity_check() const
Perform a sanity check on a value that is about to interact with another value.
static void unsafe_evaluate_multiply_add(const bigfield &input_left, const bigfield &input_to_mul, const std::vector< bigfield > &to_add, const bigfield &input_quotient, const std::vector< bigfield > &input_remainders)
Evaluate a multiply add identity with several added elements and several remainders.
field_t< Builder > prime_basis_limb
Represents a bigfield element in the prime basis: (a mod n) where n is the native modulus.
Definition bigfield.hpp:86
static bigfield div_without_denominator_check(const std::vector< bigfield > &numerators, const bigfield &denominator)
std::array< Limb, NUM_LIMBS > binary_basis_limbs
Represents a bigfield element in the binary basis. A bigfield element is represented as a combination...
Definition bigfield.hpp:81
bool_t< Builder > operator==(const bigfield &other) const
Validate whether two bigfield elements are equal to each other.
bigfield operator-() const
Negation operator, works by subtracting this from zero.
Definition bigfield.hpp:457
static std::pair< uint512_t, uint512_t > compute_partial_schoolbook_multiplication(const std::array< uint256_t, NUM_LIMBS > &a_limbs, const std::array< uint256_t, NUM_LIMBS > &b_limbs)
Compute the partial multiplication of two uint256_t arrays using schoolbook multiplication.
void self_reduce() const
Reduce the bigfield element modulo the target modulus.
void assert_is_not_equal(const bigfield &other, std::string const &msg="bigfield: prime limb diff is zero, but expected non-zero") const
bigfield operator/(const bigfield &other) const
Implements boolean logic in-circuit.
Definition bool.hpp:60
bool get_value() const
Definition bool.hpp:125
bool is_constant() const
Definition bool.hpp:127
void set_origin_tag(const OriginTag &new_tag) const
Definition bool.hpp:154
void unset_free_witness_tag()
Definition bool.hpp:157
Builder * context
Definition bool.hpp:168
OriginTag tag
Definition bool.hpp:179
OriginTag get_origin_tag() const
Definition bool.hpp:155
Represents a dynamic array of bytes in-circuit.
byte_array slice(size_t offset) const
Slice bytes from the byte array starting at offset. Does not add any constraints.
size_t size() const
Builder * get_context() const
bb::OriginTag get_origin_tag() const
void assert_is_zero(std::string const &msg="field_t::assert_is_zero") const
Enforce a copy constraint between *this and 0 stored at zero_idx of the Builder.
Definition field.cpp:689
void assert_equal(const field_t &rhs, std::string const &msg="field_t::assert_equal") const
Copy constraint: constrain that *this field is equal to rhs element.
Definition field.cpp:942
field_t madd(const field_t &to_mul, const field_t &to_add) const
Definition field.cpp:520
static field_t from_witness_index(Builder *ctx, uint32_t witness_index)
Definition field.cpp:67
bb::fr additive_constant
Definition field.hpp:94
static void evaluate_polynomial_identity(const field_t &a, const field_t &b, const field_t &c, const field_t &d, const std::string &msg="field_t::evaluate_polynomial_identity")
Given a, b, c, d, constrain a * b + c + d = 0 by creating a big_mul_gate.
Definition field.cpp:1137
static field_t accumulate(const std::vector< field_t > &input)
Efficiently compute the sum of vector entries. Using big_add_gate we reduce the number of gates neede...
Definition field.cpp:1180
static bool witness_indices_match(const field_t &a, const field_t &b)
Check if two field elements have the same witness index (for identity checks).
Definition field.hpp:532
void create_range_constraint(size_t num_bits, std::string const &msg="field_t::range_constraint") const
Let x = *this.normalize(), constrain x.v < 2^{num_bits}.
Definition field.cpp:921
Builder * context
Definition field.hpp:57
bb::fr multiplicative_constant
Definition field.hpp:95
static field_t conditional_assign_internal(const bool_t< Builder > &predicate, const field_t &lhs, const field_t &rhs)
If predicate == true then return lhs, else return rhs.
Definition field.cpp:895
bb::fr get_value() const
Given a := *this, compute its value given by a.v * a.mul + a.add.
Definition field.cpp:838
static void evaluate_linear_identity(const field_t &a, const field_t &b, const field_t &c, const field_t &d, const std::string &msg="field_t::evaluate_linear_identity")
Constrain a + b + c + d to be equal to 0.
Definition field.cpp:1101
bool is_constant() const
Definition field.hpp:442
void set_origin_tag(const OriginTag &new_tag) const
Definition field.hpp:358
uint32_t witness_index
Definition field.hpp:145
field_t add_two(const field_t &add_b, const field_t &add_c) const
Efficiently compute (this + a + b) using big_mul gate.
Definition field.cpp:585
void assert_is_not_zero(std::string const &msg="field_t::assert_is_not_zero") const
Constrain *this to be non-zero by establishing that it has an inverse.
Definition field.cpp:720
uint32_t get_witness_index() const
Get the witness index of the current field element.
Definition field.hpp:519
StrictMock< MockContext > context
FF a
FF b
stdlib::field_t< Builder > field_ct
void add_values(TreeType &tree, const std::vector< NullifierLeafValue > &values)
uintx< uint256_t > uint512_t
Definition uintx.hpp:309
uintx< uint512_t > uint1024_t
Definition uintx.hpp:311
std::conditional_t< IsGoblinBigGroup< C, Fq, Fr, G >, element_goblin::goblin_element< C, goblin_field< C >, Fr, G >, element_default::element< C, Fq, Fr, G > > element
element wraps either element_default::element or element_goblin::goblin_element depending on parametr...
Entry point for Barretenberg command-line interface.
Definition api.hpp:5
Univariate< Fr, domain_end > operator+(const Fr &ff, const Univariate< Fr, domain_end > &uv)
field< Bn254FrParams > fr
Definition fr.hpp:155
C slice(C const &container, size_t start)
Definition container.hpp:9
Inner sum(Cont< Inner, Args... > const &in)
Definition container.hpp:70
constexpr decltype(auto) get(::tuplet::tuple< T... > &&t) noexcept
Definition tuple.hpp:13
This file contains part of the logic for the Origin Tag mechanism that tracks the use of in-circuit p...
static OriginTag constant()
constexpr field invert() const noexcept
Represents a single limb of a bigfield element, with its value and maximum value.
Definition bigfield.hpp:45
void throw_or_abort(std::string const &err)