Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Core / Map.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 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
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_MAP_H
27 #define EIGEN_MAP_H
28
29 /** \class Map
30   *
31   * \brief A matrix or vector expression mapping an existing array of data.
32   *
33   * \param MatrixType the equivalent matrix type of the mapped data
34   * \param _PacketAccess allows to enforce aligned loads and stores if set to ForceAligned.
35   *                      The default is AsRequested. This parameter is internaly used by Eigen
36   *                      in expressions such as \code Map<...>(...) += other; \endcode and most
37   *                      of the time this is the only way it is used.
38   *
39   * This class represents a matrix or vector expression mapping an existing array of data.
40   * It can be used to let Eigen interface without any overhead with non-Eigen data structures,
41   * such as plain C arrays or structures from other libraries.
42   *
43   * This class is the return type of Matrix::Map() but can also be used directly.
44   *
45   * \sa Matrix::Map()
46   */
47 template<typename MatrixType, int _PacketAccess>
48 struct ei_traits<Map<MatrixType, _PacketAccess> > : public ei_traits<MatrixType>
49 {
50   enum {
51     PacketAccess = _PacketAccess,
52     Flags = ei_traits<MatrixType>::Flags & ~AlignedBit
53   };
54   typedef typename ei_meta_if<int(PacketAccess)==ForceAligned,
55                               Map<MatrixType, _PacketAccess>&,
56                               Map<MatrixType, ForceAligned> >::ret AlignedDerivedType;
57 };
58
59 template<typename MatrixType, int PacketAccess> class Map
60   : public MapBase<Map<MatrixType, PacketAccess> >
61 {
62   public:
63
64     _EIGEN_GENERIC_PUBLIC_INTERFACE(Map, MapBase<Map>)
65     typedef typename ei_traits<Map>::AlignedDerivedType AlignedDerivedType;
66
67     inline int stride() const { return this->innerSize(); }
68
69     AlignedDerivedType _convertToForceAligned()
70     {
71       return Map<MatrixType,ForceAligned>(Base::m_data, Base::m_rows.value(), Base::m_cols.value());
72     }
73
74     inline Map(const Scalar* data) : Base(data) {}
75
76     inline Map(const Scalar* data, int size) : Base(data, size) {}
77
78     inline Map(const Scalar* data, int rows, int cols) : Base(data, rows, cols) {}
79
80     inline void resize(int rows, int cols)
81     {
82       EIGEN_ONLY_USED_FOR_DEBUG(rows);
83       EIGEN_ONLY_USED_FOR_DEBUG(cols);
84       ei_assert(rows == this->rows());
85       ei_assert(cols == this->cols());
86     }
87
88     inline void resize(int size)
89     {
90       EIGEN_STATIC_ASSERT_VECTOR_ONLY(MatrixType)
91       EIGEN_ONLY_USED_FOR_DEBUG(size);
92       ei_assert(size == this->size());
93     }
94
95     EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Map)
96 };
97
98 /** Constructor copying an existing array of data.
99   * Only for fixed-size matrices and vectors.
100   * \param data The array of data to copy
101   *
102   * \sa Matrix::Map(const Scalar *)
103   */
104 template<typename _Scalar, int _Rows, int _Cols, int _StorageOrder, int _MaxRows, int _MaxCols>
105 inline Matrix<_Scalar, _Rows, _Cols, _StorageOrder, _MaxRows, _MaxCols>
106   ::Matrix(const Scalar *data)
107 {
108   _set_noalias(Eigen::Map<Matrix>(data));
109 }
110
111 #endif // EIGEN_MAP_H