Eigen  3.3.0
 
Loading...
Searching...
No Matches
Array.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2009 Gael Guennebaud <gael.guennebaud@inria.fr>
5//
6// This Source Code Form is subject to the terms of the Mozilla
7// Public License v. 2.0. If a copy of the MPL was not distributed
8// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9
10#ifndef EIGEN_ARRAY_H
11#define EIGEN_ARRAY_H
12
13namespace Eigen {
14
15namespace internal {
16template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
17struct traits<Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> > : traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
18{
19 typedef ArrayXpr XprKind;
20 typedef ArrayBase<Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> > XprBase;
21};
22}
23
44template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
45class Array
46 : public PlainObjectBase<Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
47{
48 public:
49
51 EIGEN_DENSE_PUBLIC_INTERFACE(Array)
52
53 enum { Options = _Options };
54 typedef typename Base::PlainObject PlainObject;
55
56 protected:
57 template <typename Derived, typename OtherDerived, bool IsVector>
58 friend struct internal::conservative_resize_like_impl;
59
60 using Base::m_storage;
61
62 public:
63
64 using Base::base;
65 using Base::coeff;
66 using Base::coeffRef;
67
74 template<typename OtherDerived>
75 EIGEN_DEVICE_FUNC
76 EIGEN_STRONG_INLINE Array& operator=(const EigenBase<OtherDerived> &other)
77 {
78 return Base::operator=(other);
79 }
80
84 /* This overload is needed because the usage of
85 * using Base::operator=;
86 * fails on MSVC. Since the code below is working with GCC and MSVC, we skipped
87 * the usage of 'using'. This should be done only for operator=.
88 */
89 EIGEN_DEVICE_FUNC
90 EIGEN_STRONG_INLINE Array& operator=(const Scalar &value)
91 {
92 Base::setConstant(value);
93 return *this;
94 }
95
105 template<typename OtherDerived>
106 EIGEN_DEVICE_FUNC
107 EIGEN_STRONG_INLINE Array& operator=(const DenseBase<OtherDerived>& other)
108 {
109 return Base::_set(other);
110 }
111
115 EIGEN_DEVICE_FUNC
116 EIGEN_STRONG_INLINE Array& operator=(const Array& other)
117 {
118 return Base::_set(other);
119 }
120
131 EIGEN_DEVICE_FUNC
132 EIGEN_STRONG_INLINE Array() : Base()
133 {
134 Base::_check_template_params();
135 EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
136 }
137
138#ifndef EIGEN_PARSED_BY_DOXYGEN
139 // FIXME is it still needed ??
141 EIGEN_DEVICE_FUNC
142 Array(internal::constructor_without_unaligned_array_assert)
143 : Base(internal::constructor_without_unaligned_array_assert())
144 {
145 Base::_check_template_params();
146 EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
147 }
148#endif
149
150#if EIGEN_HAS_RVALUE_REFERENCES
151 EIGEN_DEVICE_FUNC
152 Array(Array&& other) EIGEN_NOEXCEPT_IF(std::is_nothrow_move_constructible<Scalar>::value)
153 : Base(std::move(other))
154 {
155 Base::_check_template_params();
156 if (RowsAtCompileTime!=Dynamic && ColsAtCompileTime!=Dynamic)
157 Base::_set_noalias(other);
158 }
159 EIGEN_DEVICE_FUNC
160 Array& operator=(Array&& other) EIGEN_NOEXCEPT_IF(std::is_nothrow_move_assignable<Scalar>::value)
161 {
162 other.swap(*this);
163 return *this;
164 }
165#endif
166
167 #ifndef EIGEN_PARSED_BY_DOXYGEN
168 template<typename T>
169 EIGEN_DEVICE_FUNC
170 EIGEN_STRONG_INLINE explicit Array(const T& x)
171 {
172 Base::_check_template_params();
173 Base::template _init1<T>(x);
174 }
175
176 template<typename T0, typename T1>
177 EIGEN_DEVICE_FUNC
178 EIGEN_STRONG_INLINE Array(const T0& val0, const T1& val1)
179 {
180 Base::_check_template_params();
181 this->template _init2<T0,T1>(val0, val1);
182 }
183 #else
185 EIGEN_DEVICE_FUNC explicit Array(const Scalar *data);
192 EIGEN_DEVICE_FUNC
193 EIGEN_STRONG_INLINE explicit Array(Index dim);
195 Array(const Scalar& value);
201 Array(Index rows, Index cols);
203 Array(const Scalar& val0, const Scalar& val1);
204 #endif
205
207 EIGEN_DEVICE_FUNC
208 EIGEN_STRONG_INLINE Array(const Scalar& val0, const Scalar& val1, const Scalar& val2)
209 {
210 Base::_check_template_params();
211 EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Array, 3)
212 m_storage.data()[0] = val0;
213 m_storage.data()[1] = val1;
214 m_storage.data()[2] = val2;
215 }
217 EIGEN_DEVICE_FUNC
218 EIGEN_STRONG_INLINE Array(const Scalar& val0, const Scalar& val1, const Scalar& val2, const Scalar& val3)
219 {
220 Base::_check_template_params();
221 EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Array, 4)
222 m_storage.data()[0] = val0;
223 m_storage.data()[1] = val1;
224 m_storage.data()[2] = val2;
225 m_storage.data()[3] = val3;
226 }
227
229 EIGEN_DEVICE_FUNC
230 EIGEN_STRONG_INLINE Array(const Array& other)
231 : Base(other)
232 { }
233
235 template<typename OtherDerived>
236 EIGEN_DEVICE_FUNC
237 EIGEN_STRONG_INLINE Array(const EigenBase<OtherDerived> &other)
238 : Base(other.derived())
239 { }
240
241 EIGEN_DEVICE_FUNC inline Index innerStride() const { return 1; }
242 EIGEN_DEVICE_FUNC inline Index outerStride() const { return this->innerSize(); }
243
244 #ifdef EIGEN_ARRAY_PLUGIN
245 #include EIGEN_ARRAY_PLUGIN
246 #endif
247
248 private:
249
250 template<typename MatrixType, typename OtherDerived, bool SwapPointers>
251 friend struct internal::matrix_swap_impl;
252};
253
273#define EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, Size, SizeSuffix) \
274 \
275typedef Array<Type, Size, Size> Array##SizeSuffix##SizeSuffix##TypeSuffix; \
276 \
277typedef Array<Type, Size, 1> Array##SizeSuffix##TypeSuffix;
278
279#define EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, Size) \
280 \
281typedef Array<Type, Size, Dynamic> Array##Size##X##TypeSuffix; \
282 \
283typedef Array<Type, Dynamic, Size> Array##X##Size##TypeSuffix;
284
285#define EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(Type, TypeSuffix) \
286EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, 2, 2) \
287EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, 3, 3) \
288EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, 4, 4) \
289EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, Dynamic, X) \
290EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, 2) \
291EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, 3) \
292EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, 4)
293
294EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(int, i)
295EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(float, f)
296EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(double, d)
297EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(std::complex<float>, cf)
298EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(std::complex<double>, cd)
299
300#undef EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES
301#undef EIGEN_MAKE_ARRAY_TYPEDEFS
302
303#undef EIGEN_MAKE_ARRAY_TYPEDEFS_LARGE
304
305#define EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, SizeSuffix) \
306using Eigen::Matrix##SizeSuffix##TypeSuffix; \
307using Eigen::Vector##SizeSuffix##TypeSuffix; \
308using Eigen::RowVector##SizeSuffix##TypeSuffix;
309
310#define EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(TypeSuffix) \
311EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 2) \
312EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 3) \
313EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 4) \
314EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, X) \
315
316#define EIGEN_USING_ARRAY_TYPEDEFS \
317EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(i) \
318EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(f) \
319EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(d) \
320EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(cf) \
321EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(cd)
322
323} // end namespace Eigen
324
325#endif // EIGEN_ARRAY_H
General-purpose arrays with easy API for coefficient-wise operations.
Definition: Array.h:47
Array(const Scalar &val0, const Scalar &val1, const Scalar &val2, const Scalar &val3)
Definition: Array.h:218
Array(Index dim)
Array & operator=(const Scalar &value)
Definition: Array.h:90
Array(const Scalar *data)
Constructs a fixed-sized array initialized with coefficients starting at data.
Array(const Scalar &val0, const Scalar &val1)
Array(Index rows, Index cols)
Array(const Scalar &value)
Array & operator=(const DenseBase< OtherDerived > &other)
Definition: Array.h:107
Array & operator=(const EigenBase< OtherDerived > &other)
Definition: Array.h:76
Array(const Array &other)
Definition: Array.h:230
Array(const EigenBase< OtherDerived > &other)
Definition: Array.h:237
Array & operator=(const Array &other)
Definition: Array.h:116
Array()
Definition: Array.h:132
Array(const Scalar &val0, const Scalar &val1, const Scalar &val2)
Definition: Array.h:208
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:47
Dense storage base class for matrices and arrays.
Definition: PlainObjectBase.h:94
Scalar & coeffRef(Index rowId, Index colId)
Definition: PlainObjectBase.h:177
const Scalar & coeff(Index rowId, Index colId) const
Definition: PlainObjectBase.h:154
Derived & _set_noalias(const DenseBase< OtherDerived > &other)
Definition: PlainObjectBase.h:714
Derived & _set(const DenseBase< OtherDerived > &other)
Copies the value of the expression other into *this with automatic resizing.
Definition: PlainObjectBase.h:701
Derived & setConstant(Index size, const Scalar &val)
Definition: CwiseNullaryOp.h:341
Derived & operator=(const PlainObjectBase &other)
Definition: PlainObjectBase.h:451
Namespace containing all symbols from the Eigen library.
Definition: Core:287
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:33
const int Dynamic
Definition: Constants.h:21
Definition: EigenBase.h:29