Skip to content

Commit

Permalink
doc: add header documentation to InputTable and OutputTable
Browse files Browse the repository at this point in the history
  • Loading branch information
zmalatrax committed Nov 12, 2024
1 parent 83ba643 commit 06e492f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions crates/brainfuck_prover/src/components/io/table.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,16 @@ impl<const N: u32> From<Vec<Registers>> for IOTable<N> {
}
}

/// Input table (trace) for the Input component.
///
/// This table is made of the memory values (`mv` register) corresponding to
/// inputs (when the current instruction `ci` equals ',').
pub type InputTable = IOTable<INPUT_INSTRUCTION>;

/// Output table (trace) for the Output component.
///
/// This table is made of the memory values (`mv` register) corresponding to
/// outputs (when the current instruction `ci` equals '.').
pub type OutputTable = IOTable<OUTPUT_INSTRUCTION>;

#[cfg(test)]
Expand Down

0 comments on commit 06e492f

Please sign in to comment.