✨ (datastructure) added Trie (#29)

docs/CHANGELOG.md

@@ -1,5 +1,12 @@
 # docs
 
+## 0.0.9
+
+### Patch Changes
+
+- Updated dependencies
+  - @ultify/datastructure@0.4.0
+
 ## 0.0.8
 
 ### Patch Changes

docs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docs",
   "private": true,
-  "version": "0.0.8",
+  "version": "0.0.9",
   "scripts": {
     "build": "next build",
     "start": "next start ",
@@ -12,7 +12,7 @@
   "dependencies": {
     "@codesandbox/sandpack-react": "^2.14.2",
     "@hugeicons/react-pro": "^0.3.2",
-    "@ultify/datastructure": "0.3.5",
+    "@ultify/datastructure": "0.4.0",
     "classnames": "^2.5.1",
     "next": "^14.0.4",
     "next-mdx-remote": "^5.0.0",

packages/datastructure/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ultify/datastructure
 
+## 0.4.0
+
+### Minor Changes
+
+- Added Trie
+
 ## 0.3.5
 
 ### Patch Changes

packages/datastructure/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ultify/datastructure",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",

packages/datastructure/src/heap/heap.ts

@@ -135,9 +135,13 @@ export class Heap<T> {
    * @param values New elements to add to the Heap.
    */
   insert(...values: T[]) {
-    if (values.length === 0) return;
-    if (values.length === 1) return this.#insertNode(values[0]); // O(logN)
+    if (values.length === 0) return this;
+    if (values.length === 1) {
+      this.#insertNode(values[0]); // O(logN)
+      return this;
+    }
     this.#insertNodes(values);
+    return this;
   }
 
   /**

packages/datastructure/src/heap/min-heap.spec.ts

@@ -78,7 +78,6 @@ describe('Heap', () => {
 
       const el = heap.extractMin();
       expect(el).toBe(6);
-      console.log(heap.toArray());
       expect(heap.toArray()).toEqual([8, 16, 26, 56, 47, 42, 94, 81, 79, 66]);
       expect(heap.isValid()).toBe(true);
     });

packages/datastructure/src/index.ts

@@ -1,3 +1,4 @@
 export * from './stack';
 export * from './queue';
 export * from './heap';
+export * from './trie';

packages/datastructure/src/queue/queue.ts

@@ -67,13 +67,14 @@ export class Queue<T> {
    * Returns the top element without removing it
    */
   peek() {
-    return this.#array[0]
+    return this.#array[0];
   }
 
   /**
    * Clear queue
    */
   clear() {
     this.#array = [];
+    return this;
   }
 }

packages/datastructure/src/stack/stack.ts

@@ -60,14 +60,15 @@ export class Stack<T> {
    * Returns the top element without removing it
    */
   peek() {
-    return this.#array.at(-1)
+    return this.#array.at(-1);
   }
 
   /**
    * Clear stack
    */
   clear() {
     this.#array = [];
+    return this;
   }
 
   /**

packages/datastructure/src/trie/index.ts

@@ -0,0 +1 @@
+export * from './trie';

packages/datastructure/src/trie/trie.spec.ts

@@ -0,0 +1,137 @@
+import { Trie } from './trie';
+
+describe('Trie', () => {
+  describe('constructor', () => {
+    it('Should construct a trie', () => {
+      const trie = new Trie();
+      trie
+        .insert('abc')
+        .insert('xyz')
+        .insert('foo')
+        .insert('bar')
+        .insert('atmosphere');
+      expect(trie.nodeCount).toBe(22);
+      expect(trie.wordCount).toBe(5);
+    });
+
+    it('Should construct a trie', () => {
+      const trie = new Trie('abc', 'xyz', 'foo', 'bar');
+      expect(trie.nodeCount).toBe(13);
+      expect(trie.wordCount).toBe(4);
+    });
+
+    it('Should construct a trie', () => {
+      const trie = Trie.fromArray(['abc', 'xyz', 'foo', 'bar']);
+      expect(trie.nodeCount).toBe(13);
+      expect(trie.wordCount).toBe(4);
+    });
+  });
+
+  describe('Search', () => {
+    it('Should work correctly', () => {
+      const trie = new Trie();
+      trie
+        .insert('abc')
+        .insert('xyz')
+        .insert('foo')
+        .insert('bar')
+        .insert('atmosphere');
+      expect(trie.has('abc')).toBe(true);
+      expect(trie.has('bar')).toBe(true);
+      expect(trie.has('atmosphere')).toBe(true);
+      expect(trie.has('gy')).toBe(false);
+      expect(trie.has('atmospher')).toBe(false);
+    });
+  });
+
+  describe('Starts with', () => {
+    it('Should work correctly', () => {
+      const trie = new Trie();
+      trie
+        .insert('abc')
+        .insert('xyz')
+        .insert('foo')
+        .insert('bar')
+        .insert('atmosphere');
+      expect(trie.startsWith('abc')).toBe(true);
+      expect(trie.startsWith('bar')).toBe(true);
+      expect(trie.startsWith('gy')).toBe(false);
+      expect(trie.startsWith('atmospher')).toBe(true);
+    });
+  });
+
+  describe('Iteration', () => {
+    it('Should be iterable', () => {
+      const trie = new Trie();
+      trie
+        .insert('abc')
+        .insert('xyz')
+        .insert('foo')
+        .insert('bar')
+        .insert('atmosphere');
+      expect([...trie]).toContain('abc');
+      expect([...trie]).toContain('xyz');
+      expect([...trie]).toContain('foo');
+      expect([...trie]).toContain('bar');
+      expect([...trie]).toContain('atmosphere');
+    });
+
+    it('toArray should return new array', () => {
+      const trie = new Trie();
+      trie
+        .insert('abc')
+        .insert('xyz')
+        .insert('foo')
+        .insert('bar')
+        .insert('atmosphere');
+      expect(Array.isArray(trie.toArray())).toBe(true);
+    });
+  });
+
+  describe('Remove', () => {
+    it('Should work correctly', () => {
+      const trie = new Trie();
+      trie
+        .insert('abc')
+        .insert('xyz')
+        .insert('foo')
+        .insert('bar')
+        .insert('atmosphere');
+      trie.remove('atmosphere');
+      expect([...trie]).toContain('abc');
+      expect([...trie]).toContain('xyz');
+      expect([...trie]).toContain('foo');
+      expect([...trie]).toContain('bar');
+      expect([...trie]).not.toContain('atmosphere');
+      expect(trie.nodeCount).toBe(13);
+      expect(trie.wordCount).toBe(4);
+
+      trie.remove('b');
+      expect([...trie]).toContain('abc');
+      expect([...trie]).toContain('xyz');
+      expect([...trie]).toContain('foo');
+      expect([...trie]).toContain('bar');
+      expect(trie.nodeCount).toBe(13);
+      expect(trie.wordCount).toBe(4);
+
+      trie.remove('k');
+      expect([...trie]).toContain('abc');
+      expect([...trie]).toContain('xyz');
+      expect([...trie]).toContain('foo');
+      expect([...trie]).toContain('bar');
+      expect(trie.nodeCount).toBe(13);
+      expect(trie.wordCount).toBe(4);
+    });
+  });
+
+  describe('Clear', () => {
+    it('Should clear all nodes', () => {
+      const trie = new Trie('abc', 'xyz', 'foo', 'bar');
+      expect(trie.nodeCount).toBe(13);
+      expect(trie.wordCount).toBe(4);
+      trie.clear();
+      expect(trie.nodeCount).toBe(1);
+      expect(trie.wordCount).toBe(0);
+    });
+  });
+});