Struct Graph

Source

pub struct Graph { /* private fields */ }

Implementations§

Source §

impl Graph

Source

pub fn new() -> Graph

Creates an empty graph structure.

Source

pub fn from_str(&mut self, graph_config: &str)

Appends graph structure elements from a graph configuration.

§Example

use dynalgo::graph::Graph;

let config = "A, B, A - B 0";
let mut graph = Graph::new();
graph.from_str(config);

assert!(graph.nodes() == vec!['A', 'B']);

Source

pub fn add_node(&mut self, name: char, xy: Option<(i16, i16)>)

Adds a node to the graph structure, with an optional (x,y) freezed position (freezed coords of the element representation in SVG context). So the (x,y) position won’t change when automatic layout algo runs.

Source

pub fn delete_node(&mut self, node: char)

Deletes a node from the graph structure.

Source

pub fn add_link( &mut self, node_from: char, node_to: char, bidirectional: bool, value: i8, )

Adds a link between two nodes. The link can be defined as bidirectional or not.

Source

pub fn delete_link(&mut self, node_from: char, node_to: char)

Deletes a link.

Source

pub fn links(&self) -> Vec<(char, char)>

Returns the links names list.

Source

pub fn nodes(&self) -> Vec<char>

Returns the nodes names list.

Source

pub fn adjacency_list(&self) -> BTreeMap<char, BTreeMap<char, i8>>

Returns the adjacency list.

§Example

use dynalgo::graph::Graph;

let config = "A
              B
              A - B 0";
let mut graph = Graph::new();
graph.from_str(config);

for (node_from, neighbors) in graph.adjacency_list() {
    for (node_to, link_value) in neighbors {
        println!("Can go from {} to {} (link value is {}).", node_from, node_to, link_value);
    }
}

Source

pub fn directed(&self) -> bool

Returns True if the graph is directed

Source

pub fn adjacency_matrix(&self) -> BTreeMap<char, BTreeMap<char, Option<i8>>>

Returns the adjacency matrix.

§Example

use dynalgo::graph::Graph;

let config = "A
              B
              A - B 0";
let mut graph = Graph::new();
graph.from_str(config);

let adjacency_matrix = graph.adjacency_matrix();
for node_from in graph.nodes().iter() {
    for node_to in graph.nodes().iter() {
        let link_value = adjacency_matrix[&node_from][&node_to];
        if link_value.is_some() {
            println!("Can go from {} to {} (link value is {}).", node_from, node_to, link_value.unwrap());
        }
    }
}

Source

pub fn neighbors(&self, node: char) -> Vec<char>

Returns accessible nodes.

§Example

use dynalgo::graph::Graph;

let config = "A
              B
              A - B 0";
let mut graph = Graph::new();
graph.from_str(config);

for neighbor in graph.neighbors('A') {
    println!("Can go from 'A' to {}.", neighbor);
}

Source

pub fn swap_nodes(&mut self, node_1: char, node_2: char)

Swap two nodes in the graph structure and its graphic representation.

Source

pub fn resume(&mut self)

Reactivates the auto animation option. When this option is activated, each graph structure change causes graphic animation (the animations are rendered one after the other). By default, the option is activated when a graph is created. When this option is deactivated, all pending animations occur during the same period (i.e. not one after the other) when you manually call the anim_step() or anim_resume()functions.

Source

pub fn pause(&mut self)

Deactivates the auto animation option.

Source

pub fn step(&mut self, duration_ms: u32)

Creates an animation that show the evolution between the last represented state (when anim_pause() function was called previously) and the current state. The pending animations are rendered simultaneously (i.e. not one after the other). The anim_pause() function must have been called previously. After calling anim_step() function, auto animation option still is deactivated.

Source

pub fn sleep(&mut self, duration_ms: u32)

Delay the next animation.

Source

pub fn paused(&self) -> bool

Indicates whether the animation is paused or not

Source

pub fn render(&self, html_file_name: &str) -> Result<(), Error>

Renders the graph animation in SVG SMIL format into a HTML file.

Source

pub fn to_html(pages: Vec<(&str, Vec<&Graph>)>) -> Result<(), Error>

Renders graphs animations in SVG SMIL format into multiple HTML files. Each HTML page contains a menu to access other pages (if there is more than one page).

Source