Geant4  10.03.p03
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 101354 2016-11-15 08:27:51Z gcosmo $
27 //
28 // Author: Mathieu Karamitros
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 #define KDTR_parent std::vector<ResNode>
69 
70 class G4KDTreeResult : protected KDTR_parent//protected std::list<ResNode>
71 {
72 protected:
74 // std::list<ResNode>::iterator fIterator;
75  KDTR_parent::iterator fIterator;
76 
77 public:
79  virtual ~G4KDTreeResult();
80 
81  // new/delete operators are overloded to use G4Allocator
82  inline void *operator new(size_t);
83 #ifdef __IBMCPP__
84  inline void *operator new(size_t sz, void* p)
85  { return p;}
86 #endif
87  inline void operator delete(void*);
88 
89  void Insert(double, G4KDNode_Base*);
90 
91  void Clear();
92 
93  void Sort();
94 
95  /* returns the size of the result set (in elements) */
96  size_t GetSize() const;
97 
98  size_t size() const;
99 
100  /* rewinds the result set iterator */
101  void Rewind();
102 
103  /* returns non-zero if the set iterator reached the end after the last element*/
104  bool End();
105 
106  /* advances the result set iterator
107  */
108  void Next();
109 
110  /* returns the data pointer (can be null) of the current result set item
111  * and optionally sets its position to the pointers(s) if not null.
112  */
113  template<typename PointT>
114  PointT* GetItem() const;
115  G4KDNode_Base* GetNode() const;
116  template<typename PointT>
117  PointT* GetItemNDistanceSQ(double& /*distance*/) const;
118  double GetDistanceSqr() const;
119 };
120 
121 //------------------------------------------------------------------------------
122 #if defined G4EM_ALLOC_EXPORT
124 #else
126 #endif
127 
128 inline void * G4KDTreeResult::operator new(size_t)
129 {
131  return (void *) aKDTreeAllocator->MallocSingle();
132 }
133 
134 inline void G4KDTreeResult::operator delete(void * object)
135 {
136  aKDTreeAllocator->FreeSingle((G4KDTreeResult *) object);
137 }
138 //------------------------------------------------------------------------------
139 template<typename PointT>
140  PointT* G4KDTreeResult::GetItem() const
141  {
143  return node->GetPoint();
144  }
145 
146 template<typename PointT>
147  PointT* G4KDTreeResult::GetItemNDistanceSQ(double& dist_sq) const
148  {
149  dist_sq = GetDistanceSqr();
150  return this->GetItem<PointT>();
151  }
152 
153 #endif // G4KDTREERESULT_HH
#define G4DLLEXPORT
Definition: G4Types.hh:62
PointT * GetPoint()
Definition: G4KDNode.hh:148
#define G4DLLIMPORT
Definition: G4Types.hh:63
const char * p
Definition: xmltok.h:285
virtual ~G4KDTreeResult()
G4KDTreeResult(G4KDTree *)
KDTR_parent::iterator fIterator
size_t GetSize() const
#define G4ThreadLocal
Definition: tls.hh:89
double GetDistanceSqr() const
#define KDTR_parent
G4ReferenceCountedHandle< ResNode > ResNodeHandle
G4DLLIMPORT G4ThreadLocal G4Allocator< G4KDTreeResult > * aKDTreeAllocator
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