include/Geant4/G4KDTreeResult.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 // Author: Mathieu Karamitros
0028
0029 // The code is developed in the framework of the ESA AO7146
0030 //
0031 // We would be very happy hearing from you, send us your feedback! :)
0032 //
0033 // In order for Geant4-DNA to be maintained and still open-source,
0034 // article citations are crucial.
0035 // If you use Geant4-DNA chemistry and you publish papers about your software,
0036 // in addition to the general paper on Geant4-DNA:
0037 //
0038 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0039 //
0040 // we would be very happy if you could please also cite the following
0041 // reference papers on chemistry:
0042 //
0043 // J. Comput. Phys. 274 (2014) 841-882
0044 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0045
0046 #ifndef G4KDTREERESULT_HH
0047 #define G4KDTREERESULT_HH
0048
0049 #include <list>
0050 #include "globals.hh"
0051 #include "G4ReferenceCountedHandle.hh"
0052 #include "G4KDNode.hh"
0053
0054 class G4KDTree;
0055 class G4KDNode_Base;
0056 struct ResNode;
0057 class G4KDTreeResult;
0058
0059 using G4KDTreeResultHandle = G4ReferenceCountedHandle<G4KDTreeResult>;
0060 using ResNodeHandle = G4ReferenceCountedHandle<ResNode>;
0061
0062 /**
0063  * G4KDTreeResult enables to go through the nearest entities found
0064  * by G4KDTree.
0065  */
0066
0067 #define KDTR_parent std::vector<ResNode>
0068
0069 class G4KDTreeResult : protected KDTR_parent//protected std::list<ResNode>
0070 {
0071 protected:
0072   G4KDTree *fTree;
0073 //  std::list<ResNode>::iterator fIterator;
0074   KDTR_parent::iterator fIterator;
0075
0076 public:
0077   G4KDTreeResult(G4KDTree*);
0078   virtual ~G4KDTreeResult();
0079
0080   //  new/delete operators are overloded to use G4Allocator
0081   inline void *operator new(size_t);
0082 #ifdef __IBMCPP__
0083   inline void *operator new(size_t sz, void* p)
0084   { return p;}
0085 #endif
0086   inline void operator delete(void*);
0087
0088   void Insert(double, G4KDNode_Base*);
0089
0090   void Clear();
0091
0092   void Sort();
0093
0094   /* returns the size of the result set (in elements) */
0095   size_t GetSize() const;
0096
0097   size_t size() const;
0098
0099   /* rewinds the result set iterator */
0100   void Rewind();
0101
0102   /* returns non-zero if the set iterator reached the end after the last element*/
0103   bool End();
0104
0105   /* advances the result set iterator
0106    */
0107   void Next();
0108
0109   /* returns the data pointer (can be null) of the current result set item
0110    * and optionally sets its position to the pointers(s) if not null.
0111    */
0112   template<typename PointT>
0113     PointT* GetItem() const;
0114   G4KDNode_Base* GetNode() const;
0115   template<typename PointT>
0116     PointT* GetItemNDistanceSQ(double& /*distance*/) const;
0117   double GetDistanceSqr() const;
0118 };
0119
0120 //------------------------------------------------------------------------------
0121 #if defined G4EM_ALLOC_EXPORT
0122 extern G4DLLEXPORT G4Allocator<G4KDTreeResult>*& aKDTreeAllocator();
0123 #else
0124 extern G4DLLIMPORT G4Allocator<G4KDTreeResult>*& aKDTreeAllocator();
0125 #endif
0126
0127 inline void * G4KDTreeResult::operator new(size_t)
0128 {
0129   if (aKDTreeAllocator() == nullptr) aKDTreeAllocator() = new G4Allocator<G4KDTreeResult>;
0130   return (void *) aKDTreeAllocator()->MallocSingle();
0131 }
0132
0133 inline void G4KDTreeResult::operator delete(void * object)
0134 {
0135   aKDTreeAllocator()->FreeSingle((G4KDTreeResult *) object);
0136 }
0137 //------------------------------------------------------------------------------
0138 template<typename PointT>
0139   PointT* G4KDTreeResult::GetItem() const
0140   {
0141     auto  node = (G4KDNode<PointT>*) (GetNode());
0142     return node->GetPoint();
0143   }
0144
0145 template<typename PointT>
0146   PointT* G4KDTreeResult::GetItemNDistanceSQ(double& dist_sq) const
0147   {
0148     dist_sq = GetDistanceSqr();
0149     return this->GetItem<PointT>();
0150   }
0151
0152 #endif // G4KDTREERESULT_HH