Struct igraph::IndexedGraph [−][src]
A node in the graph is identified by the key. Keys are stored in the order they were inserted, a redundant copy is stored in the index. Values don’t have this redundancy. There could be more than one values for a key.
Implementations
impl<K: Ord + Clone, V> IndexedGraph<K, V>
[src]
pub fn new() -> IndexedGraph<K, V>
[src]
Makes a new, empty IndexedGraph
.
Examples
use std::collections::BTreeMap; let mut map = BTreeMap::<u8,u8>::new(); assert_eq!(core::mem::size_of::<BTreeMap<u8,u8>>(), 24); assert_eq!(core::mem::size_of_val(&map), 24); use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); assert_eq!(core::mem::size_of::<IndexedGraph<u8,u8>>(), 96); assert_eq!(core::mem::size_of_val(&graph), 96); // entries can now be inserted into the empty graph graph.insert(1, "a");
pub fn clear(&mut self)
[src]
Clears the graph, removing all elements.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(1, "a"); graph.clear(); // assert!(graph.is_empty());
pub fn get(&self, key: &K) -> Vec<&V>
[src]
Returns a reference to the values corresponding to the key.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(1, "a"); assert_eq!(graph.get(&1), vec![&"a"]); assert_eq!(graph.get(&2), Vec::<&&str>::new());
pub fn get_key_values(&self, key: &K) -> Vec<(&K, &V)>
[src]
Returns the key-value pairs corresponding to the supplied key.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(1, "a"); assert_eq!(graph.get_key_values(&1), vec![(&1, &"a")]); assert_eq!(graph.get_key_values(&2), vec![]);
pub fn first_key_value(&self) -> Option<(&K, &V)>
[src]
Returns the first key-value pair in the graph. The key in this pair is the minimum key in the graph.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); assert_eq!(graph.first_key_value(), None); graph.insert(1, "b"); graph.insert(2, "a"); assert_eq!(graph.first_key_value(), Some((&1, &"b")));
pub fn pop_first(&mut self) -> Option<(K, V)>
[src]
Removes and returns the first element in the graph. The key of this element is the key first inserted into the graph.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(1, "a"); graph.insert(2, "b"); while let Some((key, _val)) = graph.pop_first() { assert!(graph.iter().all(|(k, _v)| *k > key)); } for item in graph.iter() { assert!(*item.0 < 3); assert!(*item.1 == "a" || *item.1 == "b"); } assert!(graph.is_empty());
pub fn last_key_value(&self) -> Option<(&K, &V)>
[src]
Returns the last key-value pair in the graph. The key in this pair is last inserted in the graph.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(1, "b"); graph.insert(2, "a"); assert_eq!(graph.last_key_value(), Some((&2, &"a")));
pub fn pop_last(&mut self) -> Option<(K, V)>
[src]
Removes and returns the last element in the graph. The key of this element is the last inserted in the graph.
Examples
Draining elements in descending order, while keeping a usable graph each iteration.
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(1, "a"); graph.insert(2, "b"); while let Some((key, _val)) = graph.pop_last() { assert!(graph.iter().all(|(k, _v)| *k < key)); } assert!(graph.is_empty());
pub fn contains_key(&self, key: &K) -> bool
[src]
Returns true
if the graph contains a value for the specified key using the internal index.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(1, "a"); assert_eq!(graph.contains_key(&1), true); assert_eq!(graph.contains_key(&2), false);
pub fn insert(&mut self, key: K, value: V) -> Option<&V>
[src]
Inserts a key-value pair into the graph.
If the graph did not have this key present, None
is returned.
If the graph did have this key present, the value is inserted after the existing one. Then the new value is returned. The key is not updated, only inserted the first time.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); assert_eq!(graph.insert(37, "a"), Some(&"a")); assert_eq!(graph.is_empty(), false); graph.insert(37, "b"); assert_eq!(graph.insert(37, "c"), Some(&"c")); //assert_eq!(graph[&37], "c");
pub fn insert_edge(&mut self, from: K, to: K) -> Option<(&K, &K)>
[src]
Inserts a key-value pair into the graph.
If the graph did not have this key present, None
is returned.
If the graph did have this key present, the value is inserted after the existing one. Then the new value is returned. The key is not updated, only inserted the first time.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); assert_eq!(graph.insert(37, "a"), Some(&"a")); assert_eq!(graph.insert(12, "b"), Some(&"b")); assert_eq!(graph.is_empty(), false); graph.insert_edge(12, 37); assert_eq!(graph.insert(37, "c"), Some(&"c")); //assert_eq!(graph[&37], "c");
pub fn len(&self) -> usize
[src]
Returns the number of elements in the graph.
Examples
use igraph::IndexedGraph; let mut a = IndexedGraph::new(); assert_eq!(a.len(), 0); a.insert(1, "a"); assert_eq!(a.len(), 1);
pub fn is_empty(&self) -> bool
[src]
Returns true
if the graph contains no elements.
Examples
use igraph::IndexedGraph; let mut a = IndexedGraph::new(); assert!(a.is_empty()); a.insert(1, "a"); assert!(!a.is_empty());
pub fn index_copy(&self) -> BTreeMap<K, Vec<usize>>
[src]
pub fn index(&self, key: K) -> Vec<&V>
[src]
Returns a Vec of references to the values corresponding to the supplied key.
Examples
use igraph::IndexedGraph; let mut a = IndexedGraph::new(); a.insert(1, "a"); assert_eq!(*a.index(1), [&"a"]);
pub fn iter(&self) -> Iter<'_, K, V>ⓘ
[src]
Gets an iterator over the entries of the graph, sorted by key.
IndexedGraph
preserves the order of insertion for iter()
.
Examples
use igraph::IndexedGraph; let mut graph = IndexedGraph::new(); graph.insert(3, "c"); graph.insert(2, "b"); graph.insert(1, "a"); for (key, value) in graph.iter() { println!("{}: {}", key, value); } let (first_key, first_value) = graph.iter().next().unwrap(); assert_eq!((*first_key, *first_value), (3, "c"));
Trait Implementations
impl<K: Clone, V: Clone> Clone for IndexedGraph<K, V>
[src]
fn clone(&self) -> IndexedGraph<K, V>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<K: Debug, V: Debug> Debug for IndexedGraph<K, V>
[src]
impl<'a, K: Ord + Clone, V> IntoIterator for &'a IndexedGraph<K, V>
[src]
Auto Trait Implementations
impl<K, V> RefUnwindSafe for IndexedGraph<K, V> where
K: RefUnwindSafe,
V: RefUnwindSafe,
K: RefUnwindSafe,
V: RefUnwindSafe,
impl<K, V> Send for IndexedGraph<K, V> where
K: Send,
V: Send,
K: Send,
V: Send,
impl<K, V> Sync for IndexedGraph<K, V> where
K: Sync,
V: Sync,
K: Sync,
V: Sync,
impl<K, V> Unpin for IndexedGraph<K, V> where
K: Unpin,
V: Unpin,
K: Unpin,
V: Unpin,
impl<K, V> UnwindSafe for IndexedGraph<K, V> where
K: RefUnwindSafe + UnwindSafe,
V: UnwindSafe,
K: RefUnwindSafe + UnwindSafe,
V: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,