Skip to content

Commit 7a2cd3e

Browse files
authored
Update README.md
1 parent f2c222e commit 7a2cd3e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ This is a hashmap written in C++.
1313

1414
It has a similar API to C#'s [Dictionary](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2?view=net-8.0) and self-initializes like an [std::vector](https://en.cppreference.com/w/cpp/container/vector). Currently, it uses [sequential chaining](https://en.wikipedia.org/wiki/Hash_table#Separate_chaining) for collision resolution. More collision resolution techniques may be added in the future.
1515

16-
Explicit finalization of the hashmap is not necessary. However, if you are storing manually-managed memory, then remember to free the element before removing it from the hashmap.
16+
Explicit finalization of the hashmap is not necessary. However, if you are storing manually-managed memory, then remember to free any elements before removal.
1717

18-
I have taken precautions to improve the exception safety of the hashmap, although it is important to note that no algorithm can be completely immune to exceptions.
18+
I have taken precautions to improve the exception safety of the hashmap, although it hasn't been fully stress-tested. Please be aware that since this implementation uses [std::vector](https://en.cppreference.com/w/cpp/container/vector) for the container, anything that breaks a [std::vector](https://en.cppreference.com/w/cpp/container/vector) will also break the hashmap.
1919

2020
If you find a bug or have a feature-request, please raise an issue.
2121

2222
### Instructions
2323

24-
This implementation is header-only. Simply include it in your project and you are ready to start using it.
24+
This implementation is header-only. Simply include it in your project and you are ready to start.
2525

2626
#### Example:
2727

0 commit comments

Comments
 (0)