fixed bug in driver related to text input; fixed bugs related to size_t
[RBC.git] / readme.txt
index c513ebf..7eb80cb 100644 (file)
@@ -1,4 +1,4 @@
-***Random Ball Cover (RBC) v0.2***
+ ***Random Ball Cover (RBC) v0.2.4***
 Lawrence Cayton
 lcayton@tuebingen.mpg.de
 
@@ -17,17 +17,54 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+
 ---------------------------------------------------------------------
 SUMMARY
 
 This is a C and CUDA implementation of the Random Ball Cover data 
-structure for nearest neighbor search described in 
+structure for fast nearest neighbor search on a GPU.  The code
+implements the one-shot algorithm.
+
+See the following papers for a detailed description of the search
+algorithm and the theory behind it.
 
-L. Cayton, A nearest neighbor data structure for graphics hardware.
+L. Cayton, A nearest neighbor data structure for graphics hardware.
 ADMS, 2010.
+* L. Cayton, Accelerating nearest neighbor search on manycore systems.
+Submitted, 2011. 
+
+
+---------------------------------------------------------------------
+COMPILATION
+
+Type make in a shell.  Requires GCC and NVCC (CUDA).  The code has
+been developed under GCC 4.4 and CUDA 3.1.
+
+
+---------------------------------------------------------------------
+USE
+
+A sample driver is provided for the RBC.  To try it out, type
+$ testRBC
+at the prompt and a list of options will be displayed.
+
+The output file format is a list of the queries' NNs,
+followed by a list of the distances to those NNs.  Note that by
+default, all input and output is stored in single-precision (float)
+format.  
 
-L. Cayton, Accelerating nearest neighbor search on manycore systems.
-Submitted. 
+Basic functionality is provided through this driver, but I recommend
+integrating the RBC code directly into your code for the best
+results.  For many applications, the RBC needs to be built only once,
+and then can be queried many times. 
+
+The method requires a single parameter, the number of
+representatives.  This parameter allows you to trade-off between
+search quality and search speed.  The best way to set this parameter
+is to try a few different values out; a good starting point is
+generally 5*sqrt(n), where n is the number of database points.  Use
+the eval option (-e) to print out the error rate.  See the paper
+(Cayton, 2011) for detailed information on this parameter. 
 
 
 ---------------------------------------------------------------------
@@ -50,47 +87,15 @@ FILES
 * utilsGPU.{h,cu} -- misc utilities related to the GPU.
 
 
----------------------------------------------------------------------
-COMPILATION
-
-Type make in a shell.  Requires GCC and NVCC (CUDA).  The code has
-been tested under GCC 4.4 and CUDA 3.1.
-
-
----------------------------------------------------------------------
-USE
-
-To use the RBC data structure, you will likely need to integrate this
-code into your own.  The driver.cu file provides an example of how to
-use the RBC implementation.  To try it out, type
->testRBC
-at the prompt and a list of options will be displayed.  Currently, the
-test program assumes that the input is a single binary file, which it
-then splits into queries and a the database randomly.  Clearly, such a
-setup is only useful for testing the performance of the data
-structure.  To use the data structure in a more useful fashion, you
-may wish to call the readData function on separate files.  There is
-also a readDataText function in the driver.cu for your convenience.  
-
-The core of the implementation is in rbc.cu and in the kernel files.
-There is a buildRBC function, a queryRBC function, and a kqueryRBC
-function, which together should suffice for basic use of the data
-structure.   
-
-Currently, the kernel functions are reasonably optimized, but can be
-improved.  Indeed, the results appearing in the ADMS paper came from a
-slightly more optimized version than this one. 
-
-
 ---------------------------------------------------------------------
 MISC NOTES ON THE CODE
 
-* The code currently computes distance using the L_1 (manhattan)
+* The code currently computes distance using the L_2 (Euclidean)
   metric.  If you wish to use a different notion of distance, you must
   modify defs.h.  It is quite simple to switch to any metric that 
   operates alongs the coordinates independently (eg, any L_p metric),
-  but more complex metrics will require some aditional work.  The L_2
-  metric (standard Euclidean distance) is already defined in defs.h.  
+  but more complex metrics will require some aditional work.  The L_1
+  metric (manhatten distance) is already defined in defs.h.  
 
 * The k-NN code is currently hard-coded for k=32.  It is hard-coded
   because it uses a manually implemented sorting network. This design
@@ -102,6 +107,22 @@ MISC NOTES ON THE CODE
 * The code requires that the entire DB and query set fit into the 
   device memory.  
 
+* Currently the software works in single precision.  If you wish to 
+  switch to double precision, you must edit the defs.h file.  Simply 
+  uncomment the lines
+
+typedef double real;
+#define MAX_REAL DBL_MAX
+
+  and comment out the lines
+
+typedef float real;
+#define MAX_REAL FLT_MAX
+
+  Then, you must do a 
+$ make clean
+  followed by another make.
+
 * For the most part, device variables (ie arrays residing on the GPU)
   begin with a lowercase d.  For example, the device version of the 
   DB variable x is dx.  
@@ -117,36 +138,17 @@ MISC NOTES ON THE CODE
   would require only minor changes to the code, though is currently 
   untested.
 
-* Currently the software works in single precision.  If you wish to 
-  switch to double precision, you must edit the defs.h file.  Simply 
-  uncomment the lines
-
-typedef double real;
-#define MAX_REAL DBL_MAX
-
-and comment out the lines
-
-typedef float real;
-#define MAX_REAL FLT_MAX
-
-Then, you must do a 
-
-make clean
-
-followed by another make.
-
 * This software has been tested on the following graphics cards:
-  NVIDIA GTX 285
-  NVIDIA Tesla c2050.
+  NVIDIA GTX 285, GT 430, GTX 480, GeForce 320M, Tesla c2050
 
-* This sotware has been tested under the following software setup:
+* This sotware has been developed under the following software setup:
   Ubuntu 10.04 (linux)
   gcc 4.4
-  cuda 3.1
-
-  Please share your experience getting it to work under Windows and
-  Mac OSX!
+  cuda 3.2
 
+  It has also been tested under Mac OSX.  Please share your
+  experience getting it to work under Windows!
 * If you are running this code on a GPU which is also driving your
   display: A well-known issue with CUDA code in this situation is that 
   a process within the operating system will automatically kill