Struct ratio_graph::graph::Graph

pub struct Graph {
    pub metadata: Metadata,
    pub nodes: NodeStoreData,
    pub edges: EdgeStoreData,
}

Fields

metadata: Metadata

Instance metadata.

nodes: NodeStoreData

Node store.

edges: EdgeStoreData

Edge store.

Implementations

impl Graph

pub fn new( metadata: Option<Metadata>, nodes: Vec<Node>, edges: Vec<Edge> ) -> Result<Self, Error>

impl Graph

pub fn mdm_axis_nodes( &self, node_filter: MetadataFilter, edge_filter: MetadataFilter, root_ids: Option<&Vec<Uuid>>, node_depth: Option<usize>, node_selection_mode: NodeSelectionMode ) -> Result<Vec<Uuid>, Error>

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.

impl Default for Graph

fn default() -> Graph

Returns the “default value” for a type.

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 EdgeStore for Graph

fn edges_len(&self) -> usize

fn is_edges_empty(&self) -> bool

fn add_edge<N: NodeStore>( &mut self, edge: Edge, safe: bool, nodes: Option<&N> ) -> Result<Option<Edge>, Error>

fn extend_edges<N: NodeStore>( &mut self, edges: Vec<Edge>, safe: bool, nodes: Option<&N> ) -> Result<Vec<Edge>, Error>

fn check<N: NodeStore>(&self, edge: &Edge, nodes: &N) -> Result<(), Error>

fn del(&mut self, id: &Uuid) -> Option<Edge>

fn get_edge(&self, id: &Uuid) -> Option<&Edge>

fn all_edges(&self) -> Vec<&Edge>

fn edge_ids_between(&self, source: &Uuid, target: &Uuid) -> HashSet<Uuid>

fn edges_between(&self, source: &Uuid, target: &Uuid) -> Vec<&Edge>

fn edge_ids_between_all( &self, sources: &HashSet<Uuid>, targets: &HashSet<Uuid> ) -> HashSet<Uuid>

fn edges_between_all( &self, sources: &HashSet<Uuid>, targets: &HashSet<Uuid> ) -> Vec<&Edge>

fn aggregate_between(&self, source: &Uuid, target: &Uuid) -> Aggregate

fn aggregate_between_all( &self, sources: HashSet<Uuid>, targets: HashSet<Uuid> ) -> Aggregate

fn outgoing_ids_from(&self, source: &Uuid) -> HashSet<Uuid>

fn outgoing_edges_from(&self, source: &Uuid) -> Vec<&Edge>

fn incoming_ids_to(&self, target: &Uuid) -> HashSet<Uuid>

fn incoming_edges_to(&self, target: &Uuid) -> Vec<&Edge>

fn targets_of(&self, source: &Uuid) -> HashSet<Uuid>

fn sources_to(&self, target: &Uuid) -> HashSet<Uuid>

fn is_connected_to( &self, node: &Uuid, others: &HashSet<Uuid>, edge_ids: Option<&HashSet<Uuid>> ) -> bool

fn get_aggregate_value( &self, source: &Uuid, target: &Uuid, aggregator: &Aggregator, fields: Option<&HashSet<String>> ) -> f64

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

impl HasEdgeStore for Graph

fn edge_store(&self) -> &EdgeStoreData

fn edge_store_mut(&mut self) -> &mut EdgeStoreData

impl HasNodeStore for Graph

fn node_store(&self) -> &NodeStoreData

fn node_store_mut(&mut self) -> &mut NodeStoreData

impl Meta for Graph

fn get_meta(&self) -> &Metadata

fn id(&self) -> &Uuid

fn name(&self) -> &String

fn kind(&self) -> &String

fn labels(&self) -> &HashSet<String>

fn weights(&self) -> &HashMap<String, f64>

fn annotations(&self) -> &HashMap<String, Value>

impl NodeStore for Graph

fn nodes_len(&self) -> usize

The number of nodes in this store.

fn is_nodes_empty(&self) -> bool

Whether this node store is empty.

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

Check whether this store contains a node with the given node ID.

fn add_node(&mut self, node: Node, safe: bool) -> Result<Option<Node>, Error>

Add a single node to this store. Setting ‘safe’ checks whether this node’s references exist and detects cyclic hierarchies.

fn extend_nodes( &mut self, nodes: Vec<Node>, safe: bool ) -> Result<Vec<Node>, Error>

Extend this node store with new nodes. Setting ‘safe’ checks whether all node references exist and detects cyclic hierarchies after adding them to the store first.

fn check_node(&self, node: &Node) -> Result<(), Error>

Check whether a node’s references exist and it doesn’t partake in cyclic hierarchies.

fn get_node(&self, id: &Uuid) -> Option<&Node>

Get a reference to a node.

fn get_node_err(&self, id: &Uuid) -> Result<&Node, Error>

Get a reference to a node as as result.

fn get_node_mut(&mut self, node_id: &Uuid) -> Option<&mut Node>

Get a mutable reference to a node.

fn del_node(&mut self, node_id: &Uuid) -> Option<Node>

Delete node from this store.

fn all_node_ids(&self) -> Vec<&Uuid>

Get all node IDs in this store.

fn all_nodes(&self) -> Vec<&Node>

Get all node IDs in this store.

fn root_ids(&self) -> Vec<&Uuid>

Get all root node IDs in this store.

fn root_nodes(&self) -> Vec<&Node>

Get all root nodes in this store.

fn leaf_ids(&self) -> Vec<&Uuid>

Get all leaf node IDs in this store.

fn leaf_nodes(&self) -> Vec<&Node>

Get all leaf nodes in this store.

fn set_parent( &mut self, child_id: &Uuid, parent_id: Option<&Uuid> ) -> Result<(), Error>

Set a new parent value for the given child ID. Returns an error if the child node does not exist in the store. Setting the parent ID to None removes the parent-child relationship.

fn set_bus(&mut self, node_id: &Uuid, is_bus: bool) -> Result<(), Error>

Set the is_bus value of a given node ID.

fn bus_ids(&self, parent_id: &Uuid) -> Result<Vec<&Uuid>, Error>

Get the bus node IDs that fall directly under the given parent ID.

fn bus_nodes(&self, parent_id: &Uuid) -> Result<Vec<&Node>, Error>

Get the bus nodes that fall directly under the given parent ID.

fn ascendant_ids( &self, node_id: &Uuid, safe: bool, only_root: bool, root_ids: Option<&HashSet<Uuid>>, height: Option<usize> ) -> Result<Vec<&Uuid>, Error>

Get ascendant node IDs of a given node. Setting safe checks for cyclic hierarchies along the way. only_root only includes the final root node. root_ids are nodes to consider as (additional) root nodes in this query. height determines the maximum height at which the ancestor is considered a root node.

fn ascendant_nodes( &self, node_id: &Uuid, safe: bool, only_root: bool, root_ids: Option<&HashSet<Uuid>>, height: Option<usize> ) -> Result<Vec<&Node>, Error>

Get ascendant nodes of a given node. Setting safe checks for cyclic hierarchies along the way. only_root only includes the final root node. root_ids are nodes to consider as (additional) root nodes in this query. height determines the maximum height at which the ancestor is considered a root node.

fn node_depth( &self, node_id: &Uuid, safe: bool, root_ids: Option<&HashSet<Uuid>>, height: Option<usize> ) -> Result<usize, Error>

Node depth (i.e. the number of levels that exist above). Setting safe checks for cyclic hierarchies along the way. root_ids are nodes to consider as (additional) root nodes in this query. height determines the maximum height at which the ancestor is considered a root node.

fn descendant_ids( &self, node_id: &Uuid, safe: bool, only_leaf: bool, leaf_ids: Option<&HashSet<Uuid>>, depth: Option<usize> ) -> Result<Vec<&Uuid>, Error>

Get the descendant node IDs of a given node. Setting safe checks for cyclic hierarchies. Setting only_leaf only includes only absolute or specified leaf nodes in the result. leaf_ids restricts the search at the given node IDs, disallowing it from going any further. depth specifies the maximum depth at which nodes are also considered leaf nodes for this search.

fn descendant_nodes( &self, node_id: &Uuid, safe: bool, only_leaf: bool, leaf_ids: Option<&HashSet<Uuid>>, depth: Option<usize> ) -> Result<Vec<&Node>, Error>

Get the descendant nodes of a given node. Setting safe checks for cyclic hierarchies. Setting only_leaf only includes only absolute or specified leaf nodes in the result. leaf_ids restricts the search at the given node IDs, disallowing it from going any further. depth specifies the maximum depth with respect to the given node ID to search at.

fn node_height( &self, node_id: &Uuid, safe: bool, depth: Option<usize>, leaf_ids: Option<&HashSet<Uuid>> ) -> Result<usize, Error>

Node height (i.e. the number of levels that exist below). Setting safe checks for cyclic hierarchies. leaf_ids restricts the search at the given node IDs, disallowing it from going any further. depth specifies the maximum depth with respect to the given node ID to search at.

fn node_width( &self, node_id: &Uuid, safe: bool, leaf_ids: Option<&HashSet<Uuid>>, depth: Option<usize> ) -> Result<usize, Error>

Node width in terms of (optionally specified) leaf nodes. Setting safe checks for cyclic hierarchies. leaf_ids restricts the search at the given node IDs, disallowing it from going any further. depth specifies the maximum depth with respect to the given node ID to search at.

impl PartialEq<Graph> for Graph

fn eq(&self, other: &Graph) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for Graph