Some reworks

Author: itsibitzi

crates/hriblt/README.md

@@ -11,9 +11,9 @@ Add the library to your `Cargo.toml` file.
 hriblt = "0.1"
 ```
 
-Create two encoding sessions, one containing your data, and another containing the counter-parties data. This counterparty data might have been sent to you over a network for example.
+Create two encoding sessions, one containing Alice's data, and another containing Bob's data. Bob's data might have been sent to you over a network for example.
 
-The following example attempts to reconcile the differences between two sets of `u64` integers, and is done from the perspective of "Bob", who has recieved some symbols from "Alice".
+The following example attempts to reconcile the differences between two such sets of `u64` integers, and is done from the perspective of "Bob", who has received some symbols from "Alice".
 
 ```rust
 use hriblt::{DecodingSession, EncodingSession, DefaultHashFunctions};

crates/hriblt/docs/assets/coded-symbol-multiplier.png

@@ -6,7 +6,7 @@ Regardless, there are some advantages to getting the size of your decoding sessi
 
 ## Coded Symbol Multiplier
 
-The number of coded symbols required to find the difference between two sets is proportional to the difference between the two sets. The following chart shows the relationship between the number of coded symbols required to decode HRIBLT and the size of the diff. Note that the size of the base set (before diffs were added) was fixed.
+The number of coded symbols required to find the difference between two sets is proportional to the difference between the two sets. The following chart shows the relationship between the number of coded symbols required to decode HRIBLT and the size of the diff. Note that the size of the base set (before diffs were added) was fixed at 1000 entries.
 
 `y = len(coded_symbols) / diff_size`
 

crates/hriblt/docs/sizing.md

@@ -58,8 +58,9 @@ impl<T: Encodable> CodedSymbol<T> {
 
     /// Checks whether this coded symbol is pure, i.e., whether it represents a single entity
     /// A pure coded symbol must satisfy the following conditions:
-    /// - The 1-bit counter must be 1 or -1 (which are both represented by the bit being set)
-    /// - The checksum must match the checksum of the value.
+    /// - The 1-bit counter must be 1 or -1 (which are both represented by the least significant bit being set)
+    /// - The checksum must match the absolute value of the checksum of the value.
+    ///   The sign (-/+) tells you if it was an insertion or deletion
     /// - The indices of the value must match the index of this coded symbol.
     pub(crate) fn is_pure<S: HashFunctions<T>>(
         &self,
@@ -118,10 +119,10 @@ fn indices_contains<T: std::hash::Hash>(
     if stream_len > 32 && i % 32 != 0 {
         let seed = i % 4;
         let j = index_for_seed(state, value, stream_len, seed as u32);
-        if i == j { 1 } else { 0 }
+        i32::from(i == j)
     } else {
         indices(state, value, stream_len)
-            .map(|j| if j == i { 1 } else { 0 })
+            .map(|j| i32::from(i == j))
             .sum()
     }
 }

crates/hriblt/src/coded_symbol.rs

@@ -10,7 +10,7 @@ use crate::{
 pub struct DecodingSession<T: Encodable, H: HashFunctions<T>> {
     /// The encoded stream of hashes.
     /// All recovered coded symbols have been removed from this stream.
-    /// If decoded failed, then one can simply append more data and continue decoding.
+    /// If decoded fails, then one can simply append more data and continue decoding.
     encoded: EncodingSession<T, H>,
     /// All the recovered coded symbols.
     recovered: Vec<CodedSymbol<T>>,