Update to 2.0.0 tree from current Fremantle build
[opencv] / 3rdparty / flann / algorithms / composite_index.h
1 /***********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright 2008-2009  Marius Muja (mariusm@cs.ubc.ca). All rights reserved.
5  * Copyright 2008-2009  David G. Lowe (lowe@cs.ubc.ca). All rights reserved.
6  *
7  * THE BSD LICENSE
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *************************************************************************/
30
31 #ifndef COMPOSITETREE_H
32 #define COMPOSITETREE_H
33
34 #include "constants.h"
35 #include "nn_index.h"
36
37 namespace flann
38 {
39
40 class CompositeIndex : public NNIndex
41 {
42         KMeansIndex* kmeans;
43         KDTreeIndex* kdtree;
44
45     const Matrix<float> dataset;
46
47
48 public:
49
50         CompositeIndex(const Matrix<float>& inputData, const CompositeIndexParams& params = CompositeIndexParams() ) : dataset(inputData)
51         {
52                 KDTreeIndexParams kdtree_params(params.trees);
53                 KMeansIndexParams kmeans_params(params.branching, params.iterations, params.centers_init, params.cb_index);
54
55                 kdtree = new KDTreeIndex(inputData,kdtree_params);
56                 kmeans = new KMeansIndex(inputData,kmeans_params);
57
58         }
59
60         virtual ~CompositeIndex()
61         {
62                 delete kdtree;
63                 delete kmeans;
64         }
65
66
67     flann_algorithm_t getType() const
68     {
69         return COMPOSITE;
70     }
71
72
73         int size() const
74         {
75                 return dataset.rows;
76         }
77
78         int veclen() const
79         {
80                 return dataset.cols;
81         }
82
83
84         int usedMemory() const
85         {
86                 return kmeans->usedMemory()+kdtree->usedMemory();
87         }
88
89         void buildIndex()
90         {
91                 logger.info("Building kmeans tree...\n");
92                 kmeans->buildIndex();
93                 logger.info("Building kdtree tree...\n");
94                 kdtree->buildIndex();
95         }
96
97
98     void saveIndex(FILE* /*stream*/)
99     {
100
101     }
102
103
104     void loadIndex(FILE* /*stream*/)
105     {
106
107     }
108
109         void findNeighbors(ResultSet& result, const float* vec, const SearchParams& searchParams)
110         {
111                 kmeans->findNeighbors(result,vec,searchParams);
112                 kdtree->findNeighbors(result,vec,searchParams);
113         }
114
115
116 //    Params estimateSearchParams(float precision, Dataset<float>* testset = NULL)
117 //    {
118 //        Params params;
119 //
120 //        return params;
121 //    }
122
123
124 };
125
126 }
127
128 #endif //COMPOSITETREE_H