feat: Derive more for various BasicSnippets

jan-ferdinand · jan-ferdinand · commit 3a66965b9346 · 2025-01-17T13:33:22.000+01:00
changelog: ignore
diff --git a/tasm-lib/src/arithmetic/i128/lt.rs b/tasm-lib/src/arithmetic/i128/lt.rs
@@ -23,6 +23,7 @@ use crate::prelude::*;
 /// # Panics
 ///
 ///  - If preconditions are not met.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct Lt;
 
 impl BasicSnippet for Lt {
diff --git a/tasm-lib/src/arithmetic/i128/shift_right.rs b/tasm-lib/src/arithmetic/i128/shift_right.rs
@@ -30,6 +30,7 @@ use crate::prelude::*;
 ///  - If preconditions are not met.
 ///
 /// [shr]: core::ops::Shr
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct ShiftRight;
 
 impl ShiftRight {
diff --git a/tasm-lib/src/arithmetic/u128/lt.rs b/tasm-lib/src/arithmetic/u128/lt.rs
@@ -11,6 +11,7 @@ use crate::prelude::*;
 /// BEFORE: _ [rhs; 4] [lhs; 4]
 /// AFTER:  _ (lhs < rhs)
 /// ```
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct Lt;
 
 impl BasicSnippet for Lt {
diff --git a/tasm-lib/src/arithmetic/xfe/cube.rs b/tasm-lib/src/arithmetic/xfe/cube.rs
@@ -2,6 +2,7 @@ use triton_vm::prelude::*;
 
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct Cube;
 
 impl BasicSnippet for Cube {
diff --git a/tasm-lib/src/arithmetic/xfe/square.rs b/tasm-lib/src/arithmetic/xfe/square.rs
@@ -2,6 +2,7 @@ use triton_vm::prelude::*;
 
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct Square;
 
 impl BasicSnippet for Square {
diff --git a/tasm-lib/src/arithmetic/xfe/to_the_fourth.rs b/tasm-lib/src/arithmetic/xfe/to_the_fourth.rs
@@ -21,6 +21,7 @@ use crate::traits::basic_snippet::SignOffFingerprint;
 /// ### Postconditions
 ///
 /// - the result is the argument raised to the fourth power
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct ToTheFourth;
 
 impl BasicSnippet for ToTheFourth {
diff --git a/tasm-lib/src/arithmetic/xfe/to_the_power_of_power_of_2.rs b/tasm-lib/src/arithmetic/xfe/to_the_power_of_power_of_2.rs
@@ -2,6 +2,7 @@ use triton_vm::prelude::*;
 
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct ToThePowerOfPowerOf2;
 
 impl BasicSnippet for ToThePowerOfPowerOf2 {
diff --git a/tasm-lib/src/array/horner_evaluation.rs b/tasm-lib/src/array/horner_evaluation.rs
@@ -11,6 +11,7 @@ use crate::prelude::*;
 /// polynomial in that point. It can be used for univariate batching, whereby
 /// the object is to compute a random linear sum of a given set of points, and
 /// the weights are given by the powers of one challenge.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct HornerEvaluation {
     pub num_coefficients: usize,
 }
diff --git a/tasm-lib/src/array/inner_product_of_three_rows_with_weights.rs b/tasm-lib/src/array/inner_product_of_three_rows_with_weights.rs
@@ -8,7 +8,7 @@ use triton_vm::table::master_table::MasterTable;
 use crate::data_type::ArrayType;
 use crate::prelude::*;
 
-#[derive(Debug, Clone, Copy, Display, Arbitrary)]
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Display, Arbitrary)]
 pub enum MainElementType {
     Bfe,
     Xfe,
@@ -29,6 +29,7 @@ impl From<MainElementType> for DataType {
 /// Calculate inner product of both main columns and auxiliary columns with weights. Returns one
 /// scalar in the form of an auxiliary-field element. Main column can be either a base field
 /// element, or an auxiliary-field element.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct InnerProductOfThreeRowsWithWeights {
     main_length: usize,
     main_element_type: MainElementType,
diff --git a/tasm-lib/src/array/inner_product_of_xfes.rs b/tasm-lib/src/array/inner_product_of_xfes.rs
@@ -3,6 +3,7 @@ use triton_vm::prelude::*;
 use crate::data_type::ArrayType;
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct InnerProductOfXfes {
     pub length: usize,
 }
diff --git a/tasm-lib/src/array/sum_of_bfes.rs b/tasm-lib/src/array/sum_of_bfes.rs
@@ -5,6 +5,7 @@ use crate::data_type::ArrayType;
 use crate::memory::load_words_from_memory_pop_pointer;
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct SumOfBfes {
     length: usize,
 }
diff --git a/tasm-lib/src/array/sum_of_xfes.rs b/tasm-lib/src/array/sum_of_xfes.rs
@@ -6,6 +6,7 @@ use crate::data_type::ArrayType;
 use crate::memory::load_words_from_memory_pop_pointer;
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct SumOfXfes {
     length: usize,
 }
diff --git a/tasm-lib/src/data_type.rs b/tasm-lib/src/data_type.rs
@@ -14,7 +14,7 @@ use crate::memory::write_words_to_memory_leave_pointer;
 use crate::memory::write_words_to_memory_pop_pointer;
 use crate::pop_encodable;
 
-#[derive(Debug, Clone, Hash, PartialEq, Eq)]
+#[derive(Debug, Clone, Eq, PartialEq, Hash)]
 pub enum DataType {
     Bool,
     U32,
diff --git a/tasm-lib/src/hashing/lt_digest.rs b/tasm-lib/src/hashing/lt_digest.rs
@@ -4,6 +4,7 @@ use triton_vm::prelude::*;
 use crate::prelude::*;
 
 /// Compare two digests
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct LtDigest;
 
 impl BasicSnippet for LtDigest {
diff --git a/tasm-lib/src/hashing/merkle_root_from_xfes_generic.rs b/tasm-lib/src/hashing/merkle_root_from_xfes_generic.rs
@@ -7,6 +7,7 @@ use crate::prelude::*;
 /// Calculate a Merkle root from a list of X-field elements.
 /// The input list must have a length that is a power of two
 /// and is not one. Can otherwise handle any length.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct MerkleRootFromXfesGeneric;
 
 impl BasicSnippet for MerkleRootFromXfesGeneric {
diff --git a/tasm-lib/src/hashing/merkle_root_from_xfes_static_size.rs b/tasm-lib/src/hashing/merkle_root_from_xfes_static_size.rs
@@ -7,6 +7,7 @@ use crate::data_type::ArrayType;
 use crate::hashing::merkle_root_static_size::MerkleRootStaticSize;
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct MerkleRootFromXfesStaticSize {
     /// Aka `height` of the Merkle tree
     pub log2_length: u8,
diff --git a/tasm-lib/src/hashing/merkle_root_from_xfes_wrapper.rs b/tasm-lib/src/hashing/merkle_root_from_xfes_wrapper.rs
@@ -5,6 +5,7 @@ use crate::prelude::*;
 
 /// Calculate a Merkle root from a list of X-field elements. List must have
 /// length 256, 512, or 1024.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct MerkleRootFromXfesWrapper;
 
 const MAX_LENGTH_SUPPORTED: u32 = 1024;
diff --git a/tasm-lib/src/list/contains.rs b/tasm-lib/src/list/contains.rs
@@ -7,6 +7,7 @@ use crate::prelude::*;
 /// This operation is *O*(*n*).
 ///
 /// Mirrors the `contains` method from Rust `core` as closely as possible.
+#[derive(Debug, Clone, Eq, PartialEq, Hash)]
 pub struct Contains {
     pub element_type: DataType,
 }
diff --git a/tasm-lib/src/list/horner_evaluation_dynamic_length.rs b/tasm-lib/src/list/horner_evaluation_dynamic_length.rs
@@ -7,6 +7,7 @@ use crate::prelude::*;
 /// HornerEvaluationDynamicLength takes a list of XFieldElements, representing
 /// the coefficients of a polynomial, and evaluates it in a given indeterminate,
 /// which is also an XFieldElement.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct HornerEvaluationDynamicLength;
 
 impl BasicSnippet for HornerEvaluationDynamicLength {
diff --git a/tasm-lib/src/traits/basic_snippet.rs b/tasm-lib/src/traits/basic_snippet.rs
@@ -333,6 +333,7 @@ mod tests {
 
     macro_rules! dummy_snippet {
         ($name:ident: $($instr:tt)+) => {
+            #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
             struct $name;
 
             impl BasicSnippet for $name {
diff --git a/tasm-lib/src/verifier/challenges/new_empty_input_and_output.rs b/tasm-lib/src/verifier/challenges/new_empty_input_and_output.rs
@@ -11,6 +11,7 @@ use crate::verifier::challenges::shared::challenges_data_type;
 use crate::verifier::eval_arg::compute_terminal_const_sized_static_symbols::ComputeTerminalConstSizedStaticSymbols;
 use crate::verifier::eval_arg::compute_terminal_from_digest::ComputeTerminalFromDigestInitialIsOne;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct NewEmptyInputAndOutput {
     // claim_input: Vec<BFieldElement>,
     // claim_output: Vec<BFieldElement>,
diff --git a/tasm-lib/src/verifier/eval_arg/compute_terminal_const_sized_static_symbols.rs b/tasm-lib/src/verifier/eval_arg/compute_terminal_const_sized_static_symbols.rs
@@ -10,6 +10,7 @@ use crate::prelude::*;
 /// and `symbols`. This amounts to evaluating polynomial
 /// `f(x) = initial·x^n + Σ_i symbols[n-i]·x^i`
 /// at point `challenge`, _i.e._, returns `f(challenge)`.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct ComputeTerminalConstSizedStaticSymbols<const N: usize> {
     pub symbols: [BFieldElement; N],
     pub initial: XFieldElement,
diff --git a/tasm-lib/src/verifier/eval_arg/compute_terminal_from_digest.rs b/tasm-lib/src/verifier/eval_arg/compute_terminal_from_digest.rs
@@ -2,6 +2,7 @@ use triton_vm::prelude::*;
 
 use crate::prelude::*;
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct ComputeTerminalFromDigestInitialIsOne;
 
 impl BasicSnippet for ComputeTerminalFromDigestInitialIsOne {
diff --git a/tasm-lib/src/verifier/fri/barycentric_evaluation.rs b/tasm-lib/src/verifier/fri/barycentric_evaluation.rs
@@ -9,6 +9,7 @@ const MAX_CODEWORD_LENGTH: u32 = 1 << 15;
 /// Use the barycentric Lagrange evaluation formula to extrapolate the codeword
 /// to an out-of-domain location. Codeword must have a length that is a power
 /// of 2 and may not exceed `MAX_CODEWORD_LENGTH`.
+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 pub struct BarycentricEvaluation;
 
 impl BasicSnippet for BarycentricEvaluation {

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ use crate::prelude::*;`
`11`	`11`	`/// polynomial in that point. It can be used for univariate batching, whereby`
`12`	`12`	`/// the object is to compute a random linear sum of a given set of points, and`
`13`	`13`	`/// the weights are given by the powers of one challenge.`
	`14`	`+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]`
`14`	`15`	`pub struct HornerEvaluation {`
`15`	`16`	`pub num_coefficients: usize,`
`16`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ use triton_vm::prelude::*;`
`3`	`3`	`use crate::data_type::ArrayType;`
`4`	`4`	`use crate::prelude::*;`
`5`	`5`
	`6`	`+#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]`
`6`	`7`	`pub struct InnerProductOfXfes {`
`7`	`8`	`pub length: usize,`
`8`	`9`	`}`