From 3997d7aef53216c15efa8757b67b1c40b6938313 Mon Sep 17 00:00:00 2001 From: Dana Jansens Date: Fri, 16 Apr 2010 11:46:52 -0400 Subject: [PATCH] add some comments for binary search --- obt/bsearch.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/obt/bsearch.h b/obt/bsearch.h index ca5ae5b2..65e42680 100644 --- a/obt/bsearch.h +++ b/obt/bsearch.h @@ -23,9 +23,12 @@ 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) -- 2.45.2