Struct SinglePhaseCoreManager

pub struct SinglePhaseCoreManager<F: ScalarField> {
    pub threads: Vec<Context<F>>,
    pub copy_manager: SharedCopyConstraintManager<F>,
    pub break_points: RefCell<Option<ThreadBreakPoints>>,
    /* private fields */
}

Virtual region manager for Vec<BasicGateConfig> in a single challenge phase. This is the core manager for Contexts.

Fields

threads: Vec<Context<F>>

Virtual columns. These cannot be shared across CPU threads while keeping the circuit deterministic.

copy_manager: SharedCopyConstraintManager<F>

Global shared copy manager

break_points: RefCell<Option<ThreadBreakPoints>>

A very simple computation graph for the basic vertical gate. Must be provided as a “pinning” when running the production prover.

Implementations

impl<F: ScalarField> SinglePhaseCoreManager<F>

pub fn witness_gen_only(&self) -> bool

Flag for witness generation. If true, the gate thread builder is used for witness generation only.

pub fn use_unknown(&self) -> bool

The unknown flag is used during key generation. If true, during key generation witness Values are replaced with Value::unknown() for safety.

pub fn phase(&self) -> usize

The challenge phase the virtual regions will map to.

impl<F: ScalarField> SinglePhaseCoreManager<F>

pub fn new( witness_gen_only: bool, copy_manager: SharedCopyConstraintManager<F>, ) -> Self

Creates a new SinglePhaseCoreManager and spawns a main thread.

• witness_gen_only: If true, the SinglePhaseCoreManager is used for witness generation only.
  • If true, the gate thread builder only does witness asignments and does not store constraint information – this should only be used for the real prover.
  • If false, the gate thread builder is used for keygen and mock prover (it can also be used for real prover) and the builder stores circuit information (e.g. copy constraints, fixed columns, enabled selectors).
    • These values are fixed for the circuit at key generation time, and they do not need to be re-computed by the prover in the actual proving phase.

pub fn in_phase(self, phase: usize) -> Self

Sets the phase to phase

pub fn from_stage( stage: CircuitBuilderStage, copy_manager: SharedCopyConstraintManager<F>, ) -> Self

Creates a new SinglePhaseCoreManager depending on the stage of circuit building. If the stage is CircuitBuilderStage::Prover, the SinglePhaseCoreManager is used for witness generation only.

pub fn unknown(self, use_unknown: bool) -> Self

Creates a new SinglePhaseCoreManager with use_unknown flag set.

• use_unknown: If true, during key generation witness Values are replaced with Value::unknown() for safety.

pub fn set_copy_manager(&mut self, copy_manager: SharedCopyConstraintManager<F>)

Mutates self to use the given copy manager everywhere, including in all threads.

pub fn use_copy_manager( self, copy_manager: SharedCopyConstraintManager<F>, ) -> Self

Returns self with a given copy manager

pub fn clear(&mut self)

Clears all threads and copy manager

pub fn main(&mut self) -> &mut Context<F>

Returns a mutable reference to the Context of a gate thread. Spawns a new thread for the given phase, if none exists.

pub fn thread_count(&self) -> usize

Returns the number of threads

pub fn type_of(&self) -> &'static str

A distinct tag for this particular type of virtual manager, which is different for each phase.

pub fn new_context(&self, context_id: usize) -> Context<F>

Creates new context but does not append to self.threads

pub fn new_thread(&mut self) -> &mut Context<F>

Spawns a new thread for a new given phase. Returns a mutable reference to the Context of the new thread.

• phase: The phase (index) of the gate thread.

pub fn total_advice(&self) -> usize

Returns total advice cells

Trait Implementations

impl<F: Clone + ScalarField> Clone for SinglePhaseCoreManager<F>

fn clone(&self) -> SinglePhaseCoreManager<F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F: Debug + ScalarField> Debug for SinglePhaseCoreManager<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F: Default + ScalarField> Default for SinglePhaseCoreManager<F>

fn default() -> SinglePhaseCoreManager<F>

Returns the “default value” for a type.

impl<F: ScalarField> VirtualRegionManager<F> for SinglePhaseCoreManager<F>

type Config = (Vec<BasicGateConfig<F>>, usize)

The Halo2 config with associated columns and gates describing the physical Halo2 region that this virtual region manager is responsible for.

fn assign_raw( &self, (config, usable_rows): &Self::Config, region: &mut Region<'_, F>, )

Assign virtual region this is in charge of to the raw region described by config.

type Assignment = ()

Return type of the assign_raw method. Default is ().