Better comments for emulated operations.

EspressoSystems · Jun 15, 2023 · 9345eea · 9345eea
1 parent b99daea
commit 9345eea
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/relation/src/gadgets/emulated.rs b/relation/src/gadgets/emulated.rs
@@ -150,6 +150,8 @@ impl<F: PrimeField> PlonkCircuit<F> {
 
     /// Constrain that a*b=c in the emulated field.
     /// Checking that a * b - k * E::MODULUS = c.
+    /// This function doesn't perform emulated variable validaty check on the
+    /// input a, b and c. We assume that they are already performed elsewhere.
     pub fn emulated_mul_gate<E: EmulationConfig<F>>(
         &mut self,
         a: &EmulatedVariable<E>,
@@ -292,6 +294,8 @@ impl<F: PrimeField> PlonkCircuit<F> {
     }
 
     /// Constrain that a*b=c in the emulated field for a constant b.
+    /// This function doesn't perform emulated variable validaty check on the
+    /// input a and c. We assume that they are already performed elsewhere.
     pub fn emulated_mul_constant_gate<E: EmulationConfig<F>>(
         &mut self,
         a: &EmulatedVariable<E>,
@@ -408,6 +412,8 @@ impl<F: PrimeField> PlonkCircuit<F> {
 
     /// Constrain that a+b=c in the emulated field.
     /// Checking whether a + b = k * E::MODULUS + c
+    /// This function doesn't perform emulated variable validaty check on the
+    /// input a, b and c. We assume that they are already performed elsewhere.
     pub fn emulated_add_gate<E: EmulationConfig<F>>(
         &mut self,
         a: &EmulatedVariable<E>,
@@ -477,6 +483,8 @@ impl<F: PrimeField> PlonkCircuit<F> {
     }
 
     /// Constrain that a+b=c in the emulated field.
+    /// This function doesn't perform emulated variable validaty check on the
+    /// input a and c. We assume that they are already performed elsewhere.
     pub fn emulated_add_constant_gate<E: EmulationConfig<F>>(
         &mut self,
         a: &EmulatedVariable<E>,