doc

beling · Oct 22, 2024 · 6b6345b · 6b6345b
1 parent bc13d76
commit 6b6345b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/seedable_hash/Cargo.toml b/seedable_hash/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "seedable_hash"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["Piotr Beling <piotr.beling@wmii.uni.lodz.pl>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"

diff --git a/seedable_hash/src/map.rs b/seedable_hash/src/map.rs
@@ -44,6 +44,7 @@ pub fn map48_to_64(hash: u64, n: u64) -> u64 {
     ((((hash << 16) as u128) * (n as u128)) >> 64) as u64
 }*/ // the function is fine, but not needed
 
+/// Maps `hash` to the range `[0, n)` using either [`map64_to_64`] or [`map32_to_32`] (depended on platform).
 #[inline(always)]
 pub fn map_usize(hash: usize, n: usize) -> usize {
     #[cfg(target_pointer_width = "64")] { map64_to_64(hash as u64, n as u64) as usize }