crates/algorithms/src/shortest_paths/astar/measure.rs

use numi::num::{identity::Zero, ops::AddRef};

/// Automatically implemented trait for types that can be used as a measure in the Dijkstra
///
/// This trait is implemented for all types that implement the supertraits mentioned in the trait
/// definition.
/// These traits either originate from [`core`] or [`numi`].
/// Special attention must be paid to the [`AddRef`] trait, which is a proxy trait which is
/// implemented for types that implement: `&Self: Add<&Self, Output = Self>`.
///
/// # Example
///
/// ```rust
/// use core::num::Wrapping;
/// use core::num::Saturating;
/// use ordered_float::NotNan;
/// use petgraph_algorithms::shortest_paths::astar::AStarMeasure;
/// use static_assertions::assert_impl_all;
///
/// // Some examples of types that implement DijkstraMeasure
/// assert_impl_all!(u8: AStarMeasure);
/// assert_impl_all!(u16: AStarMeasure);
/// assert_impl_all!(u32: AStarMeasure);
/// assert_impl_all!(u64: AStarMeasure);
/// assert_impl_all!(u128: AStarMeasure);
/// assert_impl_all!(usize: AStarMeasure);
///
/// assert_impl_all!(i8: AStarMeasure);
/// assert_impl_all!(i16: AStarMeasure);
/// assert_impl_all!(i32: AStarMeasure);
/// assert_impl_all!(i64: AStarMeasure);
/// assert_impl_all!(i128: AStarMeasure);
/// assert_impl_all!(isize: AStarMeasure);
///
/// assert_impl_all!(NotNan<f32>: AStarMeasure);
/// assert_impl_all!(NotNan<f64>: AStarMeasure);
///
/// assert_impl_all!(Wrapping<u8>: AStarMeasure);
/// assert_impl_all!(Wrapping<u16>: AStarMeasure);
/// assert_impl_all!(Wrapping<u32>: AStarMeasure);
/// assert_impl_all!(Wrapping<u64>: AStarMeasure);
/// assert_impl_all!(Wrapping<u128>: AStarMeasure);
/// assert_impl_all!(Wrapping<usize>: AStarMeasure);
///
/// assert_impl_all!(Wrapping<i8>: AStarMeasure);
/// assert_impl_all!(Wrapping<i16>: AStarMeasure);
/// assert_impl_all!(Wrapping<i32>: AStarMeasure);
/// assert_impl_all!(Wrapping<i64>: AStarMeasure);
/// assert_impl_all!(Wrapping<i128>: AStarMeasure);
///
/// assert_impl_all!(Saturating<u8>: AStarMeasure);
/// assert_impl_all!(Saturating<u16>: AStarMeasure);
/// assert_impl_all!(Saturating<u32>: AStarMeasure);
/// assert_impl_all!(Saturating<u64>: AStarMeasure);
/// assert_impl_all!(Saturating<u128>: AStarMeasure);
/// assert_impl_all!(Saturating<usize>: AStarMeasure);
///
/// assert_impl_all!(Saturating<i8>: AStarMeasure);
/// assert_impl_all!(Saturating<i16>: AStarMeasure);
/// assert_impl_all!(Saturating<i32>: AStarMeasure);
/// assert_impl_all!(Saturating<i64>: AStarMeasure);
/// assert_impl_all!(Saturating<i128>: AStarMeasure);
/// assert_impl_all!(Saturating<isize>: AStarMeasure);
/// ```
pub trait AStarMeasure: Clone + PartialOrd + Ord + AddRef<Self, Output = Self> + Zero {}

impl<T> AStarMeasure for T where T: Clone + PartialOrd + Ord + AddRef<Self, Output = Self> + Zero {}