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 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
//! Return a digraph's indegree sequence.
//!
//! The indegree sequence is an iterator over the indegrees of the vertices of
//! a digraph.
//!
//! # Examples
//!
//! ```
//! use graaf::{
//! adjacency_list::Digraph,
//! gen::Empty,
//! op::{
//! AddArc,
//! IndegreeSequence,
//! },
//! };
//!
//! let mut digraph = Digraph::empty(3);
//!
//! digraph.add_arc(0, 1);
//! digraph.add_arc(0, 2);
//! digraph.add_arc(1, 2);
//! digraph.add_arc(2, 0);
//!
//! assert!(digraph.indegree_sequence().eq([1, 1, 2]));
//! ```
use super::{
Indegree,
Vertices,
};
/// Return a digraph's indegree sequence.
///
/// # Implementing `IndegreeSequence`
///
/// Provide an implementation of `IndegreeSequence` that returns the indegree
/// sequence of the digraph OR implement `Indegree` and `Vertices`.
///
/// ```
/// use {
/// graaf::op::{
/// Indegree,
/// IndegreeSequence,
/// Vertices,
/// },
/// std::collections::BTreeSet,
/// };
///
/// struct Digraph {
/// arcs: Vec<BTreeSet<usize>>,
/// }
///
/// impl Indegree for Digraph {
/// fn indegree(&self, v: usize) -> usize {
/// self.arcs.iter().filter(|set| set.contains(&v)).count()
/// }
/// }
///
/// impl Vertices for Digraph {
/// fn vertices(&self) -> impl Iterator<Item = usize> {
/// 0..self.arcs.len()
/// }
/// }
///
/// let mut digraph = Digraph {
/// arcs: vec![
/// BTreeSet::from([1, 2]),
/// BTreeSet::from([2]),
/// BTreeSet::from([0]),
/// ],
/// };
///
/// assert!(digraph.indegree_sequence().eq([1, 1, 2]));
/// ```
///
/// # Examples
///
/// ```
/// use graaf::{
/// adjacency_list::Digraph,
/// gen::Empty,
/// op::{
/// AddArc,
/// IndegreeSequence,
/// },
/// };
///
/// let mut digraph = Digraph::empty(3);
///
/// digraph.add_arc(0, 1);
/// digraph.add_arc(0, 2);
/// digraph.add_arc(1, 2);
/// digraph.add_arc(2, 0);
///
/// assert!(digraph.indegree_sequence().eq([1, 1, 2]));
/// ```
pub trait IndegreeSequence {
/// Returns the indegree sequence of the digraph.
#[must_use]
fn indegree_sequence(&self) -> impl Iterator<Item = usize>;
}
impl<D> IndegreeSequence for D
where
D: Indegree + Vertices,
{
fn indegree_sequence(&self) -> impl Iterator<Item = usize> {
self.vertices().map(move |v| self.indegree(v))
}
}