summaryrefslogtreecommitdiff
path: root/src/Bottleneck_distance/include/gudhi/Planar_neighbors_finder.h
blob: c1f4d9086188195b1da4336ad504cef05b81822b (plain)
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
/*    This file is part of the Gudhi Library. The Gudhi library
 *    (Geometric Understanding in Higher Dimensions) is a generic C++
 *    library for computational topology.
 *
 *    Author:       Francois Godi
 *
 *    Copyright (C) 2015  INRIA (France)
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    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/>.
 */

#ifndef PLANAR_NEIGHBORS_FINDER_H_
#define PLANAR_NEIGHBORS_FINDER_H_

// Inclusion order is important for CGAL patch
#include "CGAL/Kd_tree_node.h"
#include "CGAL/Kd_tree.h"
#include "CGAL/Orthogonal_incremental_neighbor_search.h"

#include <CGAL/Weighted_Minkowski_distance.h>
#include <CGAL/Search_traits.h>

#include <gudhi/Persistence_diagrams_graph.h>
#include <gudhi/Construct_coord_iterator.h>


namespace Gudhi {

namespace bottleneck_distance {

/** \internal \brief Structure used to find any point in V near (according to the planar distance) to a query point from U.
 *
 * V points have to be added manually using their index and before the first remove/pull. A neighbor pulled is automatically removed. but we can also
 * remove points manually using their index.
 *
 * \ingroup bottleneck_distance
 */
class Naive_pnf {
public:
    /** \internal \brief Constructor taking the near distance definition as parameter. */
    Naive_pnf(double r_);
    /** \internal \brief A point added will be possibly pulled. */
    void add(int v_point_index);
    /** \internal \brief A point manually removed will no longer be possibly pulled. */
    void remove(int v_point_index);
    /** \internal \brief Can the point given as parameter be returned ? */
    bool contains(int v_point_index) const;
    /** \internal \brief Provide and remove a V point near to the U point given as parameter, null_point_index() if there isn't such a point. */
    int pull_near(int u_point_index);
    /** \internal \brief Provide and remove all the V points near to the U point given as parameter. */
    std::vector<int> pull_all_near(int u_point_index);

private:
    double r;
    std::pair<int,int> get_v_key(int v_point_index) const;
    std::multimap<std::pair<int,int>,int> grid;
};

class Planar_neighbors_finder {

    typedef CGAL::Dimension_tag<2> D;
    typedef CGAL::Search_traits<double, Internal_point, const double*, CGAL::Construct_coord_iterator, D> Traits;
    typedef CGAL::Weighted_Minkowski_distance<Traits> Distance;
    typedef CGAL::Orthogonal_incremental_neighbor_search<Traits, Distance> K_neighbor_search;
    typedef K_neighbor_search::Tree Kd_tree;


public:
    /** \internal \brief Constructor taking the near distance definition as parameter. */
    Planar_neighbors_finder(double r_);
    /** \internal \brief A point added will be possibly pulled. */
    void add(int v_point_index);
    /** \internal \brief A point manually removed will no longer be possibly pulled. */
    void remove(int v_point_index);
    /** \internal \brief Can the point given as parameter be returned ? */
    bool contains(int v_point_index) const;
    /** \internal \brief Provide a V point near to the U point given as parameter, null_point_index() if there isn't such a point. */
    int pull_near(int u_point_index);
    /** \internal \brief Provide and remove all the V points near to the U point given as parameter. */
    virtual std::vector<int> pull_all_near(int u_point_index);

private:
    double r;
    std::set<int> contents;
    Kd_tree kd_t;
};


/** \internal \brief Constructor taking the near distance definition as parameter. */
inline Planar_neighbors_finder::Planar_neighbors_finder(double r_)
    : r(r_), contents(), kd_t() {}


/** \internal \brief A point added will be possibly pulled. */
inline void Planar_neighbors_finder::add(int v_point_index){
    if(v_point_index == null_point_index())
        return;
    contents.insert(v_point_index);
    kd_t.insert(G::get_v_point(v_point_index));
}

/** \internal \brief A point manually removed will no longer be possibly pulled. */
inline void Planar_neighbors_finder::remove(int v_point_index){
        contents.erase(v_point_index);
        kd_t.remove(G::get_v_point(v_point_index));
}

/** \internal \brief Can the point given as parameter be returned ? */
inline bool Planar_neighbors_finder::contains(int v_point_index) const{
    if(v_point_index == null_point_index())
        return false;
    return contents.count(v_point_index)>0;
}

/** \internal \brief Provide and remove a V point near to the U point given as parameter, null_point_index() if there isn't such a point. */
inline int Planar_neighbors_finder::pull_near(int u_point_index){
    Internal_point u_point = G::get_u_point(u_point_index);
    std::vector<double> w = {1., 1.};
    K_neighbor_search search(kd_t, u_point, 0., true, Distance(0, 2, w));
    auto it = search.begin();
    if(it==search.end() || G::distance(u_point_index, it->first.point_index) > r)
        return null_point_index();
    int tmp = it->first.point_index;
    if(!contains(tmp))
        std::cout << "!! A kd_tree returns a point (Point_index:" << tmp << ") previously removed !!" << std::endl;
    remove(tmp);
    return tmp;
}

inline std::vector<int> Planar_neighbors_finder::pull_all_near(int u_point_index) {
    std::vector<int> all_pull;
    int last_pull = pull_near(u_point_index);
    while (last_pull != null_point_index()) {
        all_pull.emplace_back(last_pull);
        last_pull = pull_near(u_point_index);
    }
    return all_pull;
}


}  // namespace bottleneck_distance

}  // namespace Gudhi

#endif  // PLANAR_NEIGHBORS_FINDER_H_