Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Geometry / OrthoMethods.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra. Eigen itself is part of the KDE project.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_ORTHOMETHODS_H
27 #define EIGEN_ORTHOMETHODS_H
28
29 /** \geometry_module
30   *
31   * \returns the cross product of \c *this and \a other
32   *
33   * Here is a very good explanation of cross-product: http://xkcd.com/199/
34   */
35 template<typename Derived>
36 template<typename OtherDerived>
37 inline typename MatrixBase<Derived>::PlainMatrixType
38 MatrixBase<Derived>::cross(const MatrixBase<OtherDerived>& other) const
39 {
40   EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Derived,3)
41
42   // Note that there is no need for an expression here since the compiler
43   // optimize such a small temporary very well (even within a complex expression)
44   const typename ei_nested<Derived,2>::type lhs(derived());
45   const typename ei_nested<OtherDerived,2>::type rhs(other.derived());
46   return typename ei_plain_matrix_type<Derived>::type(
47     lhs.coeff(1) * rhs.coeff(2) - lhs.coeff(2) * rhs.coeff(1),
48     lhs.coeff(2) * rhs.coeff(0) - lhs.coeff(0) * rhs.coeff(2),
49     lhs.coeff(0) * rhs.coeff(1) - lhs.coeff(1) * rhs.coeff(0)
50   );
51 }
52
53 template<typename Derived, int Size = Derived::SizeAtCompileTime>
54 struct ei_unitOrthogonal_selector
55 {
56   typedef typename ei_plain_matrix_type<Derived>::type VectorType;
57   typedef typename ei_traits<Derived>::Scalar Scalar;
58   typedef typename NumTraits<Scalar>::Real RealScalar;
59   inline static VectorType run(const Derived& src)
60   {
61     VectorType perp(src.size());
62     /* Let us compute the crossed product of *this with a vector
63      * that is not too close to being colinear to *this.
64      */
65
66     /* unless the x and y coords are both close to zero, we can
67      * simply take ( -y, x, 0 ) and normalize it.
68      */
69     if((!ei_isMuchSmallerThan(src.x(), src.z()))
70     || (!ei_isMuchSmallerThan(src.y(), src.z())))
71     {
72       RealScalar invnm = RealScalar(1)/src.template start<2>().norm();
73       perp.coeffRef(0) = -ei_conj(src.y())*invnm;
74       perp.coeffRef(1) = ei_conj(src.x())*invnm;
75       perp.coeffRef(2) = 0;
76     }
77     /* if both x and y are close to zero, then the vector is close
78      * to the z-axis, so it's far from colinear to the x-axis for instance.
79      * So we take the crossed product with (1,0,0) and normalize it.
80      */
81     else
82     {
83       RealScalar invnm = RealScalar(1)/src.template end<2>().norm();
84       perp.coeffRef(0) = 0;
85       perp.coeffRef(1) = -ei_conj(src.z())*invnm;
86       perp.coeffRef(2) = ei_conj(src.y())*invnm;
87     }
88     if( (Derived::SizeAtCompileTime!=Dynamic && Derived::SizeAtCompileTime>3)
89      || (Derived::SizeAtCompileTime==Dynamic && src.size()>3) )
90       perp.end(src.size()-3).setZero();
91
92     return perp;
93    }
94 };
95
96 template<typename Derived>
97 struct ei_unitOrthogonal_selector<Derived,2>
98 {
99   typedef typename ei_plain_matrix_type<Derived>::type VectorType;
100   inline static VectorType run(const Derived& src)
101   { return VectorType(-ei_conj(src.y()), ei_conj(src.x())).normalized(); }
102 };
103
104 /** \returns a unit vector which is orthogonal to \c *this
105   *
106   * The size of \c *this must be at least 2. If the size is exactly 2,
107   * then the returned vector is a counter clock wise rotation of \c *this, i.e., (-y,x).normalized().
108   *
109   * \sa cross()
110   */
111 template<typename Derived>
112 typename MatrixBase<Derived>::PlainMatrixType
113 MatrixBase<Derived>::unitOrthogonal() const
114 {
115   EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
116   return ei_unitOrthogonal_selector<Derived>::run(derived());
117 }
118
119 #endif // EIGEN_ORTHOMETHODS_H