Speiger
/
Primitive-Collections
0
0
Fork 1
Code Issues 1 Pull Requests Projects Releases 1 Wiki Activity

Fixed Doc

This commit is contained in:
Speiger 2021-12-11 12:56:01 +01:00
parent e1df59d512
commit 599cc44fff
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -21,18 +21,18 @@ But its focus is a different one.
## Current Level of Stability ## Current Level of Stability
Since this is a relatively new Library, stability was not perfect and some areas are not perfect yet. Since this is a relatively new Library, stability was not perfect and some areas are not perfect yet.
Thanks to @ben-manes we now have Roughly 16000 test covering Maps/Sets/Lists. Thanks to @ben-manes we now have Roughly 16000 test covering Maps/Sets/Lists.
These tests cover Javas Collection API completely and ensuring a Stable implementation. These tests cover Javas Collection API completely and ensuring a Stable implementation.
These freshly added tests allowed me to squash thousands of issues according to Googles Test Library (Guava-Tests). These freshly added tests allowed me to squash thousands of issues according to Googles Test Library (Guava-Tests).
These will be expanded on as time goes on. These will be expanded on as time goes on.
One know aspect of Instability is SubSets and SubMaps. They require full rewrites to be fully stable. One know aspect of Instability is SubSets and SubMaps. They require full rewrites to be fully stable.
So it is not advised to use them until these issues are addressed. So it is not advised to use them until these issues are addressed.
PriorityQueues are tested separately and ensure basic functionality though GuavaTests are planned. PriorityQueues are tested separately and ensure basic functionality though GuavaTests are planned.
They just require a custom implementation to run. They just require a custom implementation to run.
As a summary: Stability is good/excellent, unless you need SubSets/SubMaps As a summary: Stability is good/excellent, unless you need SubSets/SubMaps
## Specialized Functions ## Specialized Functions
New Specialized functions that were added to increase performance or reduce allocations or Quality Of life. New Specialized functions that were added to increase performance or reduce allocations or Quality Of life.
@ -136,5 +136,5 @@ to build the jar:
do not combine the commands because they can not be executed at the same time. do not combine the commands because they can not be executed at the same time.
## Current Down Sides (Random order) ## Current Down Sides (Random order)
- SubMaps/Set implementation isn't perfect right now. This will be addressed slowly due to rewrites required. - SubMaps/Set implementation isn't perfect right now. This will be addressed slowly due to rewrites required.
- Documentation is only present at the lowest level for most cases and needs a typo fixing. - Documentation is only present at the lowest level for most cases and needs a typo fixing.