@rbxts/hash 1.0.1 → 1.0.2

package/README.md

@@ -5,6 +5,8 @@
 
 Utility for computing and combining hash codes.
 
+### Example
+
 ```ts
 import { Hash } from "@rbxts/hash";
 
@@ -15,7 +17,7 @@ class User {
     public readonly age: number
   ) { }
 
-  public hashCode(): number {
+  public hashCode(): Hash {
     return Hash.combine(this.name, this.age);
   }
 }
@@ -25,3 +27,32 @@ const alice = new User("Alice", 21);
 print(bob.hashCode() === bob.hashCode()); // true
 print(bob.hashCode() === alice.hashCode()); // false
 ```
+
+### Incremental combining
+
+```ts
+import { Hash } from "@rbxts/hash";
+
+
+class Employee {
+  public constructor(
+    public readonly name: string,
+    public readonly reviews: string[]
+  ) { }
+
+  public hashCode(): Hash {
+    const hash = Hash.incremental();
+    hash.add(name);
+    hash.add(reviews.size());
+    for (const review of reviews)
+      hash.add(review)
+
+    return hash.toHash();
+  }
+}
+
+const bob = new Employee("Bob", ["great dude"]);
+const alice = new User("Alice", ["polite woman"]);
+print(bob.hashCode() === bob.hashCode()); // true
+print(bob.hashCode() === alice.hashCode()); // false
+```

package/out/index.d.ts

@@ -4,6 +4,14 @@ export interface Hashable {
 }
 export type HashableType = number | string | boolean | Hashable | undefined;
 export declare namespace Hash {
-    function of(hashable: HashableType): Hash;
-    function combine(...hashables: HashableType[]): Hash;
+    class IncrementalHash {
+        private hash;
+        private count;
+        add(value: HashableType): this;
+        toHash(): Hash;
+    }
+    export function incremental(): IncrementalHash;
+    export function of(hashable: HashableType): Hash;
+    export function combine(...hashables: HashableType[]): Hash;
+    export {};
 }

package/out/init.luau

@@ -15,8 +15,38 @@ local MAX32 = 0xFFFFFFFF
 local Hash = {}
 do
 	local _container = Hash
+	local queueRound, of, mixFinal, mul32
+	local IncrementalHash
+	do
+		IncrementalHash = setmetatable({}, {
+			__tostring = function()
+				return "IncrementalHash"
+			end,
+		})
+		IncrementalHash.__index = IncrementalHash
+		function IncrementalHash.new(...)
+			local self = setmetatable({}, IncrementalHash)
+			return self:constructor(...) or self
+		end
+		function IncrementalHash:constructor()
+			self.hash = PRIME5
+			self.count = 0
+		end
+		function IncrementalHash:add(value)
+			self.hash = queueRound(self.hash, of(value))
+			self.count += 1
+			return self
+		end
+		function IncrementalHash:toHash()
+			return mixFinal(band(self.hash + mul32(self.count, 4), MAX32))
+		end
+	end
+	local function incremental()
+		return IncrementalHash.new()
+	end
+	_container.incremental = incremental
 	local hashString
-	local function of(hashable)
+	function of(hashable)
 		local _hashable = hashable
 		local _exp = typeof(_hashable)
 		repeat
@@ -36,7 +66,7 @@ do
 		until true
 	end
 	_container.of = of
-	local round, mixState, mul32, queueRound, mixFinal
+	local round, mixState
 	local function combine(...)
 		local hashables = { ... }
 		local length = #hashables

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/hash",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A utility for generating hash codes for objects",
   "author": "me",
   "main": "out/init.lua",