diff options
| author | Karsten Blees <karsten.blees@gmail.com> | 2014-07-03 00:21:21 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-07-07 13:56:31 -0700 |
| commit | aa420c48eaea5c89946b8753363d09955300133f (patch) | |
| tree | 0b51dd2061ed644b590320babd613273c74153e4 | |
| parent | 039dc71a7cb824300e242f8abc0fcb19dac93641 (diff) | |
| download | git-aa420c48eaea5c89946b8753363d09955300133f.tar.gz | |
hashmap: improve struct hashmap member documentation
Signed-off-by: Karsten Blees <blees@dcon.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/technical/api-hashmap.txt | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/technical/api-hashmap.txt b/Documentation/technical/api-hashmap.txt index 37727cd2c0..f07f17d395 100644 --- a/Documentation/technical/api-hashmap.txt +++ b/Documentation/technical/api-hashmap.txt @@ -8,11 +8,19 @@ Data Structures `struct hashmap`:: - The hash table structure. + The hash table structure. Members can be used as follows, but should + not be modified directly: + -The `size` member keeps track of the total number of entries. The `cmpfn` -member is a function used to compare two entries for equality. The `table` and -`tablesize` members store the hash table and its size, respectively. +The `size` member keeps track of the total number of entries (0 means the +hashmap is empty). ++ +`tablesize` is the allocated size of the hash table. A non-0 value indicates +that the hashmap is initialized. It may also be useful for statistical purposes +(i.e. `size / tablesize` is the current load factor). ++ +`cmpfn` stores the comparison function specified in `hashmap_init()`. In +advanced scenarios, it may be useful to change this, e.g. to switch between +case-sensitive and case-insensitive lookup. `struct hashmap_entry`:: |