Struct PrimalModuleParallel 

pub struct PrimalModuleParallel {
    pub units: Vec<PrimalModuleParallelUnitPtr>,
    pub config: PrimalModuleParallelConfig,
    pub partition_info: Arc<PartitionInfo>,
    pub thread_pool: Arc<ThreadPool>,
    pub last_solve_start_time: ArcRwLock<Instant>,
}

Fields

units: Vec<PrimalModuleParallelUnitPtr>

the basic wrapped serial modules at the beginning, afterwards the fused units are appended after them

config: PrimalModuleParallelConfig

local configuration

partition_info: Arc<PartitionInfo>

partition information generated by the config

thread_pool: Arc<ThreadPool>

thread pool used to execute async functions in parallel

last_solve_start_time: ArcRwLock<Instant>

the time of calling PrimalModuleParallel::parallel_solve_step_callback method

Implementations

impl PrimalModuleParallel

pub fn new_config( initializer: &SolverInitializer, partition_info: &PartitionInfo, config: PrimalModuleParallelConfig, ) -> Self

recommended way to create a new instance, given a customized configuration

impl PrimalModuleParallel

pub fn parallel_solve<DualSerialModule: DualModuleImpl + Send + Sync>( &mut self, syndrome_pattern: &SyndromePattern, parallel_dual_module: &DualModuleParallel<DualSerialModule>, )

pub fn parallel_solve_visualizer<DualSerialModule: DualModuleImpl + Send + Sync + FusionVisualizer>( &mut self, syndrome_pattern: &SyndromePattern, parallel_dual_module: &DualModuleParallel<DualSerialModule>, visualizer: Option<&mut Visualizer>, )

pub fn parallel_solve_step_callback<DualSerialModule: DualModuleImpl + Send + Sync, F>( &mut self, syndrome_pattern: &SyndromePattern, parallel_dual_module: &DualModuleParallel<DualSerialModule>, callback: F, )

where F: FnMut(&DualModuleInterfacePtr, &DualModuleParallelUnit<DualSerialModule>, &PrimalModuleSerialPtr, Option<&GroupMaxUpdateLength>) + Send + Sync,

Trait Implementations

impl FusionVisualizer for PrimalModuleParallel

fn snapshot(&self, abbrev: bool) -> Value

take a snapshot, set abbrev to true to save space

impl PrimalModuleImpl for PrimalModuleParallel

fn new_empty(initializer: &SolverInitializer) -> Self

create a primal module given the dual module

fn clear(&mut self)

clear all states; however this method is not necessarily called when load a new decoding problem, so you need to call it yourself

fn load_defect_dual_node(&mut self, _dual_node_ptr: &DualNodePtr)

fn resolve<D: DualModuleImpl>( &mut self, _group_max_update_length: GroupMaxUpdateLength, _interface: &DualModuleInterfacePtr, _dual_module: &mut D, )

analyze the reason why dual module cannot further grow, update primal data structure (alternating tree, temporary matches, etc) and then tell dual module what to do to resolve these conflicts; note that this function doesn’t necessarily resolve all the conflicts, but can return early if some major change is made. when implementing this function, it’s recommended that you resolve as many conflicts as possible.

fn intermediate_matching<D: DualModuleImpl>( &mut self, interface: &DualModuleInterfacePtr, dual_module: &mut D, ) -> IntermediateMatching

return a matching that can possibly include blossom nodes: this does not affect dual module

fn generate_profiler_report(&self) -> Value

performance profiler report

fn load_defect<D: DualModuleImpl>( &mut self, defect_vertex: VertexIndex, interface_ptr: &DualModuleInterfacePtr, dual_module: &mut D, )

load a single syndrome and update the dual module and the interface

fn load(&mut self, interface_ptr: &DualModuleInterfacePtr)

load a new decoding problem given dual interface: note that all nodes MUST be syndrome node

fn perfect_matching<D: DualModuleImpl>( &mut self, interface: &DualModuleInterfacePtr, dual_module: &mut D, ) -> PerfectMatching

break down the blossoms to find the final matching; this function will take more time on the dual module

fn solve<D: DualModuleImpl>( &mut self, interface: &DualModuleInterfacePtr, syndrome_pattern: &SyndromePattern, dual_module: &mut D, )

fn solve_visualizer<D: DualModuleImpl + FusionVisualizer>( &mut self, interface: &DualModuleInterfacePtr, syndrome_pattern: &SyndromePattern, dual_module: &mut D, visualizer: Option<&mut Visualizer>, )

where Self: FusionVisualizer + Sized,

fn solve_step_callback<D: DualModuleImpl, F>( &mut self, interface: &DualModuleInterfacePtr, syndrome_pattern: &SyndromePattern, dual_module: &mut D, callback: F, )

where F: FnMut(&DualModuleInterfacePtr, &mut D, &mut Self, &GroupMaxUpdateLength),

fn solve_step_callback_interface_loaded<D: DualModuleImpl, F>( &mut self, interface: &DualModuleInterfacePtr, dual_module: &mut D, callback: F, )

where F: FnMut(&DualModuleInterfacePtr, &mut D, &mut Self, &GroupMaxUpdateLength),