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

Fix article usage in documentation and code comments #14

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ verification logic can be delayed to query and decision phase.
- This implementation has low-degree test built-in, and can handle RS-IOP.
- Multiple oracles with same evaluation domain share a merkle tree and be submitted in one round, which greatly reduces
verification overhead and number of constraints.
- Each leaf of an low-degree oracle is a coset instead of an individual field element, which significantly reduces
- Each leaf of a low-degree oracle is a coset instead of an individual field element, which significantly reduces
merkle tree overhead on FRI query.

## Build Guide
Expand Down
2 changes: 1 addition & 1 deletion ark-bcs/src/bcs/constraints/verifier.rs
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ where

/// Verify without LDT.
///
/// ** Warning **: If verifier tries to get an low-degree oracle, no LDT
/// ** Warning **: If verifier tries to get a low-degree oracle, no LDT
/// will be automatically performed.
pub fn verify_with_dummy_ldt<V, S>(
cs: ConstraintSystemRef<CF>,
Expand Down
2 changes: 1 addition & 1 deletion ark-bcs/src/bcs/verifier.rs
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ where

/// Verify without LDT.
///
/// ** Warning **: If verifier tries to get an low-degree oracle, no LDT
/// ** Warning **: If verifier tries to get a low-degree oracle, no LDT
/// will be automatically performed.
pub fn verify_with_dummy_ldt<V, S>(
sponge: S,
Expand Down
2 changes: 1 addition & 1 deletion ark-bcs/src/iop/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use super::{
pub struct MsgRoundRef {
pub(crate) index: usize,
pub(crate) trace: TraceInfo,
/// Whether this round refers to an virtual oracle.
/// Whether this round refers to a virtual oracle.
pub(crate) is_virtual: bool,
}

Expand Down
2 changes: 1 addition & 1 deletion ark-bcs/src/iop/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ pub mod verifier;
/// Prover parameter used by IOP Prover. Any IOP prover parameter is a superset
/// of IOP verifier parameter.
pub trait ProverParam: Clone + Debug {
/// Verifier state should be a improper subset of `self`.
/// Verifier state should be an improper subset of `self`.
type VerifierParameter: VerifierParam;
/// Derive verifier parameter from prover parameter.
fn to_verifier_param(&self) -> Self::VerifierParameter;
Expand Down
2 changes: 1 addition & 1 deletion ark-bcs/src/ldt/constraints/rl_ldt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ impl<F: PrimeField + Absorb> LDTWithGadget<F> for LinearCombinationLDT<F> {

/// return evaluation of x^{degree_to_raise} at specific location (with coset
/// structure) For now, we assume the offset of codeword domain is constant.
/// TODO: in the future, the offset can also be an variable.
/// TODO: in the future, the offset can also be a variable.
fn degree_raise_poly_query<F: PrimeField>(
domain: Radix2CosetDomain<F>,
degree_to_raise: u64,
Expand Down
2 changes: 1 addition & 1 deletion ark-bcs/src/ldt/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub mod constraints;
/// LDT that runs FRI on a random linear combination.
pub mod rl_ldt;

/// Trait for LDT, which is an public coin IOP.
/// Trait for LDT, which is a public coin IOP.
pub trait LDT<F: PrimeField + Absorb> {
/// Parameters of `Self`
type LDTParameters: Clone;
Expand Down