Struct traitgraph_algo::dijkstra::performance_counters::DijkstraPerformanceCounter

pub struct DijkstraPerformanceCounter {
    pub iterations: u64,
    pub unnecessary_heap_elements: u64,
    /* private fields */
}

A simple performance counter for Dijkstra’s algorithm, keeping all supported counts.

Fields

iterations: u64

The number of iterations of the main loop of Dijkstra’s algorithm.

unnecessary_heap_elements: u64

The number of unnecessary heap elements.

Trait Implementations

impl Add<DijkstraPerformanceCounter> for DijkstraPerformanceCounter

type Output = DijkstraPerformanceCounter

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<DijkstraPerformanceCounter> for DijkstraPerformanceCounter

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for DijkstraPerformanceCounter

fn clone(&self) -> DijkstraPerformanceCounter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DijkstraPerformanceCounter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DijkstraPerformanceCounter

fn default() -> DijkstraPerformanceCounter

Returns the “default value” for a type.

impl DijkstraPerformanceData for DijkstraPerformanceCounter

fn add_iteration(&mut self)

Increment the number of iterations of the main loop of Dijkstra’s algorithm.

fn add_unnecessary_heap_element(&mut self)

Increment the number of heap elements that already have a lower weight than what was stored in the heap. These are wasted cycles because our heap does not support the decrease_key operation.

fn record_heap_size(&mut self, heap_size: usize)

Record the current heap size of Dijkstra’s algorithm.

fn record_distance_array_size(&mut self, distance_array_size: usize)

Record the current distance array size of Dijkstra’s algorithm.

fn finish_dijkstra(&mut self)

Finish an invocation of Dijkstra’s algorithm. Performs finalisation of recorded metrics that are local to single Dijkstra invocations.

fn iterations(&self) -> Option<u64>

Get the number of iterations of the main loop of Dijkstra’s algorithm.

fn unnecessary_heap_elements(&self) -> Option<u64>

Get the number of unnecessary heap elements that were inserted during Dijkstra’s algorithm.

fn max_max_heap_size(&self) -> Option<usize>

Get the maximum heap size encountered at any point during execution.

fn max_max_distance_array_size(&self) -> Option<usize>

Get the maximum distance array size encountered at any point during execution.

fn average_max_heap_size(&self) -> Option<f64>

Get the maximum heap size as average over all invocations of Dijkstra’s algorithm.

fn average_max_distance_array_size(&self) -> Option<f64>

Get the maximum distance array size as average over all invocations of Dijkstra’s algorithm.

impl PartialEq<DijkstraPerformanceCounter> for DijkstraPerformanceCounter

fn eq(&self, other: &DijkstraPerformanceCounter) -> 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 Eq for DijkstraPerformanceCounter

impl StructuralEq for DijkstraPerformanceCounter

impl StructuralPartialEq for DijkstraPerformanceCounter