rankmap 0.1.0

rust hash table supporting key ranking
Documentation
//! Ranked hash table.
//!
//! A hash-map / binary-heap combined data structure that supports the following operations:
//!
//! # Time complexity
//! | [Description]                | [Operation]  | [Complexity] |
//! |------------------------------|--------------|--------------|
//! | get value by key             | get          | *O*(1)~      |
//! | check key existence          | contains_key | *O*(1)~      |
//! | pop element with lowest rank | pop          | *O*(log(N))  |
//! | get element with lowest rank | top          | *O*(1)       |
//! | insert element with rank     | insert       | *O*(log(N))  |
//! | remove element               | remove       | *O*(log(N))  |
//!
//!
//! # Examples
//!
//! ```
//! use std::thread;
//! use std::time::{Duration, Instant};
//!
//! use rankmap::RankMap;
//!
//! fn task1() {
//!     println!("task1 finished")
//! }
//!
//! fn task2() {
//!     println!("task2 finished")
//! }
//!
//! fn task3() {
//!     println!("task3 finished")
//! }
//!
//! fn main() {
//!     let mut scheduler: RankMap<&str, Box<dyn Fn()>, Instant> = RankMap::new();
//!
//!     let tank_id = "task1";
//!     let task = Box::new(task1);
//!     let run_at = Instant::now() + Duration::from_secs(1);
//!     scheduler.insert(tank_id, task, run_at);
//!
//!     let tank_id = "task2";
//!     let task = Box::new(task2);
//!     let run_at = Instant::now() + Duration::from_secs(2);
//!     scheduler.insert(tank_id, task, run_at);
//!
//!     while let Some((task_name, task, run_at)) = scheduler.pop() {
//!         let backoff = run_at - Instant::now();
//!         thread::sleep(backoff);
//!         println!("executing {}", task_name);
//!         task();
//!     }
//!
//!     let tank_id = "task3";
//!     let task = Box::new(task3);
//!     let run_at = Instant::now() + Duration::from_secs(1);
//!     scheduler.insert(tank_id, task, run_at);
//!
//!     if let Some((task, run_at)) = scheduler.remove(&"task3") {
//!         println!("task3 cancelled");
//!     }
//!
//!     assert!(scheduler.top().is_none());
//! }
//! ```

pub(crate) mod binary_heap;
pub mod rank_map;

pub use rank_map::RankMap;