Clippy (#81)

* run clippy fix warnings

* fmt

Author: z-tech

.github/workflows/rust.yml

@@ -4,33 +4,56 @@ on:
   push:
     branches: [ main ]
   pull_request:
-    branches: [ main ]
+    branches-ignore: []
 
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
-
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
+
+      - name: Check formatting
+        run: cargo fmt --check
 
-    - name: Check lint
-      run: cargo fmt --check
+  clippy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install stable toolchain with clippy
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          components: clippy
+          override: true
+
+      - name: Run clippy
+        run: cargo clippy -- -D warnings
+
+      - name: Check for clippy fixes
+        run: |
+          cargo clippy --fix --allow-dirty --allow-staged || true
+          if [[ -n "$(git status --porcelain)" ]]; then
+            echo "❌ Clippy would make changes. Please run 'cargo clippy --fix'."
+            git diff
+            exit 1
+          fi
 
   test_with_default_features:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - name: Run tests
-      run: cargo test --verbose
+      - name: Run tests
+        run: cargo test --verbose
 
   test_with_no_default_features:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - name: Run tests
-      run: cargo test --verbose --no-default-features
+      - name: Run tests
+        run: cargo test --verbose --no-default-features

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "space-efficient-sumcheck"
+name = "efficient-sumcheck"
 version = "0.0.2"
 authors = ["arkworks maintainers"]
 description = "TODO"

benches/provers.rs

@@ -3,7 +3,7 @@ use criterion::{
     criterion_group, criterion_main, measurement::WallTime, BatchSize, BenchmarkGroup, Criterion,
 };
 
-use space_efficient_sumcheck::{
+use efficient_sumcheck::{
     multilinear::TimeProver,
     multilinear_product::TimeProductProver,
     prover::{ProductProverConfig, Prover, ProverConfig},

src/hypercube/hypercube.rs renamed to src/hypercube/core.rs

@@ -1,5 +1,11 @@
 use crate::{hypercube::HypercubeMember, order_strategy::OrderStrategy};
 
+// mod hypercube;
+// mod hypercube_member;
+
+// pub use hypercube::Hypercube;
+// pub use hypercube_member::HypercubeMember;
+
 // On each call to next() this gives a HypercubeMember for the value
 #[derive(Debug)]
 pub struct Hypercube<O: OrderStrategy> {

src/hypercube/hypercube_member.rs

@@ -1,4 +1,3 @@
-// Basically this emulates a Vec<bool> as an iterator wrapped over a usize
 #[derive(Clone, Debug, PartialEq)]
 pub struct HypercubeMember {
     bit_index: usize,
@@ -21,6 +20,12 @@ impl HypercubeMember {
     pub fn len(&self) -> usize {
         self.num_vars
     }
+    pub fn is_empty(&self) -> bool {
+        if self.bit_index == 0 {
+            return true;
+        }
+        false
+    }
     pub fn usize_from_vec_bool(vec: Vec<bool>) -> usize {
         vec.into_iter()
             .rev()
@@ -29,7 +34,7 @@ impl HypercubeMember {
     }
     pub fn elements_at_indices(b: Vec<bool>, indices: Vec<usize>) -> Vec<bool> {
         // checks
-        if indices.len() == 0 {
+        if indices.is_empty() {
             return vec![];
         }
         assert!(b.len() >= indices.len());
@@ -61,7 +66,7 @@ impl Iterator for HypercubeMember {
             return None;
         }
         // Return if value is bit high at bit_index
-        self.bit_index = self.bit_index - 1;
+        self.bit_index -= 1;
         let bit_mask = 1 << self.bit_index;
         Some(self.value & bit_mask != 0)
     }

src/hypercube/mod.rs

@@ -1,5 +1,5 @@
-mod hypercube;
+mod core;
 mod hypercube_member;
 
-pub use hypercube::Hypercube;
+pub use core::Hypercube;
 pub use hypercube_member::HypercubeMember;

src/interpolation/lagrange_polynomial.rs

@@ -95,17 +95,16 @@ impl<'a, F: Field> Iterator for LagrangePolynomial<'a, F, GraycodeOrder> {
             let index_of_flipped_bit = bit_diff.trailing_zeros() as usize;
             let is_flipped_to_true = self.position & bit_diff != 0;
             let len = self.verifier_messages.messages.len();
-            self.value = self.value
-                * match is_flipped_to_true {
-                    true => {
-                        self.verifier_messages.message_and_message_hat_inverses
-                            [len - index_of_flipped_bit - 1]
-                    }
-                    false => {
-                        self.verifier_messages.message_hat_and_message_inverses
-                            [len - index_of_flipped_bit - 1]
-                    }
-                };
+            self.value *= match is_flipped_to_true {
+                true => {
+                    self.verifier_messages.message_and_message_hat_inverses
+                        [len - index_of_flipped_bit - 1]
+                }
+                false => {
+                    self.verifier_messages.message_hat_and_message_inverses
+                        [len - index_of_flipped_bit - 1]
+                }
+            };
         }
 
         // Step 5: increment positions

src/messages/verifier_messages.rs

@@ -58,9 +58,9 @@ impl<F: Field> VerifierMessages<F> {
                 self.messages_zeros_and_ones_usize << 1
             };
         } else {
-            self.zero_ones_mask = self.zero_ones_mask << 1;
-            self.messages_zeros_and_ones_usize = self.messages_zeros_and_ones_usize << 1;
-            self.product_of_message_hats = self.product_of_message_hats * message_hat;
+            self.zero_ones_mask <<= 1;
+            self.messages_zeros_and_ones_usize <<= 1;
+            self.product_of_message_hats *= message_hat;
         }
     }
 }

src/multilinear/provers/blendy/config.rs

@@ -13,7 +13,7 @@ where
     pub stream: S,
 }
 
-impl<'a, F, S> BlendyProverConfig<F, S>
+impl<F, S> BlendyProverConfig<F, S>
 where
     F: Field,
     S: Stream<F>,

src/multilinear/provers/blendy/blendy.rs renamed to src/multilinear/provers/blendy/core.rs

@@ -23,13 +23,13 @@ where
     pub verifier_messages: VerifierMessages<F>,
 }
 
-impl<'a, F, S> BlendyProver<F, S>
+impl<F, S> BlendyProver<F, S>
 where
     F: Field,
     S: Stream<F>,
 {
     fn shift_and_one_fill(num: usize, shift_amount: usize) -> usize {
-        (num << shift_amount) | (1 << shift_amount) - 1
+        (num << shift_amount) | ((1 << shift_amount) - 1)
     }
 
     pub fn compute_round(&self, partial_sums: &[F]) -> (F, F) {
@@ -81,7 +81,7 @@ where
     }
 
     pub fn is_start_of_stage(&self) -> bool {
-        self.current_round % self.stage_size == 0
+        self.current_round.is_multiple_of(self.stage_size)
     }
 
     fn is_single_staged(&self) -> bool {