Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Improve doc comments for Expression #406

Merged
merged 7 commits into from
Nov 5, 2024
Merged
13 changes: 7 additions & 6 deletions ceno_zkvm/src/expression.rs
matthiasgoergens marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,21 @@ use crate::{
pub enum Expression<E: ExtensionField> {
/// WitIn(Id)
WitIn(WitnessId),
/// Fixed
/// This multi-linear polynomial is known at the setup/keygen phase.
Fixed(Fixed),
/// Public Values
Instance(Instance),
/// Constant poly
Constant(E::BaseField),
/// This is the sum of two expression
/// This is the sum of two expressions
Sum(Box<Expression<E>>, Box<Expression<E>>),
/// This is the product of two polynomials
/// This is the product of two expressions
Product(Box<Expression<E>>, Box<Expression<E>>),
/// This is x, a, b expr to represent ax + b polynomial
/// and x is one of wit / fixed / instance, a and b are either constant or challenge
/// ScaledSum(x, a, b) to represent a * x + b
matthiasgoergens marked this conversation as resolved.
Show resolved Hide resolved
/// where x is one of wit / fixed / instance, a and b are either constants or challenges
ScaledSum(Box<Expression<E>>, Box<Expression<E>>, Box<Expression<E>>),
Challenge(ChallengeId, usize, E, E), // (challenge_id, power, scalar, offset)
/// Challenge(challenge_id, power, scalar, offset)
Challenge(ChallengeId, usize, E, E),
}

/// this is used as finite state machine state
Expand Down
Loading