Camera tracking integration
[blender.git] / extern / Eigen3 / Eigen / src / Geometry / AlignedBox.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5 //
6 // Eigen is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 3 of the License, or (at your option) any later version.
10 //
11 // Alternatively, you can redistribute it and/or
12 // modify it under the terms of the GNU General Public License as
13 // published by the Free Software Foundation; either version 2 of
14 // the License, or (at your option) any later version.
15 //
16 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License and a copy of the GNU General Public License along with
23 // Eigen. If not, see <http://www.gnu.org/licenses/>.
24
25 #ifndef EIGEN_ALIGNEDBOX_H
26 #define EIGEN_ALIGNEDBOX_H
27
28 /** \geometry_module \ingroup Geometry_Module
29   *
30   *
31   * \class AlignedBox
32   *
33   * \brief An axis aligned box
34   *
35   * \param _Scalar the type of the scalar coefficients
36   * \param _AmbientDim the dimension of the ambient space, can be a compile time value or Dynamic.
37   *
38   * This class represents an axis aligned box as a pair of the minimal and maximal corners.
39   */
40 template <typename _Scalar, int _AmbientDim>
41 class AlignedBox
42 {
43 public:
44 EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF_VECTORIZABLE_FIXED_SIZE(_Scalar,_AmbientDim)
45   enum { AmbientDimAtCompileTime = _AmbientDim };
46   typedef _Scalar                                   Scalar;
47   typedef NumTraits<Scalar>                         ScalarTraits;
48   typedef DenseIndex                                Index;
49   typedef typename ScalarTraits::Real               RealScalar;
50   typedef typename ScalarTraits::NonInteger      NonInteger;
51   typedef Matrix<Scalar,AmbientDimAtCompileTime,1>  VectorType;
52
53   /** Define constants to name the corners of a 1D, 2D or 3D axis aligned bounding box */
54   enum CornerType
55   {
56     /** 1D names */
57     Min=0, Max=1,
58
59     /** Added names for 2D */
60     BottomLeft=0, BottomRight=1,
61     TopLeft=2, TopRight=3,
62
63     /** Added names for 3D */
64     BottomLeftFloor=0, BottomRightFloor=1,
65     TopLeftFloor=2, TopRightFloor=3,
66     BottomLeftCeil=4, BottomRightCeil=5,
67     TopLeftCeil=6, TopRightCeil=7
68   };
69
70
71   /** Default constructor initializing a null box. */
72   inline explicit AlignedBox()
73   { if (AmbientDimAtCompileTime!=Dynamic) setEmpty(); }
74
75   /** Constructs a null box with \a _dim the dimension of the ambient space. */
76   inline explicit AlignedBox(Index _dim) : m_min(_dim), m_max(_dim)
77   { setEmpty(); }
78
79   /** Constructs a box with extremities \a _min and \a _max. */
80   template<typename OtherVectorType1, typename OtherVectorType2>
81   inline AlignedBox(const OtherVectorType1& _min, const OtherVectorType2& _max) : m_min(_min), m_max(_max) {}
82
83   /** Constructs a box containing a single point \a p. */
84   template<typename Derived>
85   inline explicit AlignedBox(const MatrixBase<Derived>& a_p)
86   {
87     const typename internal::nested<Derived,2>::type p(a_p.derived());
88     m_min = p;
89     m_max = p;
90   }
91
92   ~AlignedBox() {}
93
94   /** \returns the dimension in which the box holds */
95   inline Index dim() const { return AmbientDimAtCompileTime==Dynamic ? m_min.size()-1 : Index(AmbientDimAtCompileTime); }
96
97   /** \deprecated use isEmpty */
98   inline bool isNull() const { return isEmpty(); }
99
100   /** \deprecated use setEmpty */
101   inline void setNull() { setEmpty(); }
102
103   /** \returns true if the box is empty. */
104   inline bool isEmpty() const { return (m_min.array() > m_max.array()).any(); }
105
106   /** Makes \c *this an empty box. */
107   inline void setEmpty()
108   {
109     m_min.setConstant( ScalarTraits::highest() );
110     m_max.setConstant( ScalarTraits::lowest() );
111   }
112
113   /** \returns the minimal corner */
114   inline const VectorType& (min)() const { return m_min; }
115   /** \returns a non const reference to the minimal corner */
116   inline VectorType& (min)() { return m_min; }
117   /** \returns the maximal corner */
118   inline const VectorType& (max)() const { return m_max; }
119   /** \returns a non const reference to the maximal corner */
120   inline VectorType& (max)() { return m_max; }
121
122   /** \returns the center of the box */
123   inline const CwiseUnaryOp<internal::scalar_quotient1_op<Scalar>,
124                             const CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const VectorType, const VectorType> >
125   center() const
126   { return (m_min+m_max)/2; }
127
128   /** \returns the lengths of the sides of the bounding box.
129     * Note that this function does not get the same
130     * result for integral or floating scalar types: see
131     */
132   inline const CwiseBinaryOp< internal::scalar_difference_op<Scalar>, const VectorType, const VectorType> sizes() const
133   { return m_max - m_min; }
134
135   /** \returns the volume of the bounding box */
136   inline Scalar volume() const
137   { return sizes().prod(); }
138
139   /** \returns an expression for the bounding box diagonal vector
140     * if the length of the diagonal is needed: diagonal().norm()
141     * will provide it.
142     */
143   inline CwiseBinaryOp< internal::scalar_difference_op<Scalar>, const VectorType, const VectorType> diagonal() const
144   { return sizes(); }
145
146   /** \returns the vertex of the bounding box at the corner defined by
147     * the corner-id corner. It works only for a 1D, 2D or 3D bounding box.
148     * For 1D bounding boxes corners are named by 2 enum constants:
149     * BottomLeft and BottomRight.
150     * For 2D bounding boxes, corners are named by 4 enum constants:
151     * BottomLeft, BottomRight, TopLeft, TopRight.
152     * For 3D bounding boxes, the following names are added:
153     * BottomLeftCeil, BottomRightCeil, TopLeftCeil, TopRightCeil.
154     */
155   inline VectorType corner(CornerType corner) const
156   {
157     EIGEN_STATIC_ASSERT(_AmbientDim <= 3, THIS_METHOD_IS_ONLY_FOR_VECTORS_OF_A_SPECIFIC_SIZE);
158
159     VectorType res;
160
161     Index mult = 1;
162     for(Index d=0; d<dim(); ++d)
163     {
164       if( mult & corner ) res[d] = m_max[d];
165       else                res[d] = m_min[d];
166       mult *= 2;
167     }
168     return res;
169   }
170
171   /** \returns a random point inside the bounding box sampled with
172    * a uniform distribution */
173   inline VectorType sample() const
174   {
175     VectorType r;
176     for(Index d=0; d<dim(); ++d)
177     {
178       if(!ScalarTraits::IsInteger)
179       {
180         r[d] = m_min[d] + (m_max[d]-m_min[d])
181              * internal::random<Scalar>(Scalar(0), Scalar(1));
182       }
183       else
184         r[d] = internal::random(m_min[d], m_max[d]);
185     }
186     return r;
187   }
188
189   /** \returns true if the point \a p is inside the box \c *this. */
190   template<typename Derived>
191   inline bool contains(const MatrixBase<Derived>& a_p) const
192   {
193     const typename internal::nested<Derived,2>::type p(a_p.derived());
194     return (m_min.array()<=p.array()).all() && (p.array()<=m_max.array()).all();
195   }
196
197   /** \returns true if the box \a b is entirely inside the box \c *this. */
198   inline bool contains(const AlignedBox& b) const
199   { return (m_min.array()<=(b.min)().array()).all() && ((b.max)().array()<=m_max.array()).all(); }
200
201   /** Extends \c *this such that it contains the point \a p and returns a reference to \c *this. */
202   template<typename Derived>
203   inline AlignedBox& extend(const MatrixBase<Derived>& a_p)
204   {
205     const typename internal::nested<Derived,2>::type p(a_p.derived());
206     m_min = m_min.cwiseMin(p);
207     m_max = m_max.cwiseMax(p);
208     return *this;
209   }
210
211   /** Extends \c *this such that it contains the box \a b and returns a reference to \c *this. */
212   inline AlignedBox& extend(const AlignedBox& b)
213   {
214     m_min = m_min.cwiseMin(b.m_min);
215     m_max = m_max.cwiseMax(b.m_max);
216     return *this;
217   }
218
219   /** Clamps \c *this by the box \a b and returns a reference to \c *this. */
220   inline AlignedBox& clamp(const AlignedBox& b)
221   {
222     m_min = m_min.cwiseMax(b.m_min);
223     m_max = m_max.cwiseMin(b.m_max);
224     return *this;
225   }
226
227   /** Returns an AlignedBox that is the intersection of \a b and \c *this */
228   inline AlignedBox intersection(const AlignedBox& b) const
229   {return AlignedBox(m_min.cwiseMax(b.m_min), m_max.cwiseMin(b.m_max)); }
230
231   /** Returns an AlignedBox that is the union of \a b and \c *this */
232   inline AlignedBox merged(const AlignedBox& b) const
233   { return AlignedBox(m_min.cwiseMin(b.m_min), m_max.cwiseMax(b.m_max)); }
234
235   /** Translate \c *this by the vector \a t and returns a reference to \c *this. */
236   template<typename Derived>
237   inline AlignedBox& translate(const MatrixBase<Derived>& a_t)
238   {
239     const typename internal::nested<Derived,2>::type t(a_t.derived());
240     m_min += t;
241     m_max += t;
242     return *this;
243   }
244
245   /** \returns the squared distance between the point \a p and the box \c *this,
246     * and zero if \a p is inside the box.
247     * \sa exteriorDistance()
248     */
249   template<typename Derived>
250   inline Scalar squaredExteriorDistance(const MatrixBase<Derived>& a_p) const;
251
252   /** \returns the squared distance between the boxes \a b and \c *this,
253     * and zero if the boxes intersect.
254     * \sa exteriorDistance()
255     */
256   inline Scalar squaredExteriorDistance(const AlignedBox& b) const;
257
258   /** \returns the distance between the point \a p and the box \c *this,
259     * and zero if \a p is inside the box.
260     * \sa squaredExteriorDistance()
261     */
262   template<typename Derived>
263   inline NonInteger exteriorDistance(const MatrixBase<Derived>& p) const
264   { return internal::sqrt(NonInteger(squaredExteriorDistance(p))); }
265
266   /** \returns the distance between the boxes \a b and \c *this,
267     * and zero if the boxes intersect.
268     * \sa squaredExteriorDistance()
269     */
270   inline NonInteger exteriorDistance(const AlignedBox& b) const
271   { return internal::sqrt(NonInteger(squaredExteriorDistance(b))); }
272
273   /** \returns \c *this with scalar type casted to \a NewScalarType
274     *
275     * Note that if \a NewScalarType is equal to the current scalar type of \c *this
276     * then this function smartly returns a const reference to \c *this.
277     */
278   template<typename NewScalarType>
279   inline typename internal::cast_return_type<AlignedBox,
280            AlignedBox<NewScalarType,AmbientDimAtCompileTime> >::type cast() const
281   {
282     return typename internal::cast_return_type<AlignedBox,
283                     AlignedBox<NewScalarType,AmbientDimAtCompileTime> >::type(*this);
284   }
285
286   /** Copy constructor with scalar type conversion */
287   template<typename OtherScalarType>
288   inline explicit AlignedBox(const AlignedBox<OtherScalarType,AmbientDimAtCompileTime>& other)
289   {
290     m_min = (other.min)().template cast<Scalar>();
291     m_max = (other.max)().template cast<Scalar>();
292   }
293
294   /** \returns \c true if \c *this is approximately equal to \a other, within the precision
295     * determined by \a prec.
296     *
297     * \sa MatrixBase::isApprox() */
298   bool isApprox(const AlignedBox& other, RealScalar prec = ScalarTraits::dummy_precision()) const
299   { return m_min.isApprox(other.m_min, prec) && m_max.isApprox(other.m_max, prec); }
300
301 protected:
302
303   VectorType m_min, m_max;
304 };
305
306
307
308 template<typename Scalar,int AmbientDim>
309 template<typename Derived>
310 inline Scalar AlignedBox<Scalar,AmbientDim>::squaredExteriorDistance(const MatrixBase<Derived>& a_p) const
311 {
312   const typename internal::nested<Derived,2*AmbientDim>::type p(a_p.derived());
313   Scalar dist2 = 0.;
314   Scalar aux;
315   for (Index k=0; k<dim(); ++k)
316   {
317     if( m_min[k] > p[k] )
318     {
319       aux = m_min[k] - p[k];
320       dist2 += aux*aux;
321     }
322     else if( p[k] > m_max[k] )
323     {
324       aux = p[k] - m_max[k];
325       dist2 += aux*aux;
326     }
327   }
328   return dist2;
329 }
330
331 template<typename Scalar,int AmbientDim>
332 inline Scalar AlignedBox<Scalar,AmbientDim>::squaredExteriorDistance(const AlignedBox& b) const
333 {
334   Scalar dist2 = 0.;
335   Scalar aux;
336   for (Index k=0; k<dim(); ++k)
337   {
338     if( m_min[k] > b.m_max[k] )
339     {
340       aux = m_min[k] - b.m_max[k];
341       dist2 += aux*aux;
342     }
343     else if( b.m_min[k] > m_max[k] )
344     {
345       aux = b.m_min[k] - m_max[k];
346       dist2 += aux*aux;
347     }
348   }
349   return dist2;
350 }
351
352 #endif // EIGEN_ALIGNEDBOX_H