Struct avatar_graph::Graph

pub struct Graph {
    pub nodes: Vec<Node>,
    pub edges: Vec<(usize, usize)>,
}

Represents an Avatar Graph.

Fields

nodes: Vec<Node>

Stores nodes.

edges: Vec<(usize, usize)>

Stores edges between nodes.

Implementations

impl Graph

pub fn new() -> Graph

Creates a new empty graph.

pub fn add_node(&mut self, node: Node) -> usize

Adds a new node.

pub fn add_edge(&mut self, a: usize, b: usize) -> usize

Adds a new edge.

pub fn cores(&self) -> usize

Counts the number of cores.

pub fn non_cores(&self) -> usize

Counts the number of non-cores.

pub fn edges_of(&self, node: usize) -> Vec<usize>

Returns a list of nodes connected by edges of a node.

pub fn unique_edges(&self) -> usize

Counts the number of unique edges.

pub fn self_unique_edges(&self) -> usize

Counts the number of self unique edges.

pub fn remove_self_unique_edges(&mut self)

REmoves all self unique edges.

pub fn self_edges(&self) -> usize

Counts the number of self edges.

pub fn remove_self_edges(&mut self)

Removes all self edges.

pub fn matrix(&self) -> Vec<Vec<u8>>

Returns a matrix representation of the graph.

• 0 means there is no edge.
• 1 means there is an edge.
• 2 means there is a unique edge.
• 3 means there is an edge and a unique edge.

pub fn distance(
    &self,
    ind: usize
) -> Result<Vec<(usize, u64)>, Vec<(usize, u64)>>

Assigns each node a distance number from a particular node.

Returns Ok if the entire graph is connected. Returns Err if there is some node that is disconnected.

pub fn avatar_distance(&self, ind: usize) -> Vec<(usize, u64)>

Returns avatar distances of nodes from a core node.

The avatar distance is greater or equal to shortest distance. An avatar distance for a node is the sum of avatar distances of its children, which have shorter or equal distance to the core.

The avatar distance is also the number of paths to the core self.

pub fn max_avatars(&self, ind: usize) -> (u64, Vec<usize>)

Returns a list of maximum avatars and their maximum avatar distance.

pub fn contractible(&self, ind: usize) -> usize

Returns the nodes that are contractible.

A node is contractible if it has only one children with shorter distance to core. However, nodes that are directly connected to core are not counted.

pub fn contractibles_of(&self, ind: usize) -> Vec<usize>

Returns the contractible nodes relative to a core.

pub fn swap(&mut self, a: usize, b: usize)

Swaps two nodes.

pub fn along(&self, a: usize, b: usize) -> Result<Vec<usize>, ()>

Returns nodes that are visited when walking from a to b with decreasing shortest distance.

pub fn all_reachable_along(&self, a: usize, b: usize) -> bool

Returns true if all nodes are reachable from a to b when walking along the gradient of shortest distances.

pub fn avatar_connectivity(&self, ind: usize) -> bool

Returns true if a graph has correct avatar connectivity.

pub fn avatar_connectivity_failures_of(&self, ind: usize) -> Vec<usize>

Returns a list of nodes which have wrong avatar connectivity.

pub fn is_avatar_graph(&self, ind: usize) -> bool

Returns true if the graph is an Avatar Graph seen from a core.

pub fn corify(&mut self)

Marks all nodes as core that can be a core, unmarks all nodes that can not be a core.

Trait Implementations

impl Clone for Graph

fn clone(&self) -> Graph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Graph

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

Formats the value using the given formatter.