rstim 0.4.0

Stim-aligned stabilizer circuit simulator and detector error model toolkit
Documentation
use rand::Rng;

use crate::compiled::CompiledCircuit;
use crate::data_path::build_reference_sample;
use crate::sampler::{BatchOutput, SampleOptions, SampleOutputMode};
use crate::sim::frame::FrameSimulator;

pub fn sample_compiled_batch(
    compiled: &CompiledCircuit,
    n_shots: usize,
    rng: &mut impl Rng,
    options: SampleOptions,
) -> Result<BatchOutput, String> {
    let reference_sample = build_reference_sample(&compiled.source, options.reference_sample_mode)?;
    sample_compiled_batch_with_reference(compiled, &reference_sample, n_shots, rng, options)
}

pub(crate) fn sample_compiled_batch_with_reference(
    compiled: &CompiledCircuit,
    reference_sample: &[bool],
    n_shots: usize,
    rng: &mut impl Rng,
    options: SampleOptions,
) -> Result<BatchOutput, String> {
    let mut frame = FrameSimulator::try_new(compiled.num_qubits, n_shots)?;
    frame.randomize_initial_z_frames(rng);
    frame
        .set_materialize_detector_observable_outputs(options.output_mode == SampleOutputMode::Full);
    frame.run_compiled_blocks(&compiled.blocks, reference_sample, rng)?;

    let measurements = frame.try_measurements(reference_sample)?;

    match options.output_mode {
        SampleOutputMode::Full => Ok(BatchOutput::full(
            measurements,
            frame.try_detections()?,
            frame.try_observable_flips()?,
            frame.detector_materializations(),
            frame.observable_materializations(),
        )),
        SampleOutputMode::MeasurementsOnly => BatchOutput::measurements_only_with_materializations(
            measurements,
            n_shots,
            frame.detector_materializations(),
            frame.observable_materializations(),
        ),
    }
}