Struct PrimalModuleSerial 

pub struct PrimalModuleSerial {
    pub unit_index: usize,
    pub nodes: Vec<Option<PrimalNodeInternalPtr>>,
    pub nodes_length: usize,
    pub is_fusion: bool,
    pub possible_break: Vec<NodeIndex>,
    pub debug_resolve_only_one: bool,
    pub parent: Option<PrimalModuleSerialWeak>,
    pub index_bias: NodeIndex,
    pub children: Option<((PrimalModuleSerialWeak, NodeNum), (PrimalModuleSerialWeak, NodeNum))>,
    pub max_tree_size: usize,
}

Fields

unit_index: usize

unit index of this interface, default to 0

nodes: Vec<Option<PrimalNodeInternalPtr>>

nodes internal information

nodes_length: usize

current nodes length, to enable constant-time clear operation

is_fusion: bool

allow pointer reuse will reduce the time of reallocation, but it’s unsafe if not owning it

possible_break: Vec<NodeIndex>

the indices of primal nodes that is possibly matched to the mirrored vertex, and need to break when mirrored vertices are no longer mirrored

debug_resolve_only_one: bool

debug mode: only resolve one conflict each time

parent: Option<PrimalModuleSerialWeak>

the parent of this serial module, when fused

index_bias: NodeIndex

when fused, this will indicate the relative bias given by the parent

children: Option<((PrimalModuleSerialWeak, NodeNum), (PrimalModuleSerialWeak, NodeNum))>

the two children of this serial module, when fused; following the length of this child, given that fused children serial modules will not have new nodes anymore

max_tree_size: usize

the maximum number of children in a tree before it collapses to a union-find decoder

Implementations

impl PrimalModuleSerial

pub fn nodes_count(&self) -> NodeNum

return the count of all nodes including those of the children interfaces

pub fn get_node( &self, relative_node_index: NodeIndex, ) -> Option<PrimalNodeInternalPtr>

get node ptr by index; if calling from the ancestor module, node_index is absolute, otherwise it’s relative

pub fn remove_node(&mut self, relative_node_index: NodeIndex)

set the corresponding node index to None

Trait Implementations

impl Debug for PrimalModuleSerial

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

Formats the value using the given formatter.