summaryrefslogtreecommitdiff
path: root/src/Simplex_tree/include/gudhi/Simplex_tree/Simplex_tree_siblings.h
blob: 6db0d80ad30f3b3176d112ed02d71c8241a7cb5f (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
 /*    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(s):       Clément Maria
  *
  *    Copyright (C) 2014  INRIA Sophia Antipolis-Méditerranée (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 GUDHI_SIMPLEX_TREE_SIBLINGS
#define GUDHI_SIMPLEX_TREE_SIBLINGS

#include "boost/container/flat_map.hpp"
#include "Simplex_tree_node_explicit_storage.h"

namespace Gudhi{

/* \addtogroup simplex_tree
  * Represents a set of node of a Simplex_tree that share the same parent.
  * @{
  */

/* \brief Data structure to store a set of nodes in a SimplexTree sharing
 * the same parent node.*/
template < class SimplexTree
         , class MapContainer >
class Simplex_tree_siblings {
// private:
//  friend SimplexTree;
public:
  template < class T > friend class Simplex_tree_simplex_vertex_iterator  ; 
  template < class T > friend class Simplex_tree_boundary_simplex_iterator;
  template < class T > friend class Simplex_tree_complex_simplex_iterator ;
  template < class T > friend class Simplex_tree_skeleton_simplex_iterator;

  typedef typename SimplexTree::Vertex_handle     Vertex_handle;
  typedef typename SimplexTree::Filtration_value  Filtration_value;
  typedef typename SimplexTree::Node              Node;
  typedef MapContainer                            Dictionary;
  typedef typename MapContainer::iterator         Dictionary_it;

  /* Default constructor.*/
  Simplex_tree_siblings() 
  : oncles_(NULL)
  , parent_(-1)
  , members_() {}
  
  /* Constructor with values.*/
  Simplex_tree_siblings(Simplex_tree_siblings  * oncles,
                        Vertex_handle            parent )
  : oncles_(oncles)
  , parent_(parent)
  , members_() {}
  
  /* \brief Constructor with initialized set of members.
    *
    * 'members' must be sorted and unique.*/
  Simplex_tree_siblings(Simplex_tree_siblings *                           oncles,
                        Vertex_handle                                     parent,
                        std::vector< std::pair< Vertex_handle, Node > > & members) 
  : oncles_ ( oncles )
  , parent_ ( parent )
  , members_ ( boost::container::ordered_unique_range
             , members.begin()
             , members.end() )
  {
    for(auto map_it = members_.begin();
        map_it != members_.end(); map_it++)
    {  map_it->second.assign_children(this);  }
  }
  
  /*
   * \brief Inserts a Node in the set of siblings nodes.
   *
   * If already present, assigns the minimal filtration value 
   * between input filtration_value and the value already 
   * present in the node.
   */
  void insert ( Vertex_handle     v
              , Filtration_value  filtration_value )
  {
    typename Dictionary::iterator sh = members_.find(v);
    if(sh != members_.end() &&  sh->second.filtration() > filtration_value)
    { sh->second.assign_filtration(filtration_value);
      return; }
    if(sh == members_.end()) 
    {  members_.insert(std::pair< Vertex_handle, Node >( v, Node(this,filtration_value) )); 
      return; }
  }

  typename Dictionary::iterator find( Vertex_handle v )
  { return members_.find(v); }
  
  Simplex_tree_siblings * oncles()
  {  return oncles_;  }
  
  Vertex_handle parent()
  {  return parent_;  }
  
  Dictionary & members()
  { return members_; }
  
  size_t size() { return members_.size(); }


  Simplex_tree_siblings        * oncles_  ;
  Vertex_handle                  parent_  ;
  Dictionary                     members_ ;
  
};

/* @} */ //end addtogroup simplex_tree

}  // namespace GUDHI

#endif // GUDHI_SIMPLEX_TREE_SIBLINGS