From e7374d0227348b461e4d55d8f36536174d84e24e Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 10 Feb 2016 23:28:16 +1100 Subject: Docs: minor comment edits to smallhash --- source/blender/blenlib/intern/smallhash.c | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'source/blender/blenlib/intern/smallhash.c') diff --git a/source/blender/blenlib/intern/smallhash.c b/source/blender/blenlib/intern/smallhash.c index 35c23299877..0b976e9612e 100644 --- a/source/blender/blenlib/intern/smallhash.c +++ b/source/blender/blenlib/intern/smallhash.c @@ -28,12 +28,14 @@ /** \file blender/blenlib/intern/smallhash.c * \ingroup bli * - * A light stack-friendly hash library, it uses stack space for smallish hash tables - * but falls back to heap memory once the stack limits reached. + * A light stack-friendly hash library, it uses stack space for relatively small, fixed size hash tables + * but falls back to heap memory once the stack limits reached (#SMSTACKSIZE). * - * based on a doubling non-chaining approach which uses more buckets then entries + * based on a doubling hashing approach (non-chaining) which uses more buckets then entries * stepping over buckets when two keys share the same hash so any key can find a free bucket. * + * See: http://en.wikipedia.org/wiki/Double_hashing + * * \warning This should _only_ be used for small hashes where allocating a hash every time is unacceptable. * Otherwise #GHash should be used instead. * @@ -50,7 +52,8 @@ #include #include -#include + +#include "BLI_sys_types.h" #include "MEM_guardedalloc.h" -- cgit v1.2.3