1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
|
// Copyright (c) 2002,2011 Utrecht University (The Netherlands).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org).
//
// $URL: https://github.com/CGAL/cgal/blob/v6.1/Spatial_searching/include/CGAL/Kd_tree_node.h $
// $Id: include/CGAL/Kd_tree_node.h b26b07a1242 $
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-Commercial
//
//
// Authors : Hans Tangelder (<hanst@cs.uu.nl>)
#ifndef CGAL_KD_TREE_NODE_H
#define CGAL_KD_TREE_NODE_H
#include <CGAL/license/Spatial_searching.h>
#include <unordered_map>
#include <ostream>
#include <CGAL/Splitters.h>
#include <CGAL/Compact_container.h>
#include <CGAL/Has_member.h>
#include <CGAL/Spatial_searching/internal/Search_helpers.h>
#include <cstdint>
namespace CGAL {
CGAL_GENERATE_MEMBER_DETECTOR(contains_point_given_as_coordinates);
template <class SearchTraits, class Splitter, class UseExtendedNode, class EnablePointsCache>
class Kd_tree;
template < class TreeTraits, class Splitter, class UseExtendedNode, class EnablePointsCache >
class Kd_tree_node {
friend class Kd_tree<TreeTraits, Splitter, UseExtendedNode, EnablePointsCache>;
typedef Kd_tree<TreeTraits, Splitter, UseExtendedNode, EnablePointsCache> Kdt;
typedef typename Kdt::Node_handle Node_handle;
typedef typename Kdt::Node_const_handle Node_const_handle;
typedef typename Kdt::Internal_node_handle Internal_node_handle;
typedef typename Kdt::Internal_node_const_handle Internal_node_const_handle;
typedef typename Kdt::Leaf_node_handle Leaf_node_handle;
typedef typename Kdt::Leaf_node_const_handle Leaf_node_const_handle;
typedef typename TreeTraits::Point_d Point_d;
typedef typename TreeTraits::FT FT;
typedef typename Kdt::Separator Separator;
typedef typename Kdt::Point_d_iterator Point_d_iterator;
typedef typename Kdt::iterator iterator;
typedef typename Kdt::D D;
bool leaf;
public :
Kd_tree_node(bool leaf) : leaf(leaf) { }
bool is_leaf() const { return leaf; }
void
get_indices(int& index, std::unordered_map<const Kd_tree_node*, int>& node_to_index) const
{
if (is_leaf()) {
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
++index;
node_to_index[node] = index;
} else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
++index;
node_to_index[node] = index;
node->lower()->get_indices(index, node_to_index);
node->upper()->get_indices(index, node_to_index);
}
}
template<typename Node_name>
void
print(std::ostream& s, const Node_name& node_name) const
{
if (is_leaf()) { // draw leaf nodes
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
s << std::endl;
if (node->size() > 0) {
s << node_name(node) << " [label=\"" << node_name(node) << ", Size: "
<< node->size() << "\"] ;" << std::endl;
} else {
CGAL_assertion_msg(false, "ERROR: NODE SIZE IS ZERO!");
}
} else { // draw internal nodes
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
s << std::endl;
s << node_name(node) << " [label=\"" << node_name(node) << "\"] ;" << std::endl;
s << node_name(node) << " -- " << node_name(node->lower()) << " ;";
node->lower()->print(s, node_name);
s << node_name(node) << " -- " << node_name(node->upper()) << " ;";
node->upper()->print(s, node_name);
}
}
std::size_t
num_items() const
{
if (is_leaf()){
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
return node->size();
}
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
return node->lower()->num_items() + node->upper()->num_items();
}
}
std::size_t
num_nodes() const
{
if (is_leaf()) return 1;
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
return node->lower()->num_nodes() + node->upper()->num_nodes();
}
}
int
depth(const int current_max_depth) const
{
if (is_leaf()){
return current_max_depth;
}
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
return
(std::max)( node->lower()->depth(current_max_depth + 1),
node->upper()->depth(current_max_depth + 1));
}
}
int
depth() const
{
return depth(1);
}
template <class OutputIterator>
OutputIterator
tree_items(OutputIterator it) const {
if (is_leaf()) {
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
if (node->size()>0)
for (iterator i=node->begin(); i != node->end(); i++)
{*it=*i; ++it;}
}
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
it=node->lower()->tree_items(it);
it=node->upper()->tree_items(it);
}
return it;
}
std::optional<Point_d>
any_tree_item() const {
std::optional<Point_d> result = std::nullopt;
if (is_leaf()) {
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
if (node->size()>0){
return std::make_optional(*(node->begin()));
}
}
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
result = node->lower()->any_tree_item();
if(! result){
result = node->upper()->any_tree_item();
}
}
return result;
}
void
indent(int d) const
{
for(int i = 0; i < d; i++){
std::cout << " ";
}
}
void
print(int d = 0) const
{
if (is_leaf()) {
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
indent(d);
std::cout << "leaf" << std::endl;
if (node->size()>0)
for (iterator i=node->begin(); i != node->end(); i++)
{indent(d);std::cout << *i << std::endl;}
}
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
indent(d);
std::cout << "lower tree" << std::endl;
node->lower()->print(d+1);
indent(d);
std::cout << "separator: dim = " << node->cutting_dimension() << " val = " << node->cutting_value() << std::endl;
indent(d);
std::cout << "upper tree" << std::endl;
node->upper()->print(d+1);
}
}
template <class OutputIterator, class FuzzyQueryItem>
OutputIterator
search(OutputIterator it, const FuzzyQueryItem& q,
Kd_tree_rectangle<FT,D>& b,
typename Kdt::const_iterator tree_points_begin,
typename std::vector<FT>::const_iterator cache_begin,
int dim) const
{
if (is_leaf()) {
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
if (node->size() > 0)
{
typename internal::Has_points_cache<Kdt, internal::has_Enable_points_cache<Kdt>::type::value>::type dummy;
it = search_in_leaf(node, q, tree_points_begin, cache_begin, dim, it, dummy);
}
}
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
// after splitting b denotes the lower part of b
Kd_tree_rectangle<FT,D> b_upper(b);
node->split_bbox(b, b_upper);
if (q.outer_range_contains(b))
it=node->lower()->tree_items(it);
else
if (q.inner_range_intersects(b))
it=node->lower()->search(it,q,b,tree_points_begin,cache_begin,dim);
if (q.outer_range_contains(b_upper))
it=node->upper()->tree_items(it);
else
if (q.inner_range_intersects(b_upper))
it=node->upper()->search(it,q,b_upper,tree_points_begin,cache_begin,dim);
};
return it;
}
template <class FuzzyQueryItem>
std::optional<Point_d>
search_any_point(const FuzzyQueryItem& q,
Kd_tree_rectangle<FT,D>& b,
typename Kdt::const_iterator tree_points_begin,
typename std::vector<FT>::const_iterator cache_begin,
int dim) const
{
std::optional<Point_d> result = std::nullopt;
if (is_leaf()) {
Leaf_node_const_handle node =
static_cast<Leaf_node_const_handle>(this);
if (node->size()>0)
{
typename internal::Has_points_cache<Kdt, internal::has_Enable_points_cache<Kdt>::type::value>::type dummy;
result = search_any_point_in_leaf(node, q, tree_points_begin, cache_begin, dim, dummy);
}
}
else {
Internal_node_const_handle node =
static_cast<Internal_node_const_handle>(this);
// after splitting b denotes the lower part of b
Kd_tree_rectangle<FT,D> b_upper(b);
node->split_bbox(b, b_upper);
if (q.inner_range_intersects(b)) {
result = node->lower()->search_any_point(q,b,tree_points_begin,cache_begin,dim);
if(result)
return result;
}
if (q.inner_range_intersects(b_upper))
result = node->upper()->search_any_point(q,b_upper,tree_points_begin,cache_begin,dim);
}
return result;
}
private:
// If contains_point_given_as_coordinates does not exist in `FuzzyQueryItem`
template <typename FuzzyQueryItem>
bool contains(
const FuzzyQueryItem& q,
Point_d const& p,
typename std::vector<FT>::const_iterator /*it_coord_begin*/,
typename std::vector<FT>::const_iterator /*it_coord_end*/,
Tag_false /*has_contains_point_given_as_coordinates*/) const
{
return q.contains(p);
}
// ... or if it exists
template <typename FuzzyQueryItem>
bool contains(
const FuzzyQueryItem& q,
Point_d const& /*p*/,
typename std::vector<FT>::const_iterator it_coord_begin,
typename std::vector<FT>::const_iterator it_coord_end,
Tag_true /*has_contains_point_given_as_coordinates*/) const
{
return q.contains_point_given_as_coordinates(it_coord_begin, it_coord_end);
}
// With cache
template<class FuzzyQueryItem, class OutputIterator>
OutputIterator search_in_leaf(
Leaf_node_const_handle node,
const FuzzyQueryItem &q,
typename Kdt::const_iterator tree_points_begin,
typename std::vector<FT>::const_iterator cache_begin,
int dim,
OutputIterator oit,
Tag_true /*has_points_cache*/) const
{
typename Kdt::iterator it_node_point = node->begin(), it_node_point_end = node->end();
typename std::vector<FT>::const_iterator cache_point_it = cache_begin + dim*(it_node_point - tree_points_begin);
for (; it_node_point != it_node_point_end; ++it_node_point, cache_point_it += dim)
{
Boolean_tag<has_contains_point_given_as_coordinates<FuzzyQueryItem>::value> dummy;
if (contains(q, *it_node_point, cache_point_it, cache_point_it + dim, dummy))
*oit++ = *it_node_point;
}
return oit;
}
// Without cache
template<class FuzzyQueryItem, class OutputIterator>
OutputIterator search_in_leaf(
Leaf_node_const_handle node,
const FuzzyQueryItem &q,
typename Kdt::const_iterator /*tree_points_begin*/,
typename std::vector<FT>::const_iterator /*cache_begin*/,
int /*dim*/,
OutputIterator oit,
Tag_false /*has_points_cache*/) const
{
for (iterator i = node->begin(); i != node->end(); ++i)
{
if (q.contains(*i))
*oit++ = *i;
}
return oit;
}
// With cache
template<class FuzzyQueryItem>
std::optional<Point_d> search_any_point_in_leaf(
Leaf_node_const_handle node,
const FuzzyQueryItem &q,
typename Kdt::const_iterator tree_points_begin,
typename std::vector<FT>::const_iterator cache_begin,
int dim,
Tag_true /*has_points_cache*/) const
{
std::optional<Point_d> result = std::nullopt;
typename Kdt::iterator it_node_point = node->begin(), it_node_point_end = node->end();
typename std::vector<FT>::const_iterator cache_point_it = cache_begin + dim*(it_node_point - tree_points_begin);
for (; it_node_point != it_node_point_end; ++it_node_point, cache_point_it += dim)
{
Boolean_tag<has_contains_point_given_as_coordinates<FuzzyQueryItem>::value> dummy;
if (contains(q, *it_node_point, cache_point_it, cache_point_it + dim, dummy))
{
result = *it_node_point;
break;
}
}
return result;
}
// Without cache
template<class FuzzyQueryItem>
std::optional<Point_d> search_any_point_in_leaf(
Leaf_node_const_handle node,
const FuzzyQueryItem &q,
typename Kdt::const_iterator /*tree_points_begin*/,
typename std::vector<FT>::const_iterator /*cache_begin*/,
int /*dim*/,
Tag_false /*has_points_cache*/) const
{
std::optional<Point_d> result = std::nullopt;
for (iterator i = node->begin(); i != node->end(); ++i)
{
if (q.contains(*i))
{
result = *i;
break;
}
}
return result;
}
};
template < class TreeTraits, class Splitter, class UseExtendedNode, class EnablePointsCache >
class Kd_tree_leaf_node : public Kd_tree_node< TreeTraits, Splitter, UseExtendedNode, EnablePointsCache >{
friend class Kd_tree<TreeTraits, Splitter, UseExtendedNode, EnablePointsCache>;
typedef typename Kd_tree<TreeTraits, Splitter, UseExtendedNode, EnablePointsCache>::iterator iterator;
typedef Kd_tree_node< TreeTraits, Splitter, UseExtendedNode, EnablePointsCache> Base;
typedef typename TreeTraits::Point_d Point_d;
private:
// private variables for leaf nodes
std::int32_t n; // denotes number of items in a leaf node
iterator data; // iterator to data in leaf node
public:
// default constructor
Kd_tree_leaf_node()
: Base(true)
{}
Kd_tree_leaf_node(unsigned int n_ )
: Base(true), n(n_)
{}
// members for all nodes
// members for leaf nodes only
inline
unsigned int
size() const
{
return n;
}
inline
iterator
begin() const
{
return data;
}
inline
iterator
end() const
{
return data + n;
}
inline
void
drop_last_point()
{
--n;
}
}; //leaf node
template < class TreeTraits, class Splitter, class UseExtendedNode, class EnablePointsCache>
class Kd_tree_internal_node : public Kd_tree_node< TreeTraits, Splitter, UseExtendedNode, EnablePointsCache >{
friend class Kd_tree<TreeTraits, Splitter, UseExtendedNode, EnablePointsCache>;
typedef Kd_tree<TreeTraits, Splitter, UseExtendedNode, EnablePointsCache> Kdt;
typedef Kd_tree_node< TreeTraits, Splitter, UseExtendedNode, EnablePointsCache> Base;
typedef typename Kdt::Node_handle Node_handle;
typedef typename Kdt::Node_const_handle Node_const_handle;
typedef typename TreeTraits::FT FT;
typedef typename Kdt::Separator Separator;
typedef typename Kdt::D D;
private:
// private variables for internal nodes
std::int32_t cut_dim;
FT cut_val;
Node_handle lower_ch, upper_ch;
// private variables for extended internal nodes
FT upper_low_val;
FT upper_high_val;
FT lower_low_val;
FT lower_high_val;
public:
// default constructor
Kd_tree_internal_node()
: Base(false), cut_dim(-1), cut_val(0)
, lower_ch (nullptr), upper_ch (nullptr)
, upper_low_val(0), upper_high_val(0)
, lower_low_val(0), lower_high_val(0)
{}
// members for internal node and extended internal node
inline
Node_const_handle
lower() const
{
return lower_ch;
}
inline
Node_const_handle
upper() const
{
return upper_ch;
}
inline
Node_handle
lower()
{
return lower_ch;
}
inline
Node_handle
upper()
{
return upper_ch;
}
inline
void
set_lower(Node_handle nh)
{
lower_ch = nh;
}
inline
void
set_upper(Node_handle nh)
{
upper_ch = nh;
}
// inline Separator& separator() {return sep; }
// use instead
inline
void set_separator(Separator& sep){
cut_dim = sep.cutting_dimension();
cut_val = sep.cutting_value();
}
inline
FT
cutting_value() const
{
return cut_val;
}
inline
int
cutting_dimension() const
{
return cut_dim;
}
// members for extended internal node only
inline
FT
upper_low_value() const
{
return upper_low_val;
}
inline
FT
upper_high_value() const
{
return upper_high_val;
}
inline
FT
lower_low_value() const
{
return lower_low_val;
}
inline
FT
lower_high_value() const
{
return lower_high_val;
}
/*Separator&
separator()
{
return Separator(cutting_dimension,cutting_value);
}*/
void split_bbox(Kd_tree_rectangle<FT,D>& l, Kd_tree_rectangle<FT,D>& u) const {
l.lower()[cut_dim]=lower_low_val;
l.upper()[cut_dim]=lower_high_val;
u.lower()[cut_dim]=upper_low_val;
u.upper()[cut_dim]=upper_high_val;
}
};//internal node
template < class TreeTraits, class Splitter, class EnablePointsCache>
class Kd_tree_internal_node<TreeTraits,Splitter,Tag_false,EnablePointsCache>
: public Kd_tree_node< TreeTraits, Splitter, Tag_false, EnablePointsCache >
{
friend class Kd_tree<TreeTraits, Splitter, Tag_false, EnablePointsCache>;
typedef Kd_tree<TreeTraits, Splitter, Tag_false, EnablePointsCache> Kdt;
typedef Kd_tree_node< TreeTraits, Splitter, Tag_false, EnablePointsCache> Base;
typedef typename Kdt::Node_handle Node_handle;
typedef typename Kdt::Node_const_handle Node_const_handle;
typedef typename TreeTraits::FT FT;
typedef typename Kdt::Separator Separator;
typedef typename Kdt::D D;
private:
// private variables for internal nodes
std::uint8_t cut_dim;
FT cut_val;
Node_handle lower_ch, upper_ch;
public:
// default constructor
Kd_tree_internal_node()
: Base(false)
{}
// members for internal node and extended internal node
inline
Node_const_handle
lower() const
{
return lower_ch;
}
inline
Node_const_handle
upper() const
{
return upper_ch;
}
inline
Node_handle
lower()
{
return lower_ch;
}
inline
Node_handle
upper()
{
return upper_ch;
}
inline
void
set_lower(Node_handle nh)
{
lower_ch = nh;
}
inline
void
set_upper(Node_handle nh)
{
upper_ch = nh;
}
// inline Separator& separator() {return sep; }
// use instead
inline
void set_separator(Separator& sep){
cut_dim = static_cast<std::uint8_t>(sep.cutting_dimension());
cut_val = sep.cutting_value();
}
inline
FT
cutting_value() const
{
return cut_val;
}
inline
int
cutting_dimension() const
{
return cut_dim;
}
/* Separator&
separator()
{
return Separator(cutting_dimension,cutting_value);
}*/
void split_bbox(Kd_tree_rectangle<FT,D>& l, Kd_tree_rectangle<FT,D>& u) const {
l.upper()[cut_dim]=cut_val;
u.lower()[cut_dim]=cut_val;
}
};//internal node
} // namespace CGAL
#endif // CGAL_KDTREE_NODE_H
|