From 29d4750c0f7c3218b4dc1597d7571d0dff2478fd Mon Sep 17 00:00:00 2001 From: Alex Garcia Date: Sun, 26 May 2024 20:54:37 -0700 Subject: [PATCH] doc --- sqlite-vec.c | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/sqlite-vec.c b/sqlite-vec.c index 58e096c..29d1e15 100644 --- a/sqlite-vec.c +++ b/sqlite-vec.c @@ -304,9 +304,16 @@ static f32 distance_hamming_u64(u64 *a, u64 *b, size_t n) { return (f32)same; } +/** + * @brief Calculate the hamming distance between two bitvectors. + * + * @param a - first bitvector, MUST have d dimensions + * @param b - second bitvector, MUST have d dimensions + * @param d - pointer to size_t, MUST be divisible by CHAR_BIT + * @return f32 + */ static f32 distance_hamming(const void *a, const void *b, const void *d) { size_t dimensions = *((size_t *)d); - todo_assert((dimensions % CHAR_BIT) == 0); if ((dimensions % 64) == 0) { return distance_hamming_u64((u64 *)a, (u64 *)b, dimensions / 8 / CHAR_BIT);