projects
/
rrq
/
rrqmisc.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Cleanup Tuple to allow self-typing.
[rrq/rrqmisc.git]
/
vector
/
HashVector.h
diff --git
a/vector/HashVector.h
b/vector/HashVector.h
index 0b4a0f6c19c38c7fac86a3a1c93448cb79b6fedd..387f7ce53cbe3782fee880af84e5f6c0af71a238 100644
(file)
--- a/
vector/HashVector.h
+++ b/
vector/HashVector.h
@@
-73,7
+73,7
@@
typedef struct {
#define HV_HOLE ((void*) 1)
/**
#define HV_HOLE ((void*) 1)
/**
- * \brief
Find the keyed item
.
+ * \brief
Lookup the first item with the given key
.
*
* \param hv is the \ref HashVector concerned.
*
*
* \param hv is the \ref HashVector concerned.
*
@@
-86,18
+86,21
@@
typedef struct {
void *HashVector_find(HashVector *hv,void *key);
/**
void *HashVector_find(HashVector *hv,void *key);
/**
- * \brief Scan the table for
th next key-matching item at or after
the
- * given
index
.
+ * \brief Scan the table for
any subsequent item that admits to
the
+ * given
partial key
.
*
* \param hv is the \ref HashVector concerned.
*
* \param index is a pointer to the index to advance.
* \
*
* \param hv is the \ref HashVector concerned.
*
* \param index is a pointer to the index to advance.
* \
- * \param key is the
Q
uery key
+ * \param key is the
q
uery key
*
* \returns the next matching item, or \b 0 if none, with the index
* updated.
*
*
* \returns the next matching item, or \b 0 if none, with the index
* updated.
*
+ * This function is used where the query key doesn't fully identify an
+ * item, and is thus a partial key that
+ *
* \related HashVector
*/
extern void *HashVector_next(HashVector *hv,VectorIndex *i,void *key);
* \related HashVector
*/
extern void *HashVector_next(HashVector *hv,VectorIndex *i,void *key);