diff options
author | Am Laher <amir.laher@tixtrack.com> | 2022-12-28 20:45:55 +1300 |
---|---|---|
committer | Am Laher <amir.laher@tixtrack.com> | 2022-12-28 20:45:55 +1300 |
commit | 1fed1a324a0b4b55c32f0922c9b415b543ef6190 (patch) | |
tree | a9b881d408fd6f45a69f7d3d6694fbd3f70f4ee1 /README.md | |
parent | sets: varargs (diff) | |
download | pds-1fed1a324a0b4b55c32f0922c9b415b543ef6190.tar.gz pds-1fed1a324a0b4b55c32f0922c9b415b543ef6190.tar.xz |
Fix SortedSet.Set. NewMapOf. docs
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 25 |
1 files changed, 24 insertions, 1 deletions
@@ -2,7 +2,7 @@ Immutable ` if you are using +one of these key types. + + +## Sorted Set + +The `SortedSet` represents a sorted collection of unique values. +Unlike the `Set`, however, keys can be iterated over in-order. It is implemented +as a B+tree. + +Sorted sets require a `Comparer` to sort values and check for equality. There are +built-in comparer implementations for `int`, `uint`, and `string` keys. You may +pass a `nil` comparer to `NewSortedSet()` if you are using one of these key +types. + +The API is identical to the `Set` implementation. ## Contributing |