Teh first one
[mldemos:kalians-mldemos.git] / _AlgorithmsPlugins / KPCA / Eigen / src / Geometry / Translation.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_TRANSLATION_H
26 #define EIGEN_TRANSLATION_H
27
28 /** \geometry_module \ingroup Geometry_Module
29   *
30   * \class Translation
31   *
32   * \brief Represents a translation transformation
33   *
34   * \param _Scalar the scalar type, i.e., the type of the coefficients.
35   * \param _Dim the  dimension of the space, can be a compile time value or Dynamic
36   *
37   * \note This class is not aimed to be used to store a translation transformation,
38   * but rather to make easier the constructions and updates of Transform objects.
39   *
40   * \sa class Scaling, class Transform
41   */
42 template<typename _Scalar, int _Dim>
43 class Translation
44 {
45 public:
46   EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF_VECTORIZABLE_FIXED_SIZE(_Scalar,_Dim)
47   /** dimension of the space */
48   enum { Dim = _Dim };
49   /** the scalar type of the coefficients */
50   typedef _Scalar Scalar;
51   /** corresponding vector type */
52   typedef Matrix<Scalar,Dim,1> VectorType;
53   /** corresponding linear transformation matrix type */
54   typedef Matrix<Scalar,Dim,Dim> LinearMatrixType;
55   /** corresponding affine transformation type */
56   typedef Transform<Scalar,Dim,Affine> AffineTransformType;
57
58 protected:
59
60   VectorType m_coeffs;
61
62 public:
63
64   /** Default constructor without initialization. */
65   Translation() {}
66   /**  */
67   inline Translation(const Scalar& sx, const Scalar& sy)
68   {
69     eigen_assert(Dim==2);
70     m_coeffs.x() = sx;
71     m_coeffs.y() = sy;
72   }
73   /**  */
74   inline Translation(const Scalar& sx, const Scalar& sy, const Scalar& sz)
75   {
76     eigen_assert(Dim==3);
77     m_coeffs.x() = sx;
78     m_coeffs.y() = sy;
79     m_coeffs.z() = sz;
80   }
81   /** Constructs and initialize the translation transformation from a vector of translation coefficients */
82   explicit inline Translation(const VectorType& vector) : m_coeffs(vector) {}
83
84   /** \brief Retruns the x-translation by value. **/
85   inline Scalar x() const { return m_coeffs.x(); }
86   /** \brief Retruns the y-translation by value. **/
87   inline Scalar y() const { return m_coeffs.y(); }
88   /** \brief Retruns the z-translation by value. **/
89   inline Scalar z() const { return m_coeffs.z(); }
90
91   /** \brief Retruns the x-translation as a reference. **/
92   inline Scalar& x() { return m_coeffs.x(); }
93   /** \brief Retruns the y-translation as a reference. **/
94   inline Scalar& y() { return m_coeffs.y(); }
95   /** \brief Retruns the z-translation as a reference. **/
96   inline Scalar& z() { return m_coeffs.z(); }
97
98   const VectorType& vector() const { return m_coeffs; }
99   VectorType& vector() { return m_coeffs; }
100
101   const VectorType& translation() const { return m_coeffs; }
102   VectorType& translation() { return m_coeffs; }
103
104   /** Concatenates two translation */
105   inline Translation operator* (const Translation& other) const
106   { return Translation(m_coeffs + other.m_coeffs); }
107
108   /** Concatenates a translation and a uniform scaling */
109   inline AffineTransformType operator* (const UniformScaling<Scalar>& other) const;
110
111   /** Concatenates a translation and a linear transformation */
112   template<typename OtherDerived>
113   inline AffineTransformType operator* (const EigenBase<OtherDerived>& linear) const;
114
115   /** Concatenates a translation and a rotation */
116   template<typename Derived>
117   inline AffineTransformType operator*(const RotationBase<Derived,Dim>& r) const
118   { return *this * r.toRotationMatrix(); }
119
120   /** \returns the concatenation of a linear transformation \a l with the translation \a t */
121   // its a nightmare to define a templated friend function outside its declaration
122   template<typename OtherDerived> friend
123   inline AffineTransformType operator*(const EigenBase<OtherDerived>& linear, const Translation& t)
124   {
125     AffineTransformType res;
126     res.matrix().setZero();
127     res.linear() = linear.derived();
128     res.translation() = linear.derived() * t.m_coeffs;
129     res.matrix().row(Dim).setZero();
130     res(Dim,Dim) = Scalar(1);
131     return res;
132   }
133
134   /** Concatenates a translation and a transformation */
135   template<int Mode, int Options>
136   inline Transform<Scalar,Dim,Mode> operator* (const Transform<Scalar,Dim,Mode,Options>& t) const
137   {
138     Transform<Scalar,Dim,Mode> res = t;
139     res.pretranslate(m_coeffs);
140     return res;
141   }
142
143   /** Applies translation to vector */
144   inline VectorType operator* (const VectorType& other) const
145   { return m_coeffs + other; }
146
147   /** \returns the inverse translation (opposite) */
148   Translation inverse() const { return Translation(-m_coeffs); }
149
150   Translation& operator=(const Translation& other)
151   {
152     m_coeffs = other.m_coeffs;
153     return *this;
154   }
155
156   static const Translation Identity() { return Translation(VectorType::Zero()); }
157
158   /** \returns \c *this with scalar type casted to \a NewScalarType
159     *
160     * Note that if \a NewScalarType is equal to the current scalar type of \c *this
161     * then this function smartly returns a const reference to \c *this.
162     */
163   template<typename NewScalarType>
164   inline typename internal::cast_return_type<Translation,Translation<NewScalarType,Dim> >::type cast() const
165   { return typename internal::cast_return_type<Translation,Translation<NewScalarType,Dim> >::type(*this); }
166
167   /** Copy constructor with scalar type conversion */
168   template<typename OtherScalarType>
169   inline explicit Translation(const Translation<OtherScalarType,Dim>& other)
170   { m_coeffs = other.vector().template cast<Scalar>(); }
171
172   /** \returns \c true if \c *this is approximately equal to \a other, within the precision
173     * determined by \a prec.
174     *
175     * \sa MatrixBase::isApprox() */
176   bool isApprox(const Translation& other, typename NumTraits<Scalar>::Real prec = NumTraits<Scalar>::dummy_precision()) const
177   { return m_coeffs.isApprox(other.m_coeffs, prec); }
178
179 };
180
181 /** \addtogroup Geometry_Module */
182 //@{
183 typedef Translation<float, 2> Translation2f;
184 typedef Translation<double,2> Translation2d;
185 typedef Translation<float, 3> Translation3f;
186 typedef Translation<double,3> Translation3d;
187 //@}
188
189 template<typename Scalar, int Dim>
190 inline typename Translation<Scalar,Dim>::AffineTransformType
191 Translation<Scalar,Dim>::operator* (const UniformScaling<Scalar>& other) const
192 {
193   AffineTransformType res;
194   res.matrix().setZero();
195   res.linear().diagonal().fill(other.factor());
196   res.translation() = m_coeffs;
197   res(Dim,Dim) = Scalar(1);
198   return res;
199 }
200
201 template<typename Scalar, int Dim>
202 template<typename OtherDerived>
203 inline typename Translation<Scalar,Dim>::AffineTransformType
204 Translation<Scalar,Dim>::operator* (const EigenBase<OtherDerived>& linear) const
205 {
206   AffineTransformType res;
207   res.matrix().setZero();
208   res.linear() = linear.derived();
209   res.translation() = m_coeffs;
210   res.matrix().row(Dim).setZero();
211   res(Dim,Dim) = Scalar(1);
212   return res;
213 }
214
215 #endif // EIGEN_TRANSLATION_H