Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Core / Matrix.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) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
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_MATRIX_H
26 #define EIGEN_MATRIX_H
27
28
29 /** \class Matrix
30   *
31   * \brief The matrix class, also used for vectors and row-vectors
32   *
33   * The %Matrix class is the work-horse for all \em dense (\ref dense "note") matrices and vectors within Eigen.
34   * Vectors are matrices with one column, and row-vectors are matrices with one row.
35   *
36   * The %Matrix class encompasses \em both fixed-size and dynamic-size objects (\ref fixedsize "note").
37   *
38   * The first three template parameters are required:
39   * \param _Scalar Numeric type, i.e. float, double, int
40   * \param _Rows Number of rows, or \b Dynamic
41   * \param _Cols Number of columns, or \b Dynamic
42   *
43   * The remaining template parameters are optional -- in most cases you don't have to worry about them.
44   * \param _Options A combination of either \b RowMajor or \b ColMajor, and of either
45   *                 \b AutoAlign or \b DontAlign.
46   *                 The former controls storage order, and defaults to column-major. The latter controls alignment, which is required
47   *                 for vectorization. It defaults to aligning matrices except for fixed sizes that aren't a multiple of the packet size.
48   * \param _MaxRows Maximum number of rows. Defaults to \a _Rows (\ref maxrows "note").
49   * \param _MaxCols Maximum number of columns. Defaults to \a _Cols (\ref maxrows "note").
50   *
51   * Eigen provides a number of typedefs covering the usual cases. Here are some examples:
52   *
53   * \li \c Matrix2d is a 2x2 square matrix of doubles (\c Matrix<double, 2, 2>)
54   * \li \c Vector4f is a vector of 4 floats (\c Matrix<float, 4, 1>)
55   * \li \c RowVector3i is a row-vector of 3 ints (\c Matrix<int, 1, 3>)
56   *
57   * \li \c MatrixXf is a dynamic-size matrix of floats (\c Matrix<float, Dynamic, Dynamic>)
58   * \li \c VectorXf is a dynamic-size vector of floats (\c Matrix<float, Dynamic, 1>)
59   *
60   * See \link matrixtypedefs this page \endlink for a complete list of predefined \em %Matrix and \em Vector typedefs.
61   *
62   * You can access elements of vectors and matrices using normal subscripting:
63   *
64   * \code
65   * Eigen::VectorXd v(10);
66   * v[0] = 0.1;
67   * v[1] = 0.2;
68   * v(0) = 0.3;
69   * v(1) = 0.4;
70   *
71   * Eigen::MatrixXi m(10, 10);
72   * m(0, 1) = 1;
73   * m(0, 2) = 2;
74   * m(0, 3) = 3;
75   * \endcode
76   *
77   * <i><b>Some notes:</b></i>
78   *
79   * <dl>
80   * <dt><b>\anchor dense Dense versus sparse:</b></dt>
81   * <dd>This %Matrix class handles dense, not sparse matrices and vectors. For sparse matrices and vectors, see the Sparse module.
82   *
83   * Dense matrices and vectors are plain usual arrays of coefficients. All the coefficients are stored, in an ordinary contiguous array.
84   * This is unlike Sparse matrices and vectors where the coefficients are stored as a list of nonzero coefficients.</dd>
85   *
86   * <dt><b>\anchor fixedsize Fixed-size versus dynamic-size:</b></dt>
87   * <dd>Fixed-size means that the numbers of rows and columns are known are compile-time. In this case, Eigen allocates the array
88   * of coefficients as a fixed-size array, as a class member. This makes sense for very small matrices, typically up to 4x4, sometimes up
89   * to 16x16. Larger matrices should be declared as dynamic-size even if one happens to know their size at compile-time.
90   *
91   * Dynamic-size means that the numbers of rows or columns are not necessarily known at compile-time. In this case they are runtime
92   * variables, and the array of coefficients is allocated dynamically on the heap.
93   *
94   * Note that \em dense matrices, be they Fixed-size or Dynamic-size, <em>do not</em> expand dynamically in the sense of a std::map.
95   * If you want this behavior, see the Sparse module.</dd>
96   *
97   * <dt><b>\anchor maxrows _MaxRows and _MaxCols:</b></dt>
98   * <dd>In most cases, one just leaves these parameters to the default values.
99   * These parameters mean the maximum size of rows and columns that the matrix may have. They are useful in cases
100   * when the exact numbers of rows and columns are not known are compile-time, but it is known at compile-time that they cannot
101   * exceed a certain value. This happens when taking dynamic-size blocks inside fixed-size matrices: in this case _MaxRows and _MaxCols
102   * are the dimensions of the original matrix, while _Rows and _Cols are Dynamic.</dd>
103   * </dl>
104   *
105   * \see MatrixBase for the majority of the API methods for matrices
106   */
107 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
108 struct ei_traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
109 {
110   typedef _Scalar Scalar;
111   enum {
112     RowsAtCompileTime = _Rows,
113     ColsAtCompileTime = _Cols,
114     MaxRowsAtCompileTime = _MaxRows,
115     MaxColsAtCompileTime = _MaxCols,
116     Flags = ei_compute_matrix_flags<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::ret,
117     CoeffReadCost = NumTraits<Scalar>::ReadCost
118   };
119 };
120
121 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
122 class Matrix
123   : public MatrixBase<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
124 {
125   public:
126     EIGEN_GENERIC_PUBLIC_INTERFACE(Matrix)
127     enum { Options = _Options };
128     friend class Eigen::Map<Matrix, Unaligned>;
129     typedef class Eigen::Map<Matrix, Unaligned> UnalignedMapType;
130     friend class Eigen::Map<Matrix, Aligned>;
131     typedef class Eigen::Map<Matrix, Aligned> AlignedMapType;
132
133   protected:
134     ei_matrix_storage<Scalar, MaxSizeAtCompileTime, RowsAtCompileTime, ColsAtCompileTime, Options> m_storage;
135
136   public:
137     enum { NeedsToAlign = (Options&AutoAlign) == AutoAlign
138                           && SizeAtCompileTime!=Dynamic && ((sizeof(Scalar)*SizeAtCompileTime)%16)==0 };
139     EIGEN_MAKE_ALIGNED_OPERATOR_NEW_IF(NeedsToAlign)
140     
141     Base& base() { return *static_cast<Base*>(this); }
142     const Base& base() const { return *static_cast<const Base*>(this); }
143
144     EIGEN_STRONG_INLINE int rows() const { return m_storage.rows(); }
145     EIGEN_STRONG_INLINE int cols() const { return m_storage.cols(); }
146
147     EIGEN_STRONG_INLINE int stride(void) const
148     {
149       if(Flags & RowMajorBit)
150         return m_storage.cols();
151       else
152         return m_storage.rows();
153     }
154
155     EIGEN_STRONG_INLINE const Scalar& coeff(int row, int col) const
156     {
157       if(Flags & RowMajorBit)
158         return m_storage.data()[col + row * m_storage.cols()];
159       else // column-major
160         return m_storage.data()[row + col * m_storage.rows()];
161     }
162
163     EIGEN_STRONG_INLINE const Scalar& coeff(int index) const
164     {
165       return m_storage.data()[index];
166     }
167
168     EIGEN_STRONG_INLINE Scalar& coeffRef(int row, int col)
169     {
170       if(Flags & RowMajorBit)
171         return m_storage.data()[col + row * m_storage.cols()];
172       else // column-major
173         return m_storage.data()[row + col * m_storage.rows()];
174     }
175
176     EIGEN_STRONG_INLINE Scalar& coeffRef(int index)
177     {
178       return m_storage.data()[index];
179     }
180
181     template<int LoadMode>
182     EIGEN_STRONG_INLINE PacketScalar packet(int row, int col) const
183     {
184       return ei_ploadt<Scalar, LoadMode>
185                (m_storage.data() + (Flags & RowMajorBit
186                                    ? col + row * m_storage.cols()
187                                    : row + col * m_storage.rows()));
188     }
189
190     template<int LoadMode>
191     EIGEN_STRONG_INLINE PacketScalar packet(int index) const
192     {
193       return ei_ploadt<Scalar, LoadMode>(m_storage.data() + index);
194     }
195
196     template<int StoreMode>
197     EIGEN_STRONG_INLINE void writePacket(int row, int col, const PacketScalar& x)
198     {
199       ei_pstoret<Scalar, PacketScalar, StoreMode>
200               (m_storage.data() + (Flags & RowMajorBit
201                                    ? col + row * m_storage.cols()
202                                    : row + col * m_storage.rows()), x);
203     }
204
205     template<int StoreMode>
206     EIGEN_STRONG_INLINE void writePacket(int index, const PacketScalar& x)
207     {
208       ei_pstoret<Scalar, PacketScalar, StoreMode>(m_storage.data() + index, x);
209     }
210
211     /** \returns a const pointer to the data array of this matrix */
212     EIGEN_STRONG_INLINE const Scalar *data() const
213     { return m_storage.data(); }
214
215     /** \returns a pointer to the data array of this matrix */
216     EIGEN_STRONG_INLINE Scalar *data()
217     { return m_storage.data(); }
218
219     /** Resizes \c *this to a \a rows x \a cols matrix.
220       *
221       * Makes sense for dynamic-size matrices only.
222       *
223       * If the current number of coefficients of \c *this exactly matches the
224       * product \a rows * \a cols, then no memory allocation is performed and
225       * the current values are left unchanged. In all other cases, including
226       * shrinking, the data is reallocated and all previous values are lost.
227       *
228       * \sa resize(int) for vectors.
229       */
230     inline void resize(int rows, int cols)
231     {
232       ei_assert((MaxRowsAtCompileTime == Dynamic || MaxRowsAtCompileTime >= rows)
233              && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == rows)
234              && (MaxColsAtCompileTime == Dynamic || MaxColsAtCompileTime >= cols)
235              && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == cols));
236       m_storage.resize(rows * cols, rows, cols);
237     }
238
239     /** Resizes \c *this to a vector of length \a size
240       *
241       * \sa resize(int,int) for the details.
242       */
243     inline void resize(int size)
244     {
245       EIGEN_STATIC_ASSERT_VECTOR_ONLY(Matrix)
246       if(RowsAtCompileTime == 1)
247         m_storage.resize(size, 1, size);
248       else
249         m_storage.resize(size, size, 1);
250     }
251
252     /** Copies the value of the expression \a other into \c *this with automatic resizing.
253       *
254       * *this might be resized to match the dimensions of \a other. If *this was a null matrix (not already initialized),
255       * it will be initialized.
256       *
257       * Note that copying a row-vector into a vector (and conversely) is allowed.
258       * The resizing, if any, is then done in the appropriate way so that row-vectors
259       * remain row-vectors and vectors remain vectors.
260       */
261     template<typename OtherDerived>
262     EIGEN_STRONG_INLINE Matrix& operator=(const MatrixBase<OtherDerived>& other)
263     {
264       return _set(other);
265     }
266
267     /** This is a special case of the templated operator=. Its purpose is to
268       * prevent a default operator= from hiding the templated operator=.
269       */
270     EIGEN_STRONG_INLINE Matrix& operator=(const Matrix& other)
271     {
272       return _set(other);
273     }
274
275     EIGEN_INHERIT_ASSIGNMENT_OPERATOR(Matrix, +=)
276     EIGEN_INHERIT_ASSIGNMENT_OPERATOR(Matrix, -=)
277     EIGEN_INHERIT_SCALAR_ASSIGNMENT_OPERATOR(Matrix, *=)
278     EIGEN_INHERIT_SCALAR_ASSIGNMENT_OPERATOR(Matrix, /=)
279
280     /** Default constructor.
281       *
282       * For fixed-size matrices, does nothing.
283       *
284       * For dynamic-size matrices, creates an empty matrix of size 0. Does not allocate any array. Such a matrix
285       * is called a null matrix. This constructor is the unique way to create null matrices: resizing
286       * a matrix to 0 is not supported.
287       *
288       * \sa resize(int,int)
289       */
290     EIGEN_STRONG_INLINE explicit Matrix() : m_storage()
291     {
292       _check_template_params();
293     }
294
295 #ifndef EIGEN_PARSED_BY_DOXYGEN
296     /** \internal */
297     Matrix(ei_constructor_without_unaligned_array_assert)
298       : m_storage(ei_constructor_without_unaligned_array_assert())
299     {}
300 #endif
301
302     /** Constructs a vector or row-vector with given dimension. \only_for_vectors
303       *
304       * Note that this is only useful for dynamic-size vectors. For fixed-size vectors,
305       * it is redundant to pass the dimension here, so it makes more sense to use the default
306       * constructor Matrix() instead.
307       */
308     EIGEN_STRONG_INLINE explicit Matrix(int dim)
309       : m_storage(dim, RowsAtCompileTime == 1 ? 1 : dim, ColsAtCompileTime == 1 ? 1 : dim)
310     {
311       _check_template_params();
312       EIGEN_STATIC_ASSERT_VECTOR_ONLY(Matrix)
313       ei_assert(dim > 0);
314       ei_assert(SizeAtCompileTime == Dynamic || SizeAtCompileTime == dim);
315     }
316
317     /** This constructor has two very different behaviors, depending on the type of *this.
318       *
319       * \li When Matrix is a fixed-size vector type of size 2, this constructor constructs
320       *     an initialized vector. The parameters \a x, \a y are copied into the first and second
321       *     coords of the vector respectively.
322       * \li Otherwise, this constructor constructs an uninitialized matrix with \a x rows and
323       *     \a y columns. This is useful for dynamic-size matrices. For fixed-size matrices,
324       *     it is redundant to pass these parameters, so one should use the default constructor
325       *     Matrix() instead.
326       */
327     EIGEN_STRONG_INLINE Matrix(int x, int y) : m_storage(x*y, x, y)
328     {
329       _check_template_params();
330       if((RowsAtCompileTime == 1 && ColsAtCompileTime == 2)
331       || (RowsAtCompileTime == 2 && ColsAtCompileTime == 1))
332       {
333         m_storage.data()[0] = Scalar(x);
334         m_storage.data()[1] = Scalar(y);
335       }
336       else
337       {
338         ei_assert(x > 0 && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == x)
339                && y > 0 && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == y));
340       }
341     }
342     /** constructs an initialized 2D vector with given coefficients */
343     EIGEN_STRONG_INLINE Matrix(const float& x, const float& y)
344     {
345       _check_template_params();
346       EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Matrix, 2)
347       m_storage.data()[0] = x;
348       m_storage.data()[1] = y;
349     }
350     /** constructs an initialized 2D vector with given coefficients */
351     EIGEN_STRONG_INLINE Matrix(const double& x, const double& y)
352     {
353       _check_template_params();
354       EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Matrix, 2)
355       m_storage.data()[0] = x;
356       m_storage.data()[1] = y;
357     }
358     /** constructs an initialized 3D vector with given coefficients */
359     EIGEN_STRONG_INLINE Matrix(const Scalar& x, const Scalar& y, const Scalar& z)
360     {
361       _check_template_params();
362       EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Matrix, 3)
363       m_storage.data()[0] = x;
364       m_storage.data()[1] = y;
365       m_storage.data()[2] = z;
366     }
367     /** constructs an initialized 4D vector with given coefficients */
368     EIGEN_STRONG_INLINE Matrix(const Scalar& x, const Scalar& y, const Scalar& z, const Scalar& w)
369     {
370       _check_template_params();
371       EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Matrix, 4)
372       m_storage.data()[0] = x;
373       m_storage.data()[1] = y;
374       m_storage.data()[2] = z;
375       m_storage.data()[3] = w;
376     }
377
378     explicit Matrix(const Scalar *data);
379
380     /** Constructor copying the value of the expression \a other */
381     template<typename OtherDerived>
382     EIGEN_STRONG_INLINE Matrix(const MatrixBase<OtherDerived>& other)
383              : m_storage(other.rows() * other.cols(), other.rows(), other.cols())
384     {
385       _check_template_params();
386       _set_noalias(other);
387     }
388     /** Copy constructor */
389     EIGEN_STRONG_INLINE Matrix(const Matrix& other)
390             : Base(), m_storage(other.rows() * other.cols(), other.rows(), other.cols())
391     {
392       _check_template_params();
393       _set_noalias(other);
394     }
395     /** Destructor */
396     inline ~Matrix() {}
397
398     /** Override MatrixBase::swap() since for dynamic-sized matrices of same type it is enough to swap the
399       * data pointers.
400       */
401     template<typename OtherDerived>
402     void swap(const MatrixBase<OtherDerived>& other);
403
404     /** \name Map
405       * These are convenience functions returning Map objects. The Map() static functions return unaligned Map objects,
406       * while the AlignedMap() functions return aligned Map objects and thus should be called only with 16-byte-aligned
407       * \a data pointers.
408       *
409       * \see class Map
410       */
411     //@{
412     inline static const UnalignedMapType Map(const Scalar* data)
413     { return UnalignedMapType(data); }
414     inline static UnalignedMapType Map(Scalar* data)
415     { return UnalignedMapType(data); }
416     inline static const UnalignedMapType Map(const Scalar* data, int size)
417     { return UnalignedMapType(data, size); }
418     inline static UnalignedMapType Map(Scalar* data, int size)
419     { return UnalignedMapType(data, size); }
420     inline static const UnalignedMapType Map(const Scalar* data, int rows, int cols)
421     { return UnalignedMapType(data, rows, cols); }
422     inline static UnalignedMapType Map(Scalar* data, int rows, int cols)
423     { return UnalignedMapType(data, rows, cols); }
424
425     inline static const AlignedMapType MapAligned(const Scalar* data)
426     { return AlignedMapType(data); }
427     inline static AlignedMapType MapAligned(Scalar* data)
428     { return AlignedMapType(data); }
429     inline static const AlignedMapType MapAligned(const Scalar* data, int size)
430     { return AlignedMapType(data, size); }
431     inline static AlignedMapType MapAligned(Scalar* data, int size)
432     { return AlignedMapType(data, size); }
433     inline static const AlignedMapType MapAligned(const Scalar* data, int rows, int cols)
434     { return AlignedMapType(data, rows, cols); }
435     inline static AlignedMapType MapAligned(Scalar* data, int rows, int cols)
436     { return AlignedMapType(data, rows, cols); }
437     //@}
438
439     using Base::setConstant;
440     Matrix& setConstant(int size, const Scalar& value);
441     Matrix& setConstant(int rows, int cols, const Scalar& value);
442
443     using Base::setZero;
444     Matrix& setZero(int size);
445     Matrix& setZero(int rows, int cols);
446
447     using Base::setOnes;
448     Matrix& setOnes(int size);
449     Matrix& setOnes(int rows, int cols);
450
451     using Base::setRandom;
452     Matrix& setRandom(int size);
453     Matrix& setRandom(int rows, int cols);
454
455     using Base::setIdentity;
456     Matrix& setIdentity(int rows, int cols);
457
458 /////////// Geometry module ///////////
459
460     template<typename OtherDerived>
461     explicit Matrix(const RotationBase<OtherDerived,ColsAtCompileTime>& r);
462     template<typename OtherDerived>
463     Matrix& operator=(const RotationBase<OtherDerived,ColsAtCompileTime>& r);
464
465     // allow to extend Matrix outside Eigen
466     #ifdef EIGEN_MATRIX_PLUGIN
467     #include EIGEN_MATRIX_PLUGIN
468     #endif
469
470   private:
471     /** \internal Resizes *this in preparation for assigning \a other to it.
472       * Takes care of doing all the checking that's needed.
473       *
474       * Note that copying a row-vector into a vector (and conversely) is allowed.
475       * The resizing, if any, is then done in the appropriate way so that row-vectors
476       * remain row-vectors and vectors remain vectors.
477       */
478     template<typename OtherDerived>
479     EIGEN_STRONG_INLINE void _resize_to_match(const MatrixBase<OtherDerived>& other)
480     {
481       if(RowsAtCompileTime == 1)
482       {
483         ei_assert(other.isVector());
484         resize(1, other.size());
485       }
486       else if(ColsAtCompileTime == 1)
487       {
488         ei_assert(other.isVector());
489         resize(other.size(), 1);
490       }
491       else resize(other.rows(), other.cols());
492     }
493
494     /** \internal Copies the value of the expression \a other into \c *this with automatic resizing.
495       *
496       * *this might be resized to match the dimensions of \a other. If *this was a null matrix (not already initialized),
497       * it will be initialized.
498       *
499       * Note that copying a row-vector into a vector (and conversely) is allowed.
500       * The resizing, if any, is then done in the appropriate way so that row-vectors
501       * remain row-vectors and vectors remain vectors.
502       *
503       * \sa operator=(const MatrixBase<OtherDerived>&), _set_noalias()
504       */
505     template<typename OtherDerived>
506     EIGEN_STRONG_INLINE Matrix& _set(const MatrixBase<OtherDerived>& other)
507     {
508       _set_selector(other.derived(), typename ei_meta_if<bool(int(OtherDerived::Flags) & EvalBeforeAssigningBit), ei_meta_true, ei_meta_false>::ret());
509       return *this;
510     }
511
512     template<typename OtherDerived>
513     EIGEN_STRONG_INLINE void _set_selector(const OtherDerived& other, const ei_meta_true&) { _set_noalias(other.eval()); }
514
515     template<typename OtherDerived>
516     EIGEN_STRONG_INLINE void _set_selector(const OtherDerived& other, const ei_meta_false&) { _set_noalias(other); }
517
518     /** \internal Like _set() but additionally makes the assumption that no aliasing effect can happen (which
519       * is the case when creating a new matrix) so one can enforce lazy evaluation.
520       *
521       * \sa operator=(const MatrixBase<OtherDerived>&), _set()
522       */
523     template<typename OtherDerived>
524     EIGEN_STRONG_INLINE Matrix& _set_noalias(const MatrixBase<OtherDerived>& other)
525     {
526       _resize_to_match(other);
527       // the 'false' below means to enforce lazy evaluation. We don't use lazyAssign() because
528       // it wouldn't allow to copy a row-vector into a column-vector.
529       return ei_assign_selector<Matrix,OtherDerived,false>::run(*this, other.derived());
530     }
531
532     static EIGEN_STRONG_INLINE void _check_template_params()
533     {
534         EIGEN_STATIC_ASSERT((_Rows > 0
535                         && _Cols > 0
536                         && _MaxRows <= _Rows
537                         && _MaxCols <= _Cols
538                         && (_Options & (AutoAlign|RowMajor)) == _Options),
539           INVALID_MATRIX_TEMPLATE_PARAMETERS)
540     }
541     
542     template<typename MatrixType, typename OtherDerived, bool IsSameType, bool IsDynamicSize>
543     friend struct ei_matrix_swap_impl;
544 };
545
546 template<typename MatrixType, typename OtherDerived,
547          bool IsSameType = ei_is_same_type<MatrixType, OtherDerived>::ret,
548          bool IsDynamicSize = MatrixType::SizeAtCompileTime==Dynamic>
549 struct ei_matrix_swap_impl
550 {
551   static inline void run(MatrixType& matrix, MatrixBase<OtherDerived>& other)
552   {
553     matrix.base().swap(other);
554   }
555 };
556
557 template<typename MatrixType, typename OtherDerived>
558 struct ei_matrix_swap_impl<MatrixType, OtherDerived, true, true>
559 {
560   static inline void run(MatrixType& matrix, MatrixBase<OtherDerived>& other)
561   {
562     matrix.m_storage.swap(other.derived().m_storage);
563   }
564 };
565
566 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
567 template<typename OtherDerived>
568 inline void Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::swap(const MatrixBase<OtherDerived>& other)
569 {
570   ei_matrix_swap_impl<Matrix, OtherDerived>::run(*this, *const_cast<MatrixBase<OtherDerived>*>(&other));
571 }
572
573
574 /** \defgroup matrixtypedefs Global matrix typedefs
575   *
576   * \ingroup Core_Module
577   *
578   * Eigen defines several typedef shortcuts for most common matrix and vector types.
579   *
580   * The general patterns are the following:
581   *
582   * \c MatrixSizeType where \c Size can be \c 2,\c 3,\c 4 for fixed size square matrices or \c X for dynamic size,
583   * and where \c Type can be \c i for integer, \c f for float, \c d for double, \c cf for complex float, \c cd
584   * for complex double.
585   *
586   * For example, \c Matrix3d is a fixed-size 3x3 matrix type of doubles, and \c MatrixXf is a dynamic-size matrix of floats.
587   *
588   * There are also \c VectorSizeType and \c RowVectorSizeType which are self-explanatory. For example, \c Vector4cf is
589   * a fixed-size vector of 4 complex floats.
590   *
591   * \sa class Matrix
592   */
593
594 #define EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, Size, SizeSuffix)   \
595 /** \ingroup matrixtypedefs */                                    \
596 typedef Matrix<Type, Size, Size> Matrix##SizeSuffix##TypeSuffix;  \
597 /** \ingroup matrixtypedefs */                                    \
598 typedef Matrix<Type, Size, 1>    Vector##SizeSuffix##TypeSuffix;  \
599 /** \ingroup matrixtypedefs */                                    \
600 typedef Matrix<Type, 1, Size>    RowVector##SizeSuffix##TypeSuffix;
601
602 #define EIGEN_MAKE_TYPEDEFS_ALL_SIZES(Type, TypeSuffix) \
603 EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, 2, 2) \
604 EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, 3, 3) \
605 EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, 4, 4) \
606 EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, Dynamic, X)
607
608 EIGEN_MAKE_TYPEDEFS_ALL_SIZES(int,                  i)
609 EIGEN_MAKE_TYPEDEFS_ALL_SIZES(float,                f)
610 EIGEN_MAKE_TYPEDEFS_ALL_SIZES(double,               d)
611 EIGEN_MAKE_TYPEDEFS_ALL_SIZES(std::complex<float>,  cf)
612 EIGEN_MAKE_TYPEDEFS_ALL_SIZES(std::complex<double>, cd)
613
614 #undef EIGEN_MAKE_TYPEDEFS_ALL_SIZES
615 #undef EIGEN_MAKE_TYPEDEFS
616
617 #undef EIGEN_MAKE_TYPEDEFS_LARGE
618
619 #define EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, SizeSuffix) \
620 using Eigen::Matrix##SizeSuffix##TypeSuffix; \
621 using Eigen::Vector##SizeSuffix##TypeSuffix; \
622 using Eigen::RowVector##SizeSuffix##TypeSuffix;
623
624 #define EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE(TypeSuffix) \
625 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 2) \
626 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 3) \
627 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 4) \
628 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, X) \
629
630 #define EIGEN_USING_MATRIX_TYPEDEFS \
631 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE(i) \
632 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE(f) \
633 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE(d) \
634 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE(cf) \
635 EIGEN_USING_MATRIX_TYPEDEFS_FOR_TYPE(cd)
636
637 #endif // EIGEN_MATRIX_H