include/opencv2/flann/nn_index.h
Go to the documentation of this file.
00001 /***********************************************************************
00002  * Software License Agreement (BSD License)
00003  *
00004  * Copyright 2008-2009  Marius Muja (mariusm@cs.ubc.ca). All rights reserved.
00005  * Copyright 2008-2009  David G. Lowe (lowe@cs.ubc.ca). All rights reserved.
00006  *
00007  * THE BSD LICENSE
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions
00011  * are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright
00014  *    notice, this list of conditions and the following disclaimer.
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in the
00017  *    documentation and/or other materials provided with the distribution.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00020  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00021  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00022  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00023  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00024  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00025  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00026  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00028  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *************************************************************************/
00030 
00031 #ifndef _OPENCV_NNINDEX_H_
00032 #define _OPENCV_NNINDEX_H_
00033 
00034 #include <string>
00035 
00036 #include "opencv2/flann/general.h"
00037 #include "opencv2/flann/matrix.h"
00038 
00039 namespace cvflann
00040 {
00041 
00042 
00043 template <typename ELEM_TYPE>
00044 class ResultSet;
00045 
00049 template <typename ELEM_TYPE>
00050 class NNIndex
00051 {
00052 public:
00053 
00054     virtual ~NNIndex() {};
00055 
00059     virtual void buildIndex() = 0;
00060 
00064     virtual void saveIndex(FILE* stream) = 0;
00065 
00069     virtual void loadIndex(FILE* stream) = 0;
00070 
00074     virtual void findNeighbors(ResultSet<ELEM_TYPE>& result, const ELEM_TYPE* vec, const SearchParams& searchParams) = 0;
00075 
00079     virtual size_t size() const = 0;
00080 
00084     virtual size_t veclen() const = 0;
00085 
00089     virtual int usedMemory() const = 0;
00090 
00094     virtual flann_algorithm_t getType() const = 0;
00095 
00099     virtual const IndexParams* getParameters() const = 0;
00100 
00101 };
00102 
00103 
00104 } // namespace cvflann
00105 
00106 #endif //_OPENCV_NNINDEX_H_