Teh first one
[mldemos:kalians-mldemos.git] / _AlgorithmsPlugins / KPCA / Eigen / src / Eigen2Support / Geometry / Hyperplane.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) 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 // no include guard, we'll include this twice from All.h from Eigen2Support, and it's internal anyway
27
28 /** \geometry_module \ingroup Geometry_Module
29   *
30   * \class Hyperplane
31   *
32   * \brief A hyperplane
33   *
34   * A hyperplane is an affine subspace of dimension n-1 in a space of dimension n.
35   * For example, a hyperplane in a plane is a line; a hyperplane in 3-space is a plane.
36   *
37   * \param _Scalar the scalar type, i.e., the type of the coefficients
38   * \param _AmbientDim the dimension of the ambient space, can be a compile time value or Dynamic.
39   *             Notice that the dimension of the hyperplane is _AmbientDim-1.
40   *
41   * This class represents an hyperplane as the zero set of the implicit equation
42   * \f$ n \cdot x + d = 0 \f$ where \f$ n \f$ is a unit normal vector of the plane (linear part)
43   * and \f$ d \f$ is the distance (offset) to the origin.
44   */
45 template <typename _Scalar, int _AmbientDim>
46 class Hyperplane
47 {
48 public:
49   EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF_VECTORIZABLE_FIXED_SIZE(_Scalar,_AmbientDim==Dynamic ? Dynamic : _AmbientDim+1)
50   enum { AmbientDimAtCompileTime = _AmbientDim };
51   typedef _Scalar Scalar;
52   typedef typename NumTraits<Scalar>::Real RealScalar;
53   typedef Matrix<Scalar,AmbientDimAtCompileTime,1> VectorType;
54   typedef Matrix<Scalar,int(AmbientDimAtCompileTime)==Dynamic
55                         ? Dynamic
56                         : int(AmbientDimAtCompileTime)+1,1> Coefficients;
57   typedef Block<Coefficients,AmbientDimAtCompileTime,1> NormalReturnType;
58
59   /** Default constructor without initialization */
60   inline explicit Hyperplane() {}
61
62   /** Constructs a dynamic-size hyperplane with \a _dim the dimension
63     * of the ambient space */
64   inline explicit Hyperplane(int _dim) : m_coeffs(_dim+1) {}
65
66   /** Construct a plane from its normal \a n and a point \a e onto the plane.
67     * \warning the vector normal is assumed to be normalized.
68     */
69   inline Hyperplane(const VectorType& n, const VectorType& e)
70     : m_coeffs(n.size()+1)
71   {
72     normal() = n;
73     offset() = -e.eigen2_dot(n);
74   }
75
76   /** Constructs a plane from its normal \a n and distance to the origin \a d
77     * such that the algebraic equation of the plane is \f$ n \cdot x + d = 0 \f$.
78     * \warning the vector normal is assumed to be normalized.
79     */
80   inline Hyperplane(const VectorType& n, Scalar d)
81     : m_coeffs(n.size()+1)
82   {
83     normal() = n;
84     offset() = d;
85   }
86
87   /** Constructs a hyperplane passing through the two points. If the dimension of the ambient space
88     * is greater than 2, then there isn't uniqueness, so an arbitrary choice is made.
89     */
90   static inline Hyperplane Through(const VectorType& p0, const VectorType& p1)
91   {
92     Hyperplane result(p0.size());
93     result.normal() = (p1 - p0).unitOrthogonal();
94     result.offset() = -result.normal().eigen2_dot(p0);
95     return result;
96   }
97
98   /** Constructs a hyperplane passing through the three points. The dimension of the ambient space
99     * is required to be exactly 3.
100     */
101   static inline Hyperplane Through(const VectorType& p0, const VectorType& p1, const VectorType& p2)
102   {
103     EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(VectorType, 3)
104     Hyperplane result(p0.size());
105     result.normal() = (p2 - p0).cross(p1 - p0).normalized();
106     result.offset() = -result.normal().eigen2_dot(p0);
107     return result;
108   }
109
110   /** Constructs a hyperplane passing through the parametrized line \a parametrized.
111     * If the dimension of the ambient space is greater than 2, then there isn't uniqueness,
112     * so an arbitrary choice is made.
113     */
114   // FIXME to be consitent with the rest this could be implemented as a static Through function ??
115   explicit Hyperplane(const ParametrizedLine<Scalar, AmbientDimAtCompileTime>& parametrized)
116   {
117     normal() = parametrized.direction().unitOrthogonal();
118     offset() = -normal().eigen2_dot(parametrized.origin());
119   }
120
121   ~Hyperplane() {}
122
123   /** \returns the dimension in which the plane holds */
124   inline int dim() const { return int(AmbientDimAtCompileTime)==Dynamic ? m_coeffs.size()-1 : int(AmbientDimAtCompileTime); }
125
126   /** normalizes \c *this */
127   void normalize(void)
128   {
129     m_coeffs /= normal().norm();
130   }
131
132   /** \returns the signed distance between the plane \c *this and a point \a p.
133     * \sa absDistance()
134     */
135   inline Scalar signedDistance(const VectorType& p) const { return p.eigen2_dot(normal()) + offset(); }
136
137   /** \returns the absolute distance between the plane \c *this and a point \a p.
138     * \sa signedDistance()
139     */
140   inline Scalar absDistance(const VectorType& p) const { return ei_abs(signedDistance(p)); }
141
142   /** \returns the projection of a point \a p onto the plane \c *this.
143     */
144   inline VectorType projection(const VectorType& p) const { return p - signedDistance(p) * normal(); }
145
146   /** \returns a constant reference to the unit normal vector of the plane, which corresponds
147     * to the linear part of the implicit equation.
148     */
149   inline const NormalReturnType normal() const { return NormalReturnType(*const_cast<Coefficients*>(&m_coeffs),0,0,dim(),1); }
150
151   /** \returns a non-constant reference to the unit normal vector of the plane, which corresponds
152     * to the linear part of the implicit equation.
153     */
154   inline NormalReturnType normal() { return NormalReturnType(m_coeffs,0,0,dim(),1); }
155
156   /** \returns the distance to the origin, which is also the "constant term" of the implicit equation
157     * \warning the vector normal is assumed to be normalized.
158     */
159   inline const Scalar& offset() const { return m_coeffs.coeff(dim()); }
160
161   /** \returns a non-constant reference to the distance to the origin, which is also the constant part
162     * of the implicit equation */
163   inline Scalar& offset() { return m_coeffs(dim()); }
164
165   /** \returns a constant reference to the coefficients c_i of the plane equation:
166     * \f$ c_0*x_0 + ... + c_{d-1}*x_{d-1} + c_d = 0 \f$
167     */
168   inline const Coefficients& coeffs() const { return m_coeffs; }
169
170   /** \returns a non-constant reference to the coefficients c_i of the plane equation:
171     * \f$ c_0*x_0 + ... + c_{d-1}*x_{d-1} + c_d = 0 \f$
172     */
173   inline Coefficients& coeffs() { return m_coeffs; }
174
175   /** \returns the intersection of *this with \a other.
176     *
177     * \warning The ambient space must be a plane, i.e. have dimension 2, so that \c *this and \a other are lines.
178     *
179     * \note If \a other is approximately parallel to *this, this method will return any point on *this.
180     */
181   VectorType intersection(const Hyperplane& other)
182   {
183     EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(VectorType, 2)
184     Scalar det = coeffs().coeff(0) * other.coeffs().coeff(1) - coeffs().coeff(1) * other.coeffs().coeff(0);
185     // since the line equations ax+by=c are normalized with a^2+b^2=1, the following tests
186     // whether the two lines are approximately parallel.
187     if(ei_isMuchSmallerThan(det, Scalar(1)))
188     {   // special case where the two lines are approximately parallel. Pick any point on the first line.
189         if(ei_abs(coeffs().coeff(1))>ei_abs(coeffs().coeff(0)))
190             return VectorType(coeffs().coeff(1), -coeffs().coeff(2)/coeffs().coeff(1)-coeffs().coeff(0));
191         else
192             return VectorType(-coeffs().coeff(2)/coeffs().coeff(0)-coeffs().coeff(1), coeffs().coeff(0));
193     }
194     else
195     {   // general case
196         Scalar invdet = Scalar(1) / det;
197         return VectorType(invdet*(coeffs().coeff(1)*other.coeffs().coeff(2)-other.coeffs().coeff(1)*coeffs().coeff(2)),
198                           invdet*(other.coeffs().coeff(0)*coeffs().coeff(2)-coeffs().coeff(0)*other.coeffs().coeff(2)));
199     }
200   }
201
202   /** Applies the transformation matrix \a mat to \c *this and returns a reference to \c *this.
203     *
204     * \param mat the Dim x Dim transformation matrix
205     * \param traits specifies whether the matrix \a mat represents an Isometry
206     *               or a more generic Affine transformation. The default is Affine.
207     */
208   template<typename XprType>
209   inline Hyperplane& transform(const MatrixBase<XprType>& mat, TransformTraits traits = Affine)
210   {
211     if (traits==Affine)
212       normal() = mat.inverse().transpose() * normal();
213     else if (traits==Isometry)
214       normal() = mat * normal();
215     else
216     {
217       ei_assert("invalid traits value in Hyperplane::transform()");
218     }
219     return *this;
220   }
221
222   /** Applies the transformation \a t to \c *this and returns a reference to \c *this.
223     *
224     * \param t the transformation of dimension Dim
225     * \param traits specifies whether the transformation \a t represents an Isometry
226     *               or a more generic Affine transformation. The default is Affine.
227     *               Other kind of transformations are not supported.
228     */
229   inline Hyperplane& transform(const Transform<Scalar,AmbientDimAtCompileTime>& t,
230                                 TransformTraits traits = Affine)
231   {
232     transform(t.linear(), traits);
233     offset() -= t.translation().eigen2_dot(normal());
234     return *this;
235   }
236
237   /** \returns \c *this with scalar type casted to \a NewScalarType
238     *
239     * Note that if \a NewScalarType is equal to the current scalar type of \c *this
240     * then this function smartly returns a const reference to \c *this.
241     */
242   template<typename NewScalarType>
243   inline typename internal::cast_return_type<Hyperplane,
244            Hyperplane<NewScalarType,AmbientDimAtCompileTime> >::type cast() const
245   {
246     return typename internal::cast_return_type<Hyperplane,
247                     Hyperplane<NewScalarType,AmbientDimAtCompileTime> >::type(*this);
248   }
249
250   /** Copy constructor with scalar type conversion */
251   template<typename OtherScalarType>
252   inline explicit Hyperplane(const Hyperplane<OtherScalarType,AmbientDimAtCompileTime>& other)
253   { m_coeffs = other.coeffs().template cast<Scalar>(); }
254
255   /** \returns \c true if \c *this is approximately equal to \a other, within the precision
256     * determined by \a prec.
257     *
258     * \sa MatrixBase::isApprox() */
259   bool isApprox(const Hyperplane& other, typename NumTraits<Scalar>::Real prec = precision<Scalar>()) const
260   { return m_coeffs.isApprox(other.m_coeffs, prec); }
261
262 protected:
263
264   Coefficients m_coeffs;
265 };