Struct ratio_graph::Graph

pub struct Graph {
    pub id: Uuid,
    pub name: String,
    pub kind: String,
    pub labels: Vec<String>,
    pub weights: HashMap<String, f64>,
    pub annotations: HashMap<String, String>,
    pub nodes: HashMap<Uuid, Node>,
    pub edges: HashMap<Uuid, Edge>,
    /* private fields */
}

Fields

id: Uuid

Unique instance ID.

name: String

Instance name.

kind: String

Main category of this instance.

labels: Vec<String>

Instance labels.

weights: HashMap<String, f64>

Numeric instance weights.

annotations: HashMap<String, String>

Miscellaneous data fields for this instance.

nodes: HashMap<Uuid, Node>

Nodes by their IDs.

edges: HashMap<Uuid, Edge>

Edges by their IDs.

Implementations

impl Graph

pub fn new(
    id: Option<Uuid>,
    name: Option<String>,
    kind: Option<String>,
    labels: Option<Vec<String>>,
    weights: Option<HashMap<String, f64>>,
    annotations: Option<HashMap<String, String>>,
    nodes: Option<Vec<Node>>,
    edges: Option<Vec<Edge>>
) -> Self

Create a new graph instance with arguments.

pub fn default() -> Self

Create a new graph instance with default arguments.

pub fn update_edges_forward(&mut self)

Update the forward edge map..

pub fn update_edges_reverse(&mut self)

Update the reverse edge map..

pub fn update_edge_maps(&mut self)

Update edge maps.

pub fn has_node(&self, id: &Uuid) -> bool

Whether a node ID exists in the graph.

pub fn has_edge(&self, id: &Uuid) -> bool

Whether an edge ID exists in the graph.

pub fn add_node(&mut self, node: Node, safe: bool)

Add a single node.

pub fn add_nodes(&mut self, nodes: Vec<Node>, safe: bool)

Add multiple nodes.

pub fn check_node(&self, id: &Uuid)

Check whether a node’s references exist.

pub fn set_parent(&mut self, child_id: &Uuid, parent_id: Option<&Uuid>)

Set parent value for a node.

pub fn set_bus(&mut self, child_id: &Uuid, is_bus: bool)

Set the is_bus value of a node. Will only ever be set to true is it has a parent node to be a bus for.

pub fn add_edge(&mut self, edge: Edge, safe: bool)

Add a single edge.

pub fn add_edges(&mut self, edges: Vec<Edge>, safe: bool)

Add multiple edges.

pub fn check_edge(&self, id: &Uuid)

Check whether an edge’s references exist.

pub fn get_adjacency_matrix(
    &self,
    sources: Option<Vec<Uuid>>,
    targets: Option<Vec<Uuid>>,
    aggregator: &Aggregator,
    fields: Option<&HashSet<String>>
) -> DMatrix<f64>

Get the adjacency matrix for this graph.

Trait Implementations

impl Debug for Graph

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Graph

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Metadata for Graph

fn get_meta(&self) -> Meta

impl Serialize for Graph

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.