From 1ac77f621a2be6f670032463e9e91fe2bbb973b8 Mon Sep 17 00:00:00 2001
From: Tyge Løvset <60263450+tylo-work@users.noreply.github.com>
Date: Sun, 26 Apr 2020 23:29:26 +0200
Subject: Update advanced_example.md

---
 advanced_example.md | 15 ++++++---------
 1 file changed, 6 insertions(+), 9 deletions(-)

diff --git a/advanced_example.md b/advanced_example.md
index 5b5013b8..7c924a1c 100644
--- a/advanced_example.md
+++ b/advanced_example.md
@@ -1,5 +1,3 @@
-This example is based on https://stackoverflow.com/questions/17016175/c-unordered-map-using-a-custom-class-type-as-the-key/17017281#17017281, adapted to use CMap and CString instead of std::unordered_map and std::string.
-
 To be able to use CMap (or one of the other unordered associative containers) with a user-defined key-type, you need to define two things:
 
 1. A hash function; this must be a function that calculates the hash value given an object of the key-type.
@@ -31,10 +29,9 @@ void person_destroy(struct Person* p) {
   cstring_destroy(&p->surname);
 }
 ```
-In order to use it as a CMap key, provide a "view" of your class, that owns no resources (e.g. CStrings):
+In order to use Person as a map key, provide a "view" of your class that owns no resources (e.g. CString):
 ```
-struct PersonView
-{
+struct PersonView {
   const char* name;
   const char* surname;
   int age;
@@ -52,7 +49,7 @@ int personview_compare(const struct PersonView* x, const struct PersonView* y) {
   return memcmp(&x->age, &y->age, sizeof(x->age));
 }
 ```
-Here is a simple hash function that combines the three member's hashes:
+And a hash function that combines the three member's hashes:
 ```
 size_t personview_hash(const struct PersonView* pv, size_t ignore) {
   // Compute individual hash values for name, surname and age
@@ -65,14 +62,14 @@ size_t personview_hash(const struct PersonView* pv, size_t ignore) {
   return res;
 }
 ```
-With this in place, we can declare the map Person => int:
+With this in place, we can declare the map Person -> int:
 ```
 declare_CMap(ex, struct Person, int, c_noDestroy,
                  personview_hash, personview_compare, person_destroy,
                  struct PersonView, person_getView, person_fromView);
 
 ```
-Note we use struct PersonView to put keys in the map, but is stored as struct Person.
+Note we use struct PersonView to put keys in the map, but keys are stored as struct Person with proper dynamically allocated CStrings to store name and surname.
 ````
 int main()
 {
@@ -90,6 +87,6 @@ int main()
   cmap_ex_destroy(&m6);
 }
 ```
-CMap will automatically use personview_hash() as defined above for the hash value calculations, and the personview_compare() for equality checks.
+CMap uses personview_hash() for hash value calculations, and the personview_compare() for equality checks.
 The cmap_ex_destroy() function will free CStrings name, surname and the value for each item in the map, in addition to the CMap hash table itself.
 
-- 
cgit v1.2.3