Geant4  10.01
G4KDTreeResult.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // $Id: G4KDTreeResult.hh 85244 2014-10-27 08:24:13Z gcosmo $
27 //
28 // Author: Mathieu Karamitros, kara@cenbg.in2p3.fr
29 
30 // The code is developed in the framework of the ESA AO7146
31 //
32 // We would be very happy hearing from you, send us your feedback! :)
33 //
34 // In order for Geant4-DNA to be maintained and still open-source,
35 // article citations are crucial.
36 // If you use Geant4-DNA chemistry and you publish papers about your software,
37 // in addition to the general paper on Geant4-DNA:
38 //
39 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
40 //
41 // we would be very happy if you could please also cite the following
42 // reference papers on chemistry:
43 //
44 // J. Comput. Phys. 274 (2014) 841-882
45 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
46 
47 #ifndef G4KDTREERESULT_HH
48 #define G4KDTREERESULT_HH
49 
50 #include <list>
51 #include "globals.hh"
53 #include "G4KDNode.hh"
54 
55 class G4KDTree;
56 class G4KDNode_Base;
57 struct ResNode;
59 
62 
68 class G4KDTreeResult : protected std::list<ResNode>
69 {
70 protected:
72  std::list<ResNode>::iterator fIterator;
73 
74 public:
76  virtual ~G4KDTreeResult();
77 
78  void Insert(double, G4KDNode_Base*);
79 
80  void Clear();
81 
82  void Sort();
83 
84  /* returns the size of the result set (in elements) */
85  size_t GetSize() const;
86 
87  size_t size() const;
88 
89  /* rewinds the result set iterator */
90  void Rewind();
91 
92  /* returns non-zero if the set iterator reached the end after the last element*/
93  bool End();
94 
95  /* advances the result set iterator
96  */
97  void Next();
98 
99  /* returns the data pointer (can be null) of the current result set item
100  * and optionally sets its position to the pointers(s) if not null.
101  */
102  template<typename PointT>
103  PointT* GetItem() const;
104  G4KDNode_Base* GetNode() const;
105  template<typename PointT>
106  PointT* GetItemNDistanceSQ(double& /*distance*/) const;
107  double GetDistanceSqr() const;
108 };
109 
110 template<typename PointT>
111  PointT* G4KDTreeResult::GetItem() const
112  {
114  return node->GetPoint();
115  }
116 
117 template<typename PointT>
118  PointT* G4KDTreeResult::GetItemNDistanceSQ(double& dist_sq) const
119  {
120  dist_sq = GetDistanceSqr();
121  return this->GetItem<PointT>();
122  }
123 
124 #endif // G4KDTREERESULT_HH
PointT * GetPoint()
Definition: G4KDNode.hh:141
G4KDTree is used by the ITManager to locate the neareast neighbours.
Definition: G4KDTree.hh:72
virtual ~G4KDTreeResult()
G4KDTreeResult(G4KDTree *)
size_t GetSize() const
double GetDistanceSqr() const
G4KDNode stores one entity in G4KDTree This class is for internal use only.
Definition: G4KDNode.hh:128
G4ReferenceCountedHandle< ResNode > ResNodeHandle
std::list< ResNode >::iterator fIterator
G4KDNode_Base * GetNode() const
PointT * GetItem() const
size_t size() const
void Insert(double, G4KDNode_Base *)
PointT * GetItemNDistanceSQ(double &) const
G4KDTree * fTree
G4ReferenceCountedHandle< G4KDTreeResult > G4KDTreeResultHandle
G4KDTreeResult enables to go through the nearest entities found by G4KDTree.