Struct lib_dachshund::dachshund::typed_graph::TypedGraph

pub struct TypedGraph {
    pub nodes: HashMap<NodeId, Node>,
    pub core_ids: Vec<NodeId>,
    pub non_core_ids: Vec<NodeId>,
}

Keeps track of a bipartite graph composed of "core" and "non-core" nodes. Only core -> non-core connections may exist in the graph. The neighbors of core nodes are non-cores, the neighbors of non-core nodes are cores. Graph edges are stored in the neighbors field of each node. If the id of a node is known, its Node object can be retrieved via the nodes HashMap. To iterate over core and non-core nodes, the struct also provides the core_ids and non_core_ids vectors.

Fields

nodes: HashMap<NodeId, Node>

core_ids: Vec<NodeId>

non_core_ids: Vec<NodeId>

Trait Implementations

impl GraphBase for TypedGraph

fn get_core_ids(&self) -> &Vec<NodeId>

fn get_non_core_ids(&self) -> Option<&Vec<NodeId>>

fn get_mut_nodes(&mut self) -> &mut HashMap<NodeId, Node>

fn has_node(&self, node_id: NodeId) -> bool

fn get_node(&self, node_id: NodeId) -> &Node

fn count_edges(&self) -> usize

impl GraphBuilder<TypedGraph> for TypedGraphBuilder

fn _new(
    nodes: HashMap<NodeId, Node>,
    core_ids: Vec<NodeId>,
    non_core_ids: Vec<NodeId>
) -> CLQResult<TypedGraph>

fn init_nodes(
    core_ids: &[NodeId],
    non_core_ids: &[NodeId],
    non_core_type_ids: &HashMap<NodeId, NodeTypeId>
) -> HashMap<NodeId, Node>

fn populate_edges(
    rows: &[EdgeRow],
    node_map: &mut HashMap<NodeId, Node>
) -> CLQResult<()>

given a set of initialized Nodes, populates the respective neighbors fields appropriately.

fn trim_edges(
    node_map: &mut HashMap<NodeId, Node>,
    min_degree: &usize
) -> HashSet<NodeId>

Trims edges greedily, until all edges in the graph have degree at least min_degree. Note that this function does not delete any nodes -- just finds nodes to delete. It is called by prune, which actually does the deletion.

fn new(
    graph_id: GraphId,
    rows: &[EdgeRow],
    min_degree: Option<usize>
) -> CLQResult<TGraph>

creates a TGraph object from a vector of rows. Client must provide graph_id which must match with each row's graph_id. If min_degree is provided, the graph is additionally pruned.

fn prune(
    graph: TGraph,
    rows: &[EdgeRow],
    min_degree: usize
) -> CLQResult<TGraph>

Takes an already-built graph and the edge rows used to create it, returning a new graph, where all nodes are assured to have degree at least min_degree. The provision of a TGraph is necessary, since the notion of "degree" does not make sense outside of a graph.

fn get_filtered_sources_targets_rows(
    graph: TGraph,
    min_degree: usize,
    rows: &[EdgeRow]
) -> (Vec<NodeId>, Vec<NodeId>, Vec<EdgeRow>)

called by prune, finds source and target nodes to exclude, as well as edges to exclude when rebuilding the graph from a filtered vector of EdgeRows.