Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: CacheMap #11

Merged
merged 47 commits into from
Dec 4, 2023
Merged

Feature: CacheMap #11

merged 47 commits into from
Dec 4, 2023

Conversation

deavmi
Copy link
Owner

@deavmi deavmi commented Nov 27, 2023 •
edited

Purpose ✍️

Add support for a CacheMap and a CacheList.

Todo

  • CacheMap

    • Alive strat.
    • On-access strat.
    • Use delegate
    • Force expiration

  • CacheList

    • Alive strat.
    • On-access strat.
    • Use delegate

  • Unit tests

    • Threaded expiration
    • On-access expiration
    • Explicit key removal

  • Documentation

@deavmi
Containers
375bb39 
- Created module
@deavmi
ExpirationStrategy
96d2b15 
- Added new enum with members `LIVE` and `ON_ACCESS`
@deavmi
Entry
89155e3 
- Added entry
@deavmi
CacheMap
52faa0e 
- Added initial implementation

CacheMap (unitests)

- Added a unittest
@deavmi
CacheList
706b533 
- Added a stub `CacheList` container type
@deavmi deavmi added the enhancement New feature or request label Nov 27, 2023
@deavmi deavmi self-assigned this Nov 27, 2023
@deavmi
Copy link
Owner Author

deavmi commented Nov 27, 2023

If we do a trivial on access we scale badly with O(n) for traversal, so we could configure hitcount or time-based.

Time based feels right, but it would have to be bounded surely by min time, and that is complicated.

Or well, maybe relative to everything else, time "freezes" and unfreezes when we traverse, it's really LRU we care about than the strict time value I guess.

@deavmi
Copy link
Owner Author

deavmi commented Nov 27, 2023

Okay maar ek suip lekker nou 🍺

@deavmi
CacheMap
2aaba8a 
- Implement the static ifdefs to set
- Use the hitcount method
@deavmi
CacheMap
6f97919 
- Disbale hitcount for now
@deavmi
CacheMap
422ef74 
- Added `ReplacementFunction`
@deavmi
CacheMap
3595c6f 
- Implemented `updateKey(K key)`
@deavmi
CacheMap
6898121 
- Implemented `expirationCheck(K key)`
@deavmi
CacheMao
4c5c2f5 
- Updated `get(K key)` to use the new `K` key-based exipiration check
@deavmi
CacheMap
8f5e187 
- The method `updateKey(K key)` now returns the value refreshed
- `get(K key)` now refrehses on unfound key
@deavmi
CacheMap
1b81110 
- Implemented `makeKey(K key)`
- Busy reworking, still broken
@deavmi
CacheMap
541007a 
- Fixed errors with compilation in `makeKey(K key)`
@deavmi
CacheMap
c1c1de4 
- Fixed `expirationCheck(K key)` by using `makeKey(K key)` whenever the key does not yet exist
@deavmi
Copy link
Owner Author

deavmi commented Nov 27, 2023

Okay, maar I have on-access working now it seems, for CacheMap

@deavmi
CacheMap (unittests)
2f23072 
- Fixed unit test
@deavmi
Copy link
Owner Author

deavmi commented Nov 27, 2023

Unit test is gucci ✔️

@deavmi
CacheMap
836f1a9 
- Removed `put(K, V)` method
@deavmi
CacheMap
9fe583f 
- Removed traversal version `expirationCheck()`
@deavmi
CacheMap
3fe915f 
- Force compilation failure when `get()` is called for LIVE strat
- Added proper `~this()` implementation for LIVE strat
@deavmi
CacheMap
eeea8fa 
- Documented methods
@deavmi
CacheMap
b81847c 
- Updated `get(K)`
@deavmi
CacheMap
66851ac 
- Either a function or delegate may now be used
@deavmi
Copy link
Owner Author

deavmi commented Nov 28, 2023

Added delegate support ✔️

@deavmi
CacheMap
bd76822 
- Removed nop
@deavmi
CacheMap
168237f 
- Documented `checkerFunc()`
@deavmi
CacheMap
ce5966a 
- Documented `doLiveCheck()` and `~this()`
@deavmi
niknaks.containers
9f83b26 
- Documented module
@deavmi
niknaks (package)
5d86f25 
- Added import
@deavmi
Copy link
Owner Author

deavmi commented Dec 1, 2023

Documentation ✔️

@deavmi
CacheMap
5271883 
- Implemented `removeKey(K key)`
@deavmi
CacheMap
e93f441 
- Documented `removeKey(K)`
@deavmi
CacheMap (unittest)
55fb723 
- Explcitiyl set time
@deavmi
CacheMap (unittest)
0787bb2 
- Added a test ofkey removal (explicit)
@deavmi
CacheMap (unittest)
0bb1429 
- Destroy map
@deavmi
CacheMap (unittest)
bfc4ea6 
- Added missing documentation
@deavmi
Copy link
Owner Author

deavmi commented Dec 2, 2023

Added explicit key removal ✔️

@deavmi deavmi changed the title Feature: CacheMap, CacheList Feature: CacheMap Dec 4, 2023
@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Explicit key removal works ✔️

@deavmi
CacheMap (unittest)
95fa1e0 
- Removed old code
@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Threaded expiration ✔️

@deavmi
CacheMap (unittests)
2a94419 
- Cleaned up
@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

No tests yet for on-access expiration

@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Adding sweep interval customization...

@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Adding on-acces unittest

@deavmi
CacheMap
fa8311b 
- Fixed the constructor which takes in a `ReplacementFunction` to pass in the default arguments as well
- The `checkerFunc` now uses the `sweepInterval`
- Added support for a `sweepInterval` which the checker runs at now (seperate to the `expirationTime`)

CacheMap (unittest)

- Documented more unittests
- Added a unit test for on-access stratergy testing
@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Adding sweep interval customization...

Done ✔️

@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Adding sweep interval customization...

Done ✔️

Done ✔️

@deavmi
niknaks.containers
3dc31ff 
- Cleaned up imports
@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Okay, this is all done - will be merging now

@deavmi
CacheMap
e722867 
- Made `ReplacementDelegate` and `ReplacementFunction` public and added documentation
@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Added more docs

@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Done, merging...

@deavmi deavmi merged commit bdcbb1b into master Dec 4, 2023
2 of 4 checks passed
@deavmi
Copy link
Owner Author

deavmi commented Dec 4, 2023

Merged ✔️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@deavmi deavmi

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@deavmi