https://github.com/zhibirc/ururu
No :bird: URURU, just LRU (and friends)
https://github.com/zhibirc/ururu
cache caching fifo-cache lru-cache optimization optimization-algorithms performance random-replacement-algorithm replacement-policy slru-cache ttl-cache
Last synced: 8 months ago
JSON representation
No :bird: URURU, just LRU (and friends)
- Host: GitHub
- URL: https://github.com/zhibirc/ururu
- Owner: zhibirc
- Created: 2022-02-04T11:55:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-14T23:06:08.000Z (over 2 years ago)
- Last Synced: 2024-04-16T17:27:46.284Z (about 2 years ago)
- Topics: cache, caching, fifo-cache, lru-cache, optimization, optimization-algorithms, performance, random-replacement-algorithm, replacement-policy, slru-cache, ttl-cache
- Language: TypeScript
- Homepage:
- Size: 167 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ururu
[]()
[]()
---
## Table of Contents
🐢 [First-In-First-Out (FIFO) Cache](./fifo-cache/)
🐝 [Random Replacement (RR) Cache](./rr-cache/)
> [!TIP]
> Code is ready for copy-paste. Use plain TS files or JS + type annotations, whatever you need.
## Motivation
Yet another cache implementations. But why? Yeah, there are a few reasons for that.
**Major reasons:**
1. Research.
2. Education.
3. Fun.
**Minor reasons:**
1. To produce ready-to-use library well enough to just copy-paste into real project.
There are also several let's say acceptance criteria and non-functional requirements which I follow here:
1. Simplicity in implementation means better _maintainability_.
If in general it's usually true, this is very subjective if applied to implementations in this repository. Despite the fact that I try to maintain the lowest complexity level as it's possible and reasonable (without damage to performance in the first place), some specific decisions could probably be simplified.
2. Simplicity in interface means better _learnability_ (see "ISO/IEC 9126 Software engineering — Product quality").
3. Zero dependencies to achieve better _predictability_, _safety_, reduces overall application _size_ and CI/CD duration.
## General Theory
When the cache becomes full, a cache block or record/entry must be evicted to make room for a new block. The replacement policy determines which block to evict.
Various cache implementations can have slightly different public APIs, however most of them are very consistent in their core capabilities. In the list below there are typical extra features which can be found in known cache realisations (as part of their public API):
| Member | Type | Description |
|---------|--------|-------------------------------------------------------------------------------------|
|`size` |property|Number of entries/items/records actually stored in cache ($size <= capacity$). |
|`from` |static |Instantiate cache with data (usually key-value structure). |
|`setpop` |method |Sets a value for the given key, but besides that returns evicted object or old value.|
|`peek` |method |Retrieves the value associated with the given key, doesn't update access information.|
|`forEach`|method |Convenient helper methods implementing the ability to iterate on cache data. |
|`keys` |method | |
|`values` |method | |
|`entries`|method | |