Graph

Struct Graph 

Source
pub struct Graph { /* private fields */ }
Expand description

Represents the graph on which SCC decomposition will be done. Consists of Nodes, connected by directed edges.

let mut graph = Graph::new();
let v0 = graph.new_node();
let v1 = graph.new_node();
let v2 = graph.new_node();
let v3 = graph.new_node();
graph.new_edge(v0, v1);
graph.new_edge(v1, v3);
graph.new_edge(v1, v1);
// Graph looks like this:
// ┌───┐  ┌───┐  ┌───┐ ┌───┐
// │ 0 ├─►│ 1 ├─►│ 3 │ │ 2 │
// └───┘  └▲─┬┘  └───┘ └───┘
//         └─┘

Implementations§

Source§

impl Graph

Source

pub fn new() -> Self

Creates an empty graph with no nodes and no edges. Nodes can be added by calling Graph::new_node. Edges can be added by calling Graph::new_edge.

Source

pub fn new_node(&mut self) -> Node

Creates a new node of the graph with no incoming/outgoing edges. Edges can be added by calling Graph::new_edge.

Source

pub fn new_edge(&mut self, from: Node, to: Node)

Creates a new directed edge between two nodes.

Source

pub fn find_sccs(&self) -> SccDecomposition

Computes the Strongly Connected Components decomposition of this graph. Uses Tarjan’s algorithm which runs in O(|N| + |E|) time and uses O(|N| + |E|) memory.

Source

pub fn len(&self) -> usize

Returns the number of nodes in this graph.

Source

pub fn is_empty(&self) -> bool

Returns true if the graph has no nodes.

Source

pub fn iter_nodes(&self) -> impl Iterator<Item = Node>

Iterates over all nodes that belong to this graph, in no particular order.

Source

pub fn iter_successors(&self, node: Node) -> impl Iterator<Item = Node>

Iterates over all successors of the given node, in no particular order.

Trait Implementations§

Source§

impl Clone for Graph

Source§

fn clone(&self) -> Graph

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Graph

Source§

fn default() -> Graph

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Graph

§

impl RefUnwindSafe for Graph

§

impl Send for Graph

§

impl Sync for Graph

§

impl Unpin for Graph

§

impl UnwindSafe for Graph

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.