graphrs 0.11.16

graphrs is a Rust package for the creation, manipulation and analysis of graphs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

use super::Graph;
use crate::{Error, ErrorKind};
use std::fmt::Display;
use std::hash::Hash;

impl<T, A> Graph<T, A>
where
    T: Eq + Clone + PartialOrd + Ord + Hash + Send + Sync + Display,
    A: Clone,
{
    /// Returns an `Err` if the `graph` is not a directed graph.
    pub fn ensure_directed(&self) -> Result<(), Error>
    where
        T: Hash + Eq + Clone + Ord + Display + Send + Sync,
        A: Clone + Send + Sync,
    {
        if !self.specs.directed {
            return Err(Error {
                kind: ErrorKind::WrongMethod,
                message: "This method is not applicable to undirected graphs.".to_string(),
            });
        }
        Ok(())
    }

    /// Returns an `Err` if the `graph` is a directed graph.
    pub fn ensure_undirected(&self) -> Result<(), Error>
    where
        T: Hash + Eq + Clone + Ord + Display + Send + Sync,
        A: Clone + Send + Sync,
    {
        if self.specs.directed {
            return Err(Error {
                kind: ErrorKind::WrongMethod,
                message: "This method is not applicable to directed graphs.".to_string(),
            });
        }
        Ok(())
    }

    /// Returns an `Err` if the `graph` is not a directed graph.
    pub fn ensure_not_multi_edges(&self) -> Result<(), Error>
    where
        T: Hash + Eq + Clone + Ord + Display + Send + Sync,
        A: Clone + Send + Sync,
    {
        if self.specs.multi_edges {
            return Err(Error {
                kind: ErrorKind::WrongMethod,
                message: "This method is not applicable to multi-edge graphs.".to_string(),
            });
        }
        Ok(())
    }

    /// Returns an `Err` if the any of the `graph`'s edges do not have a weight.
    pub fn ensure_weighted(&self) -> Result<(), Error>
    where
        T: Hash + Eq + Clone + Ord,
        A: Clone,
    {
        if !self.edges_have_weight() {
            return Err(Error {
                kind: ErrorKind::EdgeWeightNotSpecified,
                message: "Not all edges in the graph have a weight.".to_string(),
            });
        }
        Ok(())
    }
}