dijkstra_suite/lib.rs
1//! A Dijkstra's algorithm implementation that aims to be simple to use and fast to run
2//!
3//! ** simple.** nodes id and its cost are defined by yuor own types
4//!
5//! ```toml
6//! [dependencies]
7//! dijkstra-suite = "0.1.0-alpha.0"
8//! ```
9//!
10//! ## Usage
11//!
12//! Just import the `add()` function and call it
13//!
14//! ```rust
15//! use dijkstra_suite::add;
16//!
17//! let sum = add(400, 20);
18//!
19//! # assert_eq!(sum, 420);
20//! ```
21
22#![doc(
23 html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
24 html_favicon_url = "https://www.rust-lang.org/favicon.ico",
25 html_root_url = "https://docs.rs/nanoid"
26)]
27
28pub fn add(left: u64, right: u64) -> u64 {
29 left + right
30}
31
32#[cfg(test)]
33mod tests {
34 use super::*;
35
36 #[test]
37 fn it_works() {
38 let result = add(2, 2);
39 assert_eq!(result, 4);
40 }
41}