Geant4  10.00.p03
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 64057 2012-10-30 15:04:49Z gcosmo $
27 //
28 // Author: Mathieu Karamitros (kara (AT) cenbg . in2p3 . fr)
29 //
30 // WARNING : This class is released as a prototype.
31 // It might strongly evolve or even disapear in the next releases.
32 //
33 // History:
34 // -----------
35 // 10 Oct 2011 M.Karamitros created
36 //
37 // -------------------------------------------------------------------
38 
39 #ifndef G4KDTREERESULT_HH
40 #define G4KDTREERESULT_HH
41 
42 #include <list>
43 #include "globals.hh"
45 class G4KDTree;
46 class G4KDNode;
47 struct ResNode;
48 
50 
53 
59 class G4KDTreeResult : protected std::list<ResNode>
60 {
61 protected :
63  std::list<ResNode>::iterator fIterator;
64 
65 public:
67  virtual ~G4KDTreeResult();
68 
69  void Insert(double, G4KDNode*);
70 
71  void Clear();
72 
73  void Sort();
74 
75  /* returns the size of the result set (in elements) */
76  size_t GetSize();
77 
78  size_t size();
79 
80  /* rewinds the result set iterator */
81  void Rewind();
82 
83  /* returns non-zero if the set iterator reached the end after the last element */
84  bool End();
85 
86  /* advances the result set iterator
87  */
88  void Next();
89 
90  /* returns the data pointer (can be null) of the current result set item
91  * and optionally sets its position to the pointers(s) if not null.
92  */
93  void* GetItemData();
94  void* GetItem(double*& /*position*/);
95  void* GetItem(double& x, double& y, double& z); // 3D
96  void* GetItemNDistanceSQ(double& /*distance*/);
97  void* GetItemNDistanceSQ(double*& /*position*/, double& /*distance*/);
98  double GetDistanceSqr();
99 };
100 
101 #endif // G4KDTREERESULT_HH
double GetDistanceSqr()
G4double z
Definition: TRTMaterials.hh:39
G4KDTree is used by the ITManager to locate the neareast neighbours.
Definition: G4KDTree.hh:62
virtual ~G4KDTreeResult()
G4KDTreeResult(G4KDTree *)
void Insert(double, G4KDNode *)
G4KDNode stores one entity in G4KDTree This class is for internal use only.
Definition: G4KDNode.hh:50
G4ReferenceCountedHandle< ResNode > ResNodeHandle
std::list< ResNode >::iterator fIterator
void * GetItemData()
void * GetItem(double *&)
G4KDTree * fTree
G4ReferenceCountedHandle< G4KDTreeResult > G4KDTreeResultHandle
void * GetItemNDistanceSQ(double &)
G4KDTreeResult enables to go through the nearest entities found by G4KDTree.