add some comments for binary search
authorDana Jansens <danakj@orodu.net>
Fri, 16 Apr 2010 15:46:52 +0000 (11:46 -0400)
committerMikael Magnusson <mikachu@gmail.com>
Fri, 16 Apr 2010 18:56:27 +0000 (20:56 +0200)
obt/bsearch.h

index ca5ae5b..65e4268 100644 (file)
 
 G_BEGIN_DECLS
 
+/*! Setup to do a binary search on an array holding elements of type @t */
 #define BSEARCH_SETUP(t) \
     register t l_BSEARCH, r_BSEARCH, out_BSEARCH;
 
+/*! Search an array @ar holding elements of type @t, starting at index @start,
+  with @size elements, looking for value @val. */
 #define BSEARCH(t, ar, start, size, val)         \
 { \
     l_BSEARCH = (start);              \
@@ -44,7 +47,10 @@ G_BEGIN_DECLS
     } \
 }
 
+/*! Returns true if the element last searched for was found in the array */
 #define BSEARCH_FOUND() (l_BSEARCH <= r_BSEARCH)
+/*! Returns the position in the array at which the element last searched for
+  was found. */
 #define BSEARCH_AT() (out_BSEARCH)