Struct DualModuleInterface 

pub struct DualModuleInterface {
    pub unit_index: usize,
    pub nodes: Vec<Option<DualNodePtr>>,
    pub nodes_length: usize,
    pub is_fusion: bool,
    pub sum_grow_speed: Weight,
    pub sum_dual_variables: Weight,
    pub debug_print_actions: bool,
    pub parent: Option<DualModuleInterfaceWeak>,
    pub index_bias: NodeIndex,
    pub children: Option<((DualModuleInterfaceWeak, NodeIndex), (DualModuleInterfaceWeak, NodeIndex))>,
    /* private fields */
}

a sharable array of dual nodes, supporting dynamic partitioning; note that a node can be destructed and we do not reuse its index, leaving a blank space

Fields

unit_index: usize

unit index of this interface, default to 0

nodes: Vec<Option<DualNodePtr>>

all the dual node that can be used to control a concrete dual module implementation

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; this will be automatically disabled when [DualModuleInterface::fuse] is called; if an interface is involved in a fusion operation (whether as parent or child), it will be set.

sum_grow_speed: Weight

record the total growing nodes, should be non-negative in a normal running algorithm

sum_dual_variables: Weight

record the total sum of dual variables

debug_print_actions: bool

debug mode: only resolve one conflict each time

parent: Option<DualModuleInterfaceWeak>

the parent of this interface, when fused

index_bias: NodeIndex

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

children: Option<((DualModuleInterfaceWeak, NodeIndex), (DualModuleInterfaceWeak, NodeIndex))>

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

Implementations

impl DualModuleInterface

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<DualNodePtr>

get node ptr by index; if calling from the ancestor interface, 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 DualModuleInterface

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

Formats the value using the given formatter.