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
//! Return the number of vertices in a digraph.
//!
//! # Examples
//!
//! ```
//! use graaf::{
//!     adjacency_list::Digraph,
//!     gen::Empty,
//!     op::Order,
//! };
//!
//! let digraph = Digraph::empty(4);
//!
//! assert_eq!(digraph.order(), 4);
//! ```
/// Return the number of vertices in a digraph.
///
/// # How can I implement `Order`?
///
/// Provides an implementation of `order` that returns the number of vertices
/// in the digraph.
///
/// ```
/// use graaf::op::Order;
///
/// struct Digraph {
///     vertices: Vec<usize>,
/// }
///
/// impl Order for Digraph {
///     fn order(&self) -> usize {
///         self.vertices.len()
///     }
/// }
/// ```
///
/// # Examples
///
/// ```
/// use graaf::{
///     adjacency_list::Digraph,
///     gen::Empty,
///     op::Order,
/// };
///
/// let digraph = Digraph::empty(4);
///
/// assert_eq!(digraph.order(), 4);
/// ```
pub trait Order {
    /// Counts the vertices in the digraph.
    #[must_use]
    fn order(&self) -> usize;
}