Camera tracking integration
[blender.git] / extern / Eigen3 / Eigen / src / Core / Map.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2007-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
5 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.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   * \ingroup Core_Module
31   *
32   * \brief A matrix or vector expression mapping an existing array of data.
33   *
34   * \tparam PlainObjectType the equivalent matrix type of the mapped data
35   * \tparam MapOptions specifies whether the pointer is \c #Aligned, or \c #Unaligned.
36   *                The default is \c #Unaligned.
37   * \tparam StrideType optionally specifies strides. By default, Map assumes the memory layout
38   *                   of an ordinary, contiguous array. This can be overridden by specifying strides.
39   *                   The type passed here must be a specialization of the Stride template, see examples below.
40   *
41   * This class represents a matrix or vector expression mapping an existing array of data.
42   * It can be used to let Eigen interface without any overhead with non-Eigen data structures,
43   * such as plain C arrays or structures from other libraries. By default, it assumes that the
44   * data is laid out contiguously in memory. You can however override this by explicitly specifying
45   * inner and outer strides.
46   *
47   * Here's an example of simply mapping a contiguous array as a \ref TopicStorageOrders "column-major" matrix:
48   * \include Map_simple.cpp
49   * Output: \verbinclude Map_simple.out
50   *
51   * If you need to map non-contiguous arrays, you can do so by specifying strides:
52   *
53   * Here's an example of mapping an array as a vector, specifying an inner stride, that is, the pointer
54   * increment between two consecutive coefficients. Here, we're specifying the inner stride as a compile-time
55   * fixed value.
56   * \include Map_inner_stride.cpp
57   * Output: \verbinclude Map_inner_stride.out
58   *
59   * Here's an example of mapping an array while specifying an outer stride. Here, since we're mapping
60   * as a column-major matrix, 'outer stride' means the pointer increment between two consecutive columns.
61   * Here, we're specifying the outer stride as a runtime parameter. Note that here \c OuterStride<> is
62   * a short version of \c OuterStride<Dynamic> because the default template parameter of OuterStride
63   * is  \c Dynamic
64   * \include Map_outer_stride.cpp
65   * Output: \verbinclude Map_outer_stride.out
66   *
67   * For more details and for an example of specifying both an inner and an outer stride, see class Stride.
68   *
69   * \b Tip: to change the array of data mapped by a Map object, you can use the C++
70   * placement new syntax:
71   *
72   * Example: \include Map_placement_new.cpp
73   * Output: \verbinclude Map_placement_new.out
74   *
75   * This class is the return type of PlainObjectBase::Map() but can also be used directly.
76   *
77   * \sa PlainObjectBase::Map(), \ref TopicStorageOrders
78   */
79
80 namespace internal {
81 template<typename PlainObjectType, int MapOptions, typename StrideType>
82 struct traits<Map<PlainObjectType, MapOptions, StrideType> >
83   : public traits<PlainObjectType>
84 {
85   typedef traits<PlainObjectType> TraitsBase;
86   typedef typename PlainObjectType::Index Index;
87   typedef typename PlainObjectType::Scalar Scalar;
88   enum {
89     InnerStrideAtCompileTime = StrideType::InnerStrideAtCompileTime == 0
90                              ? int(PlainObjectType::InnerStrideAtCompileTime)
91                              : int(StrideType::InnerStrideAtCompileTime),
92     OuterStrideAtCompileTime = StrideType::OuterStrideAtCompileTime == 0
93                              ? int(PlainObjectType::OuterStrideAtCompileTime)
94                              : int(StrideType::OuterStrideAtCompileTime),
95     HasNoInnerStride = InnerStrideAtCompileTime == 1,
96     HasNoOuterStride = StrideType::OuterStrideAtCompileTime == 0,
97     HasNoStride = HasNoInnerStride && HasNoOuterStride,
98     IsAligned = bool(EIGEN_ALIGN) && ((int(MapOptions)&Aligned)==Aligned),
99     IsDynamicSize = PlainObjectType::SizeAtCompileTime==Dynamic,
100     KeepsPacketAccess = bool(HasNoInnerStride)
101                         && ( bool(IsDynamicSize)
102                            || HasNoOuterStride
103                            || ( OuterStrideAtCompileTime!=Dynamic
104                            && ((static_cast<int>(sizeof(Scalar))*OuterStrideAtCompileTime)%16)==0 ) ),
105     Flags0 = TraitsBase::Flags,
106     Flags1 = IsAligned ? (int(Flags0) | AlignedBit) : (int(Flags0) & ~AlignedBit),
107     Flags2 = (bool(HasNoStride) || bool(PlainObjectType::IsVectorAtCompileTime))
108            ? int(Flags1) : int(Flags1 & ~LinearAccessBit),
109     Flags3 = is_lvalue<PlainObjectType>::value ? int(Flags2) : (int(Flags2) & ~LvalueBit),
110     Flags = KeepsPacketAccess ? int(Flags3) : (int(Flags3) & ~PacketAccessBit)
111   };
112 private:
113   enum { Options }; // Expressions don't have Options
114 };
115 }
116
117 template<typename PlainObjectType, int MapOptions, typename StrideType> class Map
118   : public MapBase<Map<PlainObjectType, MapOptions, StrideType> >
119 {
120   public:
121
122     typedef MapBase<Map> Base;
123
124     EIGEN_DENSE_PUBLIC_INTERFACE(Map)
125
126     typedef typename Base::PointerType PointerType;
127 #if EIGEN2_SUPPORT_STAGE <= STAGE30_FULL_EIGEN3_API
128     typedef const Scalar* PointerArgType;
129     inline PointerType cast_to_pointer_type(PointerArgType ptr) { return const_cast<PointerType>(ptr); }
130 #else
131     typedef PointerType PointerArgType;
132     inline PointerType cast_to_pointer_type(PointerArgType ptr) { return ptr; }
133 #endif
134
135     inline Index innerStride() const
136     {
137       return StrideType::InnerStrideAtCompileTime != 0 ? m_stride.inner() : 1;
138     }
139
140     inline Index outerStride() const
141     {
142       return StrideType::OuterStrideAtCompileTime != 0 ? m_stride.outer()
143            : IsVectorAtCompileTime ? this->size()
144            : int(Flags)&RowMajorBit ? this->cols()
145            : this->rows();
146     }
147
148     /** Constructor in the fixed-size case.
149       *
150       * \param data pointer to the array to map
151       * \param stride optional Stride object, passing the strides.
152       */
153     inline Map(PointerArgType data, const StrideType& stride = StrideType())
154       : Base(cast_to_pointer_type(data)), m_stride(stride)
155     {
156       PlainObjectType::Base::_check_template_params();
157     }
158
159     /** Constructor in the dynamic-size vector case.
160       *
161       * \param data pointer to the array to map
162       * \param size the size of the vector expression
163       * \param stride optional Stride object, passing the strides.
164       */
165     inline Map(PointerArgType data, Index size, const StrideType& stride = StrideType())
166       : Base(cast_to_pointer_type(data), size), m_stride(stride)
167     {
168       PlainObjectType::Base::_check_template_params();
169     }
170
171     /** Constructor in the dynamic-size matrix case.
172       *
173       * \param data pointer to the array to map
174       * \param rows the number of rows of the matrix expression
175       * \param cols the number of columns of the matrix expression
176       * \param stride optional Stride object, passing the strides.
177       */
178     inline Map(PointerArgType data, Index rows, Index cols, const StrideType& stride = StrideType())
179       : Base(cast_to_pointer_type(data), rows, cols), m_stride(stride)
180     {
181       PlainObjectType::Base::_check_template_params();
182     }
183
184
185     EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Map)
186
187   protected:
188     StrideType m_stride;
189 };
190
191 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
192 inline Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>
193   ::Array(const Scalar *data)
194 {
195   this->_set_noalias(Eigen::Map<const Array>(data));
196 }
197
198 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
199 inline Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>
200   ::Matrix(const Scalar *data)
201 {
202   this->_set_noalias(Eigen::Map<const Matrix>(data));
203 }
204
205 #endif // EIGEN_MAP_H