kd_dump.cpp
上传用户:chinafayin
上传日期:2022-04-05
资源大小:153k
文件大小:16k
源码类别:

并行计算

开发平台:

Visual C++

  1. //----------------------------------------------------------------------
  2. // File: kd_dump.cc
  3. // Programmer: David Mount
  4. // Description: Dump and Load for kd- and bd-trees
  5. // Last modified: 01/04/05 (Version 1.0)
  6. //----------------------------------------------------------------------
  7. // Copyright (c) 1997-2005 University of Maryland and Sunil Arya and
  8. // David Mount.  All Rights Reserved.
  9. // 
  10. // This software and related documentation is part of the Approximate
  11. // Nearest Neighbor Library (ANN).  This software is provided under
  12. // the provisions of the Lesser GNU Public License (LGPL).  See the
  13. // file ../ReadMe.txt for further information.
  14. // 
  15. // The University of Maryland (U.M.) and the authors make no
  16. // representations about the suitability or fitness of this software for
  17. // any purpose.  It is provided "as is" without express or implied
  18. // warranty.
  19. //----------------------------------------------------------------------
  20. // History:
  21. // Revision 0.1  03/04/98
  22. // Initial release
  23. // Revision 1.0  04/01/05
  24. // Moved dump out of kd_tree.cc into this file.
  25. // Added kd-tree load constructor.
  26. //----------------------------------------------------------------------
  27. // This file contains routines for dumping kd-trees and bd-trees and
  28. // reloading them. (It is an abuse of policy to include both kd- and
  29. // bd-tree routines in the same file, sorry.  There should be no problem
  30. // in deleting the bd- versions of the routines if they are not
  31. // desired.)
  32. //----------------------------------------------------------------------
  33. #include "kd_tree.h" // kd-tree declarations
  34. #include "bd_tree.h" // bd-tree declarations
  35. using namespace std; // make std:: available
  36. //----------------------------------------------------------------------
  37. // Constants
  38. //----------------------------------------------------------------------
  39. const int STRING_LEN = 500; // maximum string length
  40. const double EPSILON = 1E-5; // small number for float comparison
  41. enum ANNtreeType {KD_TREE, BD_TREE}; // tree types (used in loading)
  42. //----------------------------------------------------------------------
  43. // Procedure declarations
  44. //----------------------------------------------------------------------
  45. static ANNkd_ptr annReadDump( // read dump file
  46. istream &in, // input stream
  47. ANNtreeType tree_type, // type of tree expected
  48. ANNpointArray &the_pts, // new points (if applic)
  49. ANNidxArray &the_pidx, // point indices (returned)
  50. int &the_dim, // dimension (returned)
  51. int &the_n_pts, // number of points (returned)
  52. int &the_bkt_size, // bucket size (returned)
  53. ANNpoint &the_bnd_box_lo, // low bounding point
  54. ANNpoint &the_bnd_box_hi); // high bounding point
  55. static ANNkd_ptr annReadTree( // read tree-part of dump file
  56. istream &in, // input stream
  57. ANNtreeType tree_type, // type of tree expected
  58. ANNidxArray the_pidx, // point indices (modified)
  59. int &next_idx); // next index (modified)
  60. //----------------------------------------------------------------------
  61. // ANN kd- and bd-tree Dump Format
  62. // The dump file begins with a header containing the version of
  63. // ANN, an optional section containing the points, followed by
  64. // a description of the tree. The tree is printed in preorder.
  65. //
  66. // Format:
  67. // #ANN <version number> <comments> [END_OF_LINE]
  68. // points <dim> <n_pts> (point coordinates: this is optional)
  69. // 0 <xxx> <xxx> ... <xxx> (point indices and coordinates)
  70. // 1 <xxx> <xxx> ... <xxx>
  71. //   ...
  72. // tree <dim> <n_pts> <bkt_size>
  73. // <xxx> <xxx> ... <xxx> (lower end of bounding box)
  74. // <xxx> <xxx> ... <xxx> (upper end of bounding box)
  75. // If the tree is null, then a single line "null" is
  76. // output.  Otherwise the nodes of the tree are printed
  77. // one per line in preorder.  Leaves and splitting nodes 
  78. // have the following formats:
  79. // Leaf node:
  80. // leaf <n_pts> <bkt[0]> <bkt[1]> ... <bkt[n-1]>
  81. // Splitting nodes:
  82. // split <cut_dim> <cut_val> <lo_bound> <hi_bound>
  83. //
  84. // For bd-trees:
  85. //
  86. // Shrinking nodes:
  87. // shrink <n_bnds>
  88. // <cut_dim> <cut_val> <side>
  89. // <cut_dim> <cut_val> <side>
  90. // ... (repeated n_bnds times)
  91. //----------------------------------------------------------------------
  92. void ANNkd_tree::Dump( // dump entire tree
  93. ANNbool with_pts, // print points as well?
  94. ostream &out) // output stream
  95. {
  96. out << "#ANN " << ANNversion << "n";
  97. out.precision(ANNcoordPrec); // use full precision in dumping
  98. if (with_pts) { // print point coordinates
  99. out << "points " << dim << " " << n_pts << "n";
  100. for (int i = 0; i < n_pts; i++) {
  101. out << i << " ";
  102. annPrintPt(pts[i], dim, out);
  103. out << "n";
  104. }
  105. }
  106. out << "tree " // print tree elements
  107. << dim << " "
  108. << n_pts << " "
  109. << bkt_size << "n";
  110. annPrintPt(bnd_box_lo, dim, out); // print lower bound
  111. out << "n";
  112. annPrintPt(bnd_box_hi, dim, out); // print upper bound
  113. out << "n";
  114. if (root == NULL) // empty tree?
  115. out << "nulln";
  116. else {
  117. root->dump(out); // invoke printing at root
  118. }
  119. out.precision(0); // restore default precision
  120. }
  121. void ANNkd_split::dump( // dump a splitting node
  122. ostream &out) // output stream
  123. {
  124. out << "split " << cut_dim << " " << cut_val << " ";
  125. out << cd_bnds[ANN_LO] << " " << cd_bnds[ANN_HI] << "n";
  126. child[ANN_LO]->dump(out); // print low child
  127. child[ANN_HI]->dump(out); // print high child
  128. }
  129. void ANNkd_leaf::dump( // dump a leaf node
  130. ostream &out) // output stream
  131. {
  132. if (this == KD_TRIVIAL) { // canonical trivial leaf node
  133. out << "leaf 0n"; // leaf no points
  134. }
  135. else{
  136. out << "leaf " << n_pts;
  137. for (int j = 0; j < n_pts; j++) {
  138. out << " " << bkt[j];
  139. }
  140. out << "n";
  141. }
  142. }
  143. void ANNbd_shrink::dump( // dump a shrinking node
  144. ostream &out) // output stream
  145. {
  146. out << "shrink " << n_bnds << "n";
  147. for (int j = 0; j < n_bnds; j++) {
  148. out << bnds[j].cd << " " << bnds[j].cv << " " << bnds[j].sd << "n";
  149. }
  150. child[ANN_IN]->dump(out); // print in-child
  151. child[ANN_OUT]->dump(out); // print out-child
  152. }
  153. //----------------------------------------------------------------------
  154. // Load kd-tree from dump file
  155. // This rebuilds a kd-tree which was dumped to a file.  The dump
  156. // file contains all the basic tree information according to a
  157. // preorder traversal.  We assume that the dump file also contains
  158. // point data.  (This is to guarantee the consistency of the tree.)
  159. // If not, then an error is generated.
  160. //
  161. // Indirectly, this procedure allocates space for points, point
  162. // indices, all nodes in the tree, and the bounding box for the
  163. // tree.  When the tree is destroyed, all but the points are
  164. // deallocated.
  165. //
  166. // This routine calls annReadDump to do all the work.
  167. //----------------------------------------------------------------------
  168. ANNkd_tree::ANNkd_tree( // build from dump file
  169. istream &in) // input stream for dump file
  170. {
  171. int the_dim; // local dimension
  172. int the_n_pts; // local number of points
  173. int the_bkt_size; // local number of points
  174. ANNpoint the_bnd_box_lo; // low bounding point
  175. ANNpoint the_bnd_box_hi; // high bounding point
  176. ANNpointArray the_pts; // point storage
  177. ANNidxArray the_pidx; // point index storage
  178. ANNkd_ptr the_root; // root of the tree
  179. the_root = annReadDump( // read the dump file
  180. in, // input stream
  181. KD_TREE, // expecting a kd-tree
  182. the_pts, // point array (returned)
  183. the_pidx, // point indices (returned)
  184. the_dim, the_n_pts, the_bkt_size, // basic tree info (returned)
  185. the_bnd_box_lo, the_bnd_box_hi); // bounding box info (returned)
  186. // create a skeletal tree
  187. SkeletonTree(the_n_pts, the_dim, the_bkt_size, the_pts, the_pidx);
  188. bnd_box_lo = the_bnd_box_lo;
  189. bnd_box_hi = the_bnd_box_hi;
  190. root = the_root; // set the root
  191. }
  192. ANNbd_tree::ANNbd_tree( // build bd-tree from dump file
  193. istream &in) : ANNkd_tree() // input stream for dump file
  194. {
  195. int the_dim; // local dimension
  196. int the_n_pts; // local number of points
  197. int the_bkt_size; // local number of points
  198. ANNpoint the_bnd_box_lo; // low bounding point
  199. ANNpoint the_bnd_box_hi; // high bounding point
  200. ANNpointArray the_pts; // point storage
  201. ANNidxArray the_pidx; // point index storage
  202. ANNkd_ptr the_root; // root of the tree
  203. the_root = annReadDump( // read the dump file
  204. in, // input stream
  205. BD_TREE, // expecting a bd-tree
  206. the_pts, // point array (returned)
  207. the_pidx, // point indices (returned)
  208. the_dim, the_n_pts, the_bkt_size, // basic tree info (returned)
  209. the_bnd_box_lo, the_bnd_box_hi); // bounding box info (returned)
  210. // create a skeletal tree
  211. SkeletonTree(the_n_pts, the_dim, the_bkt_size, the_pts, the_pidx);
  212. bnd_box_lo = the_bnd_box_lo;
  213. bnd_box_hi = the_bnd_box_hi;
  214. root = the_root; // set the root
  215. }
  216. //----------------------------------------------------------------------
  217. // annReadDump - read a dump file
  218. //
  219. // This procedure reads a dump file, constructs a kd-tree
  220. // and returns all the essential information needed to actually
  221. // construct the tree.  Because this procedure is used for
  222. // constructing both kd-trees and bd-trees, the second argument
  223. // is used to indicate which type of tree we are expecting.
  224. //----------------------------------------------------------------------
  225. static ANNkd_ptr annReadDump(
  226. istream &in, // input stream
  227. ANNtreeType tree_type, // type of tree expected
  228. ANNpointArray &the_pts, // new points (returned)
  229. ANNidxArray &the_pidx, // point indices (returned)
  230. int &the_dim, // dimension (returned)
  231. int &the_n_pts, // number of points (returned)
  232. int &the_bkt_size, // bucket size (returned)
  233. ANNpoint &the_bnd_box_lo, // low bounding point (ret'd)
  234. ANNpoint &the_bnd_box_hi) // high bounding point (ret'd)
  235. {
  236. int j;
  237. char str[STRING_LEN]; // storage for string
  238. char version[STRING_LEN]; // ANN version number
  239. ANNkd_ptr the_root = NULL;
  240. //------------------------------------------------------------------
  241. // Input file header
  242. //------------------------------------------------------------------
  243. in >> str; // input header
  244. if (strcmp(str, "#ANN") != 0) { // incorrect header
  245. annError("Incorrect header for dump file", ANNabort);
  246. }
  247. in.getline(version, STRING_LEN); // get version (ignore)
  248. //------------------------------------------------------------------
  249. // Input the points
  250. // An array the_pts is allocated and points are read from
  251. // the dump file.
  252. //------------------------------------------------------------------
  253. in >> str; // get major heading
  254. if (strcmp(str, "points") == 0) { // points section
  255. in >> the_dim; // input dimension
  256. in >> the_n_pts; // number of points
  257. // allocate point storage
  258. the_pts = annAllocPts(the_n_pts, the_dim);
  259. for (int i = 0; i < the_n_pts; i++) { // input point coordinates
  260. ANNidx idx; // point index
  261. in >> idx; // input point index
  262. if (idx < 0 || idx >= the_n_pts) {
  263. annError("Point index is out of range", ANNabort);
  264. }
  265. for (j = 0; j < the_dim; j++) {
  266. in >> the_pts[idx][j]; // read point coordinates
  267. }
  268. }
  269. in >> str; // get next major heading
  270. }
  271. else { // no points were input
  272. annError("Points must be supplied in the dump file", ANNabort);
  273. }
  274. //------------------------------------------------------------------
  275. // Input the tree
  276. // After the basic header information, we invoke annReadTree
  277. // to do all the heavy work.  We create our own array of
  278. // point indices (so we can pass them to annReadTree())
  279. // but we do not deallocate them. They will be deallocated
  280. // when the tree is destroyed.
  281. //------------------------------------------------------------------
  282. if (strcmp(str, "tree") == 0) { // tree section
  283. in >> the_dim; // read dimension
  284. in >> the_n_pts; // number of points
  285. in >> the_bkt_size; // bucket size
  286. the_bnd_box_lo = annAllocPt(the_dim); // allocate bounding box pts
  287. the_bnd_box_hi = annAllocPt(the_dim);
  288. for (j = 0; j < the_dim; j++) { // read bounding box low
  289. in >> the_bnd_box_lo[j];
  290. }
  291. for (j = 0; j < the_dim; j++) { // read bounding box low
  292. in >> the_bnd_box_hi[j];
  293. }
  294. the_pidx = new ANNidx[the_n_pts]; // allocate point index array
  295. int next_idx = 0; // number of indices filled
  296. // read the tree and indices
  297. the_root = annReadTree(in, tree_type, the_pidx, next_idx);
  298. if (next_idx != the_n_pts) { // didn't see all the points?
  299. annError("Didn't see as many points as expected", ANNwarn);
  300. }
  301. }
  302. else {
  303. annError("Illegal dump format. Expecting section heading", ANNabort);
  304. }
  305. return the_root;
  306. }
  307. //----------------------------------------------------------------------
  308. // annReadTree - input tree and return pointer
  309. //
  310. // annReadTree reads in a node of the tree, makes any recursive
  311. // calls as needed to input the children of this node (if internal).
  312. // It returns a pointer to the node that was created. An array
  313. // of point indices is given along with a pointer to the next
  314. // available location in the array.  As leaves are read, their
  315. // point indices are stored here, and the point buckets point
  316. // to the first entry in the array.
  317. //
  318. // Recall that these are the formats. The tree is given in
  319. // preorder.
  320. //
  321. // Leaf node:
  322. // leaf <n_pts> <bkt[0]> <bkt[1]> ... <bkt[n-1]>
  323. // Splitting nodes:
  324. // split <cut_dim> <cut_val> <lo_bound> <hi_bound>
  325. //
  326. // For bd-trees:
  327. //
  328. // Shrinking nodes:
  329. // shrink <n_bnds>
  330. // <cut_dim> <cut_val> <side>
  331. // <cut_dim> <cut_val> <side>
  332. // ... (repeated n_bnds times)
  333. //----------------------------------------------------------------------
  334. static ANNkd_ptr annReadTree(
  335. istream &in, // input stream
  336. ANNtreeType tree_type, // type of tree expected
  337. ANNidxArray the_pidx, // point indices (modified)
  338. int &next_idx) // next index (modified)
  339. {
  340. char tag[STRING_LEN]; // tag (leaf, split, shrink)
  341. int n_pts; // number of points in leaf
  342. int cd; // cut dimension
  343. ANNcoord cv; // cut value
  344. ANNcoord lb; // low bound
  345. ANNcoord hb; // high bound
  346. int n_bnds; // number of bounding sides
  347. int sd; // which side
  348. in >> tag; // input node tag
  349. if (strcmp(tag, "null") == 0) { // null tree
  350. return NULL;
  351. }
  352. //------------------------------------------------------------------
  353. // Read a leaf
  354. //------------------------------------------------------------------
  355. if (strcmp(tag, "leaf") == 0) { // leaf node
  356. in >> n_pts; // input number of points
  357. int old_idx = next_idx; // save next_idx
  358. if (n_pts == 0) { // trivial leaf
  359. return KD_TRIVIAL;
  360. }
  361. else {
  362. for (int i = 0; i < n_pts; i++) { // input point indices
  363. in >> the_pidx[next_idx++]; // store in array of indices
  364. }
  365. }
  366. return new ANNkd_leaf(n_pts, &the_pidx[old_idx]);
  367. }
  368. //------------------------------------------------------------------
  369. // Read a splitting node
  370. //------------------------------------------------------------------
  371. else if (strcmp(tag, "split") == 0) { // splitting node
  372. in >> cd >> cv >> lb >> hb;
  373. // read low and high subtrees
  374. ANNkd_ptr lc = annReadTree(in, tree_type, the_pidx, next_idx);
  375. ANNkd_ptr hc = annReadTree(in, tree_type, the_pidx, next_idx);
  376. // create new node and return
  377. return new ANNkd_split(cd, cv, lb, hb, lc, hc);
  378. }
  379. //------------------------------------------------------------------
  380. // Read a shrinking node (bd-tree only)
  381. //------------------------------------------------------------------
  382. else if (strcmp(tag, "shrink") == 0) { // shrinking node
  383. if (tree_type != BD_TREE) {
  384. annError("Shrinking node not allowed in kd-tree", ANNabort);
  385. }
  386. in >> n_bnds; // number of bounding sides
  387. // allocate bounds array
  388. ANNorthHSArray bds = new ANNorthHalfSpace[n_bnds];
  389. for (int i = 0; i < n_bnds; i++) {
  390. in >> cd >> cv >> sd; // input bounding halfspace
  391. // copy to array
  392. bds[i] = ANNorthHalfSpace(cd, cv, sd);
  393. }
  394. // read inner and outer subtrees
  395. ANNkd_ptr ic = annReadTree(in, tree_type, the_pidx, next_idx);
  396. ANNkd_ptr oc = annReadTree(in, tree_type, the_pidx, next_idx);
  397. // create new node and return
  398. return new ANNbd_shrink(n_bnds, bds, ic, oc);
  399. }
  400. else {
  401. annError("Illegal node type in dump file", ANNabort);
  402. exit(0); // to keep the compiler happy
  403. }
  404. }