b0a8b069504e61379ea049e34e2429aa72504db9
[occt.git] / src / BVH / BVH_RadixSorter.hxx
1 // Created on: 2016-04-13
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 2013-2016 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _BVH_RadixSorter_Header
17 #define _BVH_RadixSorter_Header
18
19 #include <BVH_Sorter.hxx>
20 #include <BVH_Builder.hxx>
21 #include <NCollection_Array1.hxx>
22 #include <NCollection_Shared.hxx>
23 #include <OSD_Parallel.hxx>
24
25 #include <algorithm>
26
27 //! Pair of Morton code and primitive ID.
28 typedef std::pair<Standard_Integer, Standard_Integer> BVH_EncodedLink;
29
30 //! Performs radix sort of a BVH primitive set using
31 //! 10-bit Morton codes (or 1024 x 1024 x 1024 grid).
32 template<class T, int N>
33 class BVH_RadixSorter : public BVH_Sorter<T, N>
34 {
35 public:
36
37   typedef typename BVH::VectorType<T, N>::Type BVH_VecNt;
38
39 public:
40
41   //! Creates new BVH radix sorter for the given AABB.
42   BVH_RadixSorter (const BVH_Box<T, N>& theBox) : myBox (theBox) { }
43
44   //! Sorts the set.
45   virtual void Perform (BVH_Set<T, N>* theSet) Standard_OVERRIDE { Perform (theSet, 0, theSet->Size() - 1); }
46
47   //! Sorts the given (inclusive) range in the set.
48   virtual void Perform (BVH_Set<T, N>* theSet, const Standard_Integer theStart, const Standard_Integer theFinal) Standard_OVERRIDE;
49
50   //! Returns Morton codes assigned to BVH primitives.
51   const NCollection_Array1<BVH_EncodedLink>& EncodedLinks() const { return *myEncodedLinks; }
52
53 protected:
54
55   //! Axis-aligned bounding box (AABB) to perform sorting.
56   BVH_Box<T, N> myBox;
57
58   //! Morton codes assigned to BVH primitives.
59   Handle(NCollection_Shared<NCollection_Array1<BVH_EncodedLink> >) myEncodedLinks;
60
61 };
62
63 namespace BVH
64 {
65   // Radix sort STL predicate for 32-bit integer.
66   struct BitPredicate
67   {
68     Standard_Integer myBit;
69
70     //! Creates new radix sort predicate.
71     BitPredicate (const Standard_Integer theBit) : myBit (theBit) {}
72
73     //! Returns predicate value.
74     bool operator() (const BVH_EncodedLink theLink) const
75     {
76       const Standard_Integer aMask = 1 << myBit;
77       return !(theLink.first & aMask); // 0-bit to the left side
78     }
79   };
80
81   //! STL compare tool used in binary search algorithm.
82   struct BitComparator
83   {
84     Standard_Integer myBit;
85
86     //! Creates new STL comparator.
87     BitComparator (const Standard_Integer theBit) : myBit (theBit) {}
88
89     //! Checks left value for the given bit.
90     bool operator() (BVH_EncodedLink theLink1, BVH_EncodedLink /*theLink2*/)
91     {
92       return !(theLink1.first & (1 << myBit));
93     }
94   };
95
96   //! Tool object for sorting link array using radix sort algorithm.
97   class RadixSorter
98   {
99   public:
100
101     typedef NCollection_Array1<BVH_EncodedLink>::iterator LinkIterator;
102
103   private:
104
105     //! Structure defining sorting range.
106     struct SortRange
107     {
108       LinkIterator     myStart; //!< Start element of exclusive sorting range
109       LinkIterator     myFinal; //!< Final element of exclusive sorting range
110       Standard_Integer myDigit; //!< Bit number used for partition operation
111     };
112
113     //! Functor class to run sorting in parallel.
114     struct Functor
115     {
116       //! Runs sorting function for the given range.
117       void operator()(const SortRange& theRange) const
118       {
119         RadixSorter::Sort (theRange.myStart, theRange.myFinal, theRange.myDigit);
120       }
121     };
122
123   public:
124
125     static void Sort (LinkIterator theStart, LinkIterator theFinal, Standard_Integer theDigit)
126     {
127       if (theDigit < 24)
128       {
129         BVH::RadixSorter::perform (theStart, theFinal, theDigit);
130       }
131       else
132       {
133         LinkIterator anOffset = std::partition (theStart, theFinal, BitPredicate (theDigit));
134         SortRange aSplits[2] = {
135           {theStart, anOffset, theDigit - 1},
136           {anOffset, theFinal, theDigit - 1}
137         };
138
139         OSD_Parallel::ForEach (std::begin (aSplits), std::end (aSplits), Functor ());
140       }
141     }
142
143   protected:
144
145     // Performs MSD (most significant digit) radix sort.
146     static void perform (LinkIterator theStart, LinkIterator theFinal, Standard_Integer theBit = 29)
147     {
148       while (theStart != theFinal && theBit >= 0)
149       {
150         LinkIterator anOffset = std::partition (theStart, theFinal, BitPredicate (theBit--));
151         perform (theStart, anOffset, theBit);
152         theStart = anOffset;
153       }
154     }
155   };
156 }
157
158 // =======================================================================
159 // function : Perform
160 // purpose  :
161 // =======================================================================
162 template<class T, int N>
163 void BVH_RadixSorter<T, N>::Perform (BVH_Set<T, N>* theSet, const Standard_Integer theStart, const Standard_Integer theFinal)
164 {
165   Standard_STATIC_ASSERT (N == 2 || N == 3 || N == 4);
166
167   const Standard_Integer aDimension = 1024;
168   const Standard_Integer aNbEffComp = N == 2 ? 2 : 3; // 4th component is ignored
169
170   const BVH_VecNt aSceneMin = myBox.CornerMin();
171   const BVH_VecNt aSceneMax = myBox.CornerMax();
172
173   BVH_VecNt aNodeMinSizeVecT (static_cast<T>(BVH::THE_NODE_MIN_SIZE));
174   BVH::BoxMinMax<T, N>::CwiseMax (aNodeMinSizeVecT, aSceneMax - aSceneMin);
175
176   const BVH_VecNt aReverseSize = BVH_VecNt (static_cast<T>(aDimension)) / aNodeMinSizeVecT;
177
178   myEncodedLinks = new NCollection_Shared<NCollection_Array1<BVH_EncodedLink> >(theStart, theFinal);
179
180   // Step 1 -- Assign Morton code to each primitive
181   for (Standard_Integer aPrimIdx = theStart; aPrimIdx <= theFinal; ++aPrimIdx)
182   {
183     const BVH_VecNt aCenter = theSet->Box (aPrimIdx).Center();
184     const BVH_VecNt aVoxelF = (aCenter - aSceneMin) * aReverseSize;
185
186     Standard_Integer aMortonCode = 0;
187     for (Standard_Integer aCompIter = 0; aCompIter < aNbEffComp; ++aCompIter)
188     {
189       Standard_Integer aVoxel = BVH::IntFloor (BVH::VecComp<T, N>::Get (aVoxelF, aCompIter));
190
191       aVoxel = Max (0, Min (aVoxel, aDimension - 1));
192
193       aVoxel = (aVoxel | (aVoxel << 16)) & 0x030000FF;
194       aVoxel = (aVoxel | (aVoxel <<  8)) & 0x0300F00F;
195       aVoxel = (aVoxel | (aVoxel <<  4)) & 0x030C30C3;
196       aVoxel = (aVoxel | (aVoxel <<  2)) & 0x09249249;
197
198       aMortonCode |= (aVoxel << aCompIter);
199     }
200
201     myEncodedLinks->ChangeValue (aPrimIdx) = BVH_EncodedLink (aMortonCode, aPrimIdx);
202   }
203
204   // Step 2 -- Sort primitives by their Morton codes using radix sort
205   BVH::RadixSorter::Sort (myEncodedLinks->begin(), myEncodedLinks->end(), 29);
206
207   NCollection_Array1<Standard_Integer> aLinkMap (theStart, theFinal);
208   for (Standard_Integer aLinkIdx = theStart; aLinkIdx <= theFinal; ++aLinkIdx)
209   {
210     aLinkMap (myEncodedLinks->Value (aLinkIdx).second) = aLinkIdx;
211   }
212
213   // Step 3 -- Rearranging primitive list according to Morton codes (in place)
214   Standard_Integer aPrimIdx = theStart;
215   while (aPrimIdx <= theFinal)
216   {
217     const Standard_Integer aSortIdx = aLinkMap (aPrimIdx);
218     if (aPrimIdx != aSortIdx)
219     {
220       theSet->Swap (aPrimIdx, aSortIdx);
221       std::swap (aLinkMap (aPrimIdx),
222                  aLinkMap (aSortIdx));
223     }
224     else
225     {
226       ++aPrimIdx;
227     }
228   }
229 }
230
231 #endif // _BVH_RadixSorter_Header