Struct CompileConfig 

pub struct CompileConfig { /* private fields */ }

Parameters that determine how a BlockGraph is lowered: the surface code distance and T-source mode.

A valid surface code distance is odd and in 3..=MAX_CODE_DISTANCE; the upper bound limits the compiler’s quadratic grid materialization. The fields are private so this invariant holds by construction. Build one with try_new (the fallible public path) or new (panics on an invalid distance, for known-good internal literals).

Implementations

impl CompileConfig

pub const fn is_valid_distance(code_distance: u32) -> bool

Whether code_distance is a distance the compiler accepts: odd and in 3..=MAX_CODE_DISTANCE.

The predicate form of try_new, for front ends that validate an input field before there is a graph to compile.

Examples

use bloq_compile::CompileConfig;

assert!(CompileConfig::is_valid_distance(3));
assert!(!CompileConfig::is_valid_distance(4));
assert!(!CompileConfig::is_valid_distance(1));

pub fn try_new(code_distance: u32) -> Result<Self, InvalidDistance>

Builds a config, validating the documented distance range and parity.

Errors

Returns InvalidDistance unless is_valid_distance accepts code_distance.

pub fn new(code_distance: u32) -> Self

Builds a config from a known-valid distance.

Panics

Panics if code_distance is not odd and in 3..=255; use try_new for distances that come from user input.

pub fn code_distance(&self) -> u32

The surface code distance (odd and in 3..=MAX_CODE_DISTANCE).

pub fn prepare_t_with_mpps(&self) -> bool

Whether T blocks use the compact product-state preparation followed by one stabilizer MPP, instead of MSC-LS cultivation.

pub const fn with_prepare_t_with_mpps(self, enabled: bool) -> Self

Returns this config with compact T-block preparation enabled or disabled.

pub const fn certification_limits(&self) -> ModuleCertificationLimits

Limits applied while certifying a module hierarchy.

pub const fn with_certification_limits( self, limits: ModuleCertificationLimits, ) -> Self

Returns this config with explicit module-certification limits.

Trait Implementations

impl Clone for CompileConfig

fn clone(&self) -> CompileConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompileConfig

impl Debug for CompileConfig

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

Formats the value using the given formatter.

impl Default for CompileConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CompileConfig

impl Hash for CompileConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CompileConfig

fn eq(&self, other: &CompileConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CompileConfig