Skip to content

Commit 843d7ed

Browse files
author
Johan Tibell
committed
Add a readme
1 parent 2815092 commit 843d7ed

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## unordered-containers
2+
3+
Efficient hashing-based container types. The containers have been optimized for
4+
performance critical use, both in terms of large data quantities and high speed.
5+
6+
The declared cost of each operation is either worst-case or amortized, but
7+
remains valid even if structures are shared.
8+
9+
For developer and contributor documentation see docs/developer-guide.md.

docs/developer-guide.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,11 @@ updating the spine of the tree).
110110
`Full` is just an optimized version of `BitmapIndexed` that allows us faster
111111
indexing, faster copying on modification (given that its size is statically
112112
know), and lower memory use.
113+
114+
## Strictness
115+
116+
Everything is strict. Laziness is the enemy of predictable performance.
117+
118+
## Backwards compatibility policy
119+
120+
We support the last 3 major GHC releases.

0 commit comments

Comments
 (0)