ZENOTME commented on code in PR #118: URL: https://github.com/apache/datasketches-rust/pull/118#discussion_r3200625639
########## datasketches/src/hash_value/mod.rs: ########## @@ -0,0 +1,91 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +//! Hashable value wrappers for sketches. +//! +//! Sketch update APIs accept any value that implements [`Hash`]. For most Rust values, +//! passing the value directly is sufficient. This module provides value wrappers for +//! cases where the default implementation does not match a sketch's compatibility rules. +//! +//! ## Floating-point Numbers +//! +//! [`canonical_float::CanonicalFloat`] maps `f32` and `f64` values through a canonical `f64` bit +//! pattern before hashing. Signed zero values hash the same, all NaN values use one canonical NaN +//! bit pattern, and equal `f32`/`f64` values hash the same. +//! +//! This strategy is the same as how other datasketches implementations hash floating-point numbers. +//! +//! Read the docs of concrete value wrapper for more details and examples. +//! +//! * [`canonical_float::from_f32`] +//! * [`canonical_float::from_f64`] +//! +//! ## Integers +//! +//! [`sign_extend::SignExtend`] first sign-extends values to 64-bits, and then hashes the resulting +//! integers. This strategy is the same as how datasketches-cpp hashes short integers for +//! `HllSketch` and `CpcSketch`. +//! +//! Read the docs of concrete value wrapper for more details and examples. +//! +//! * [`sign_extend::from_i8`], [`sign_extend::from_u8`] +//! * [`sign_extend::from_i16`], [`sign_extend::from_u16`] +//! * [`sign_extend::from_i32`], [`sign_extend::from_u32`] +//! +//! [`natural_extend::NaturalExtend`] first widens signed values to `i64` and unsigned values to +//! `u64`, and then hashes the resulting integers. This strategy is the same as how datasketches-cpp +//! hashes short integers for `HllSketch` and `CpcSketch`. Review Comment: ~~hashes short integers for `HllSketch` and `CpcSketch`.~~ hashes short integers for `BloomFilter`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
