update Bullet 2.x with latest changes, notice that the integration is not finished...
[blender.git] / extern / bullet2 / src / BulletCollision / CollisionDispatch / btUnionFind.h
1 /*
2 Bullet Continuous Collision Detection and Physics Library
3 Copyright (c) 2003-2006 Erwin Coumans  http://continuousphysics.com/Bullet/
4
5 This software is provided 'as-is', without any express or implied warranty.
6 In no event will the authors be held liable for any damages arising from the use of this software.
7 Permission is granted to anyone to use this software for any purpose, 
8 including commercial applications, and to alter it and redistribute it freely, 
9 subject to the following restrictions:
10
11 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
12 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
13 3. This notice may not be removed or altered from any source distribution.
14 */
15
16 #ifndef UNION_FIND_H
17 #define UNION_FIND_H
18
19 #include <vector>
20 struct  btElement
21 {
22         int     m_id;
23         int     m_sz;
24 };
25
26 ///UnionFind calculates connected subsets
27 // Implements weighted Quick Union with path compression
28 // optimization: could use short ints instead of ints (halving memory, would limit the number of rigid bodies to 64k, sounds reasonable)
29 class btUnionFind
30   {
31     private:
32                 std::vector<btElement>  m_elements;
33
34     public:
35           
36                 btUnionFind();
37                 ~btUnionFind();
38
39         
40                 //this is a special operation, destroying the content of btUnionFind.
41                 //it sorts the elements, based on island id, in order to make it easy to iterate over islands
42                 void    sortIslands();
43
44           void  reset(int N);
45
46           inline int    getNumElements() const
47           {
48                   return int(m_elements.size());
49           }
50           inline bool  isRoot(int x) const
51           {
52                   return (x == m_elements[x].m_id);
53           }
54
55           btElement&    getElement(int index)
56           {
57                   return m_elements[index];
58           }
59           const btElement& getElement(int index) const
60           {
61                   return m_elements[index];
62           }
63    
64           void  allocate(int N);
65           void  Free();
66
67
68
69
70           int find(int p, int q)
71                 { 
72                         return (find(p) == find(q)); 
73                 }
74
75                 void unite(int p, int q)
76                 {
77                         int i = find(p), j = find(q);
78                         if (i == j) 
79                                 return;
80
81                         //weighted quick union, this keeps the 'trees' balanced, and keeps performance of unite O( log(n) )
82                         if (m_elements[i].m_sz < m_elements[j].m_sz)
83                         { 
84                                 m_elements[i].m_id = j; m_elements[j].m_sz += m_elements[i].m_sz; 
85                         }
86                         else 
87                         { 
88                                 m_elements[j].m_id = i; m_elements[i].m_sz += m_elements[j].m_sz; 
89                         }
90                 }
91
92                 int find(int x)
93                 { 
94                         //assert(x < m_N);
95                         //assert(x >= 0);
96
97                         while (x != m_elements[x].m_id) 
98                         {
99                 //not really a reason not to use path compression, and it flattens the trees/improves find performance dramatically
100                 #define USE_PATH_COMPRESSION 1
101                 #ifdef USE_PATH_COMPRESSION
102                                 //
103                                 m_elements[x].m_id = m_elements[m_elements[x].m_id].m_id;
104                 #endif //
105                                 x = m_elements[x].m_id;
106                                 //assert(x < m_N);
107                                 //assert(x >= 0);
108
109                         }
110                         return x; 
111                 }
112
113
114   };
115
116
117 #endif //UNION_FIND_H