feat(rr-cache): update interface, readme, rework stats method

zhibirc · Nov 27, 2023 · 2d2712a · 2d2712a
1 parent bc85922
commit 2d2712a
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 6 deletions.
diff --git a/rr-cache/index.ts b/rr-cache/index.ts
@@ -17,8 +17,11 @@ class RRCache implements IRRCache {
         this.#store = new Map();
     }
 
-    get size() {
-        return this.#store.size;
+    get stats() {
+        return {
+            size: this.#store.size,
+            capacity: this.#capacity
+        };
     }
 
     set capacity (value: number) {
@@ -44,7 +47,7 @@ class RRCache implements IRRCache {
         return null;
     }
 
-    store (key: any, value: any) {
+    add (key: any, value: any) {
         let keyIndex: number;
 
         // check if cache capacity limit is reached

diff --git a/rr-cache/readme.md b/rr-cache/readme.md
@@ -1,4 +1,20 @@
-# Random Replacement (RR) cache
+# Random Replacement (RR) Cache
+
+## Definition
+
+## Implementation details
+
+| Operation  | Time complexity | Space complexity | Description                               |
+|------------|-----------------|------------------|-------------------------------------------|
+| `stats`    | $O(1)$          | $O(1)$           | Get cache statistics.                     |
+| `capacity` | $$              | $$               | Set new capacity value.                   |
+| `read`     | $O(1)$          | $O(1)$           | Read value by its key.                    |
+| `add`      | $O(1)$          | $O(1)$           | Add value by corresponding key.           |
+| `has`      | $O(1)$          | $O(1)$           | Check if there is a value by given key.   |
+| `remove`   | $O(1)$          | $O(1)$           | Remove value by associated key.           |
+| `clear`    | $O(1)$          | $O(1)$           | Remove cached data and release resources. |
+
+## General theory
 
 Random replacement policy selects a cached item randomly for eviction when the cache is full. It doesn’t consider access patterns or usage history.
 

diff --git a/rr-cache/types.ts b/rr-cache/types.ts
@@ -1,10 +1,25 @@
+type TStats = {
+    // get number of cache entries
+    size: number;
+    // get current value of cache capacity
+    capacity: number;
+    // @todo: may contain other props like cache misses, etc.
+};
+
 interface IRRCache {
-    get size(): number;
+    // get cache statistics
+    get stats(): TStats;
+    // set new capacity value
     set capacity(value: number);
+    // read value from cache by its key
     read: (key: any) => any;
-    store: (key: any, value: any) => void;
+    // add value to cache by corresponding key
+    add: (key: any, value: any) => void;
+    // check if cache contains value by given key
     has: (key: any) => boolean;
+    // remove value from cache by associated key
     remove: (key: any) => void;
+    // clear cache by removing all stored data and release all auxiliary resources
     clear: () => void;
 };