summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-06-21 23:10:41 +0200
committerGitHub <[email protected]>2020-06-21 23:10:41 +0200
commit0fced463804f06c75e7696621d136bc1630255de (patch)
treea50d5130bf4afd6cbdaa4de0306b5bf424fb92d8
parentab8eeb0511ce0e51fb42c2aae7574d73aebee01e (diff)
downloadSTC-modified-0fced463804f06c75e7696621d136bc1630255de.tar.gz
STC-modified-0fced463804f06c75e7696621d136bc1630255de.zip
Update README.md
-rw-r--r--examples/README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/examples/README.md b/examples/README.md
index 031db20d..c9952317 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,4 +1,12 @@
-To be able to use CMap with a user-defined key-type, you need to define two things:
+Examples
+========
+Contains various examples and benchmarks.
+
+
+advanced.c Example
+------------------
+
+This demonstrates how to customize **CHash map** 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.
@@ -86,5 +94,5 @@ int main()
chash_ex_destroy(&m6);
}
```
-CMap uses personview_hash() for hash value calculations, and the personview_compare() for equality checks. The chash_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.
+CHash map uses personview_hash() for hash value calculations, and the personview_compare() for equality checks. The chash_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.