Eigen  3.4.0 (git rev e3e74001f7c4bf95f0dde572e8a08c5b2918a3ab)
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 
13 namespace Eigen {
14 
15 namespace internal {
16 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
17 struct 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 
44 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
45 class 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  {
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  }
157  EIGEN_DEVICE_FUNC
158  Array& operator=(Array&& other) EIGEN_NOEXCEPT_IF(std::is_nothrow_move_assignable<Scalar>::value)
159  {
160  Base::operator=(std::move(other));
161  return *this;
162  }
163 #endif
164 
165  #if EIGEN_HAS_CXX11
174  template <typename... ArgTypes>
175  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
176  Array(const Scalar& a0, const Scalar& a1, const Scalar& a2, const Scalar& a3, const ArgTypes&... args)
177  : Base(a0, a1, a2, a3, args...) {}
178 
200  EIGEN_DEVICE_FUNC
201  EIGEN_STRONG_INLINE Array(const std::initializer_list<std::initializer_list<Scalar>>& list) : Base(list) {}
202  #endif // end EIGEN_HAS_CXX11
203 
204  #ifndef EIGEN_PARSED_BY_DOXYGEN
205  template<typename T>
206  EIGEN_DEVICE_FUNC
207  EIGEN_STRONG_INLINE explicit Array(const T& x)
208  {
209  Base::_check_template_params();
210  Base::template _init1<T>(x);
211  }
212 
213  template<typename T0, typename T1>
214  EIGEN_DEVICE_FUNC
215  EIGEN_STRONG_INLINE Array(const T0& val0, const T1& val1)
216  {
217  Base::_check_template_params();
218  this->template _init2<T0,T1>(val0, val1);
219  }
220 
221  #else
223  EIGEN_DEVICE_FUNC explicit Array(const Scalar *data);
230  EIGEN_DEVICE_FUNC
231  EIGEN_STRONG_INLINE explicit Array(Index dim);
234  Array(const Scalar& value);
240  Array(Index rows, Index cols);
243  Array(const Scalar& val0, const Scalar& val1);
244  #endif // end EIGEN_PARSED_BY_DOXYGEN
245 
249  EIGEN_DEVICE_FUNC
250  EIGEN_STRONG_INLINE Array(const Scalar& val0, const Scalar& val1, const Scalar& val2)
251  {
252  Base::_check_template_params();
253  EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Array, 3)
254  m_storage.data()[0] = val0;
255  m_storage.data()[1] = val1;
256  m_storage.data()[2] = val2;
257  }
261  EIGEN_DEVICE_FUNC
262  EIGEN_STRONG_INLINE Array(const Scalar& val0, const Scalar& val1, const Scalar& val2, const Scalar& val3)
263  {
264  Base::_check_template_params();
265  EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Array, 4)
266  m_storage.data()[0] = val0;
267  m_storage.data()[1] = val1;
268  m_storage.data()[2] = val2;
269  m_storage.data()[3] = val3;
270  }
271 
273  EIGEN_DEVICE_FUNC
274  EIGEN_STRONG_INLINE Array(const Array& other)
275  : Base(other)
276  { }
277 
278  private:
279  struct PrivateType {};
280  public:
281 
283  template<typename OtherDerived>
284  EIGEN_DEVICE_FUNC
285  EIGEN_STRONG_INLINE Array(const EigenBase<OtherDerived> &other,
286  typename internal::enable_if<internal::is_convertible<typename OtherDerived::Scalar,Scalar>::value,
287  PrivateType>::type = PrivateType())
288  : Base(other.derived())
289  { }
290 
291  EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
292  inline Index innerStride() const EIGEN_NOEXCEPT{ return 1; }
293  EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
294  inline Index outerStride() const EIGEN_NOEXCEPT { return this->innerSize(); }
295 
296  #ifdef EIGEN_ARRAY_PLUGIN
297  #include EIGEN_ARRAY_PLUGIN
298  #endif
299 
300  private:
301 
302  template<typename MatrixType, typename OtherDerived, bool SwapPointers>
303  friend struct internal::matrix_swap_impl;
304 };
305 
331 #define EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, Size, SizeSuffix) \
332  \
333 typedef Array<Type, Size, Size> Array##SizeSuffix##SizeSuffix##TypeSuffix; \
334  \
335 typedef Array<Type, Size, 1> Array##SizeSuffix##TypeSuffix;
336 
337 #define EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, Size) \
338  \
339 typedef Array<Type, Size, Dynamic> Array##Size##X##TypeSuffix; \
340  \
341 typedef Array<Type, Dynamic, Size> Array##X##Size##TypeSuffix;
342 
343 #define EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(Type, TypeSuffix) \
344 EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, 2, 2) \
345 EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, 3, 3) \
346 EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, 4, 4) \
347 EIGEN_MAKE_ARRAY_TYPEDEFS(Type, TypeSuffix, Dynamic, X) \
348 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, 2) \
349 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, 3) \
350 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Type, TypeSuffix, 4)
351 
352 EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(int, i)
353 EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(float, f)
354 EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(double, d)
355 EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(std::complex<float>, cf)
356 EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES(std::complex<double>, cd)
357 
358 #undef EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES
359 #undef EIGEN_MAKE_ARRAY_TYPEDEFS
360 #undef EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS
361 
362 #if EIGEN_HAS_CXX11
363 
364 #define EIGEN_MAKE_ARRAY_TYPEDEFS(Size, SizeSuffix) \
365  \
366  \
367 template <typename Type> \
368 using Array##SizeSuffix##SizeSuffix = Array<Type, Size, Size>; \
369  \
370  \
371 template <typename Type> \
372 using Array##SizeSuffix = Array<Type, Size, 1>;
373 
374 #define EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(Size) \
375  \
376  \
377 template <typename Type> \
378 using Array##Size##X = Array<Type, Size, Dynamic>; \
379  \
380  \
381 template <typename Type> \
382 using Array##X##Size = Array<Type, Dynamic, Size>;
383 
384 EIGEN_MAKE_ARRAY_TYPEDEFS(2, 2)
385 EIGEN_MAKE_ARRAY_TYPEDEFS(3, 3)
386 EIGEN_MAKE_ARRAY_TYPEDEFS(4, 4)
387 EIGEN_MAKE_ARRAY_TYPEDEFS(Dynamic, X)
388 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(2)
389 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(3)
390 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS(4)
391 
392 #undef EIGEN_MAKE_ARRAY_TYPEDEFS
393 #undef EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS
394 
395 #endif // EIGEN_HAS_CXX11
396 
397 #define EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, SizeSuffix) \
398 using Eigen::Matrix##SizeSuffix##TypeSuffix; \
399 using Eigen::Vector##SizeSuffix##TypeSuffix; \
400 using Eigen::RowVector##SizeSuffix##TypeSuffix;
401 
402 #define EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(TypeSuffix) \
403 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 2) \
404 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 3) \
405 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, 4) \
406 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE_AND_SIZE(TypeSuffix, X) \
407 
408 #define EIGEN_USING_ARRAY_TYPEDEFS \
409 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(i) \
410 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(f) \
411 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(d) \
412 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(cf) \
413 EIGEN_USING_ARRAY_TYPEDEFS_FOR_TYPE(cd)
414 
415 } // end namespace Eigen
416 
417 #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:262
Array(Index dim)
Array(const EigenBase< OtherDerived > &other, typename internal::enable_if< internal::is_convertible< typename OtherDerived::Scalar, Scalar >::value, PrivateType >::type=PrivateType())
Definition: Array.h:285
Array(const Scalar *data)
Constructs a fixed-sized array initialized with coefficients starting at data.
Array(const Scalar &val0, const Scalar &val1)
Array(const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)
Definition: Array.h:176
Array(Index rows, Index cols)
Array & operator=(const DenseBase< OtherDerived > &other)
Definition: Array.h:107
Array(const Scalar &value)
Array & operator=(const EigenBase< OtherDerived > &other)
Definition: Array.h:76
Array & operator=(const Array &other)
Definition: Array.h:116
Array(const Array &other)
Definition: Array.h:274
Array(const std::initializer_list< std::initializer_list< Scalar >> &list)
Constructs an array and initializes it from the coefficients given as initializer-lists grouped by ro...
Definition: Array.h:201
Array & operator=(const Scalar &value)
Definition: Array.h:90
Array()
Definition: Array.h:132
Array(const Scalar &val0, const Scalar &val1, const Scalar &val2)
Definition: Array.h:250
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:47
EIGEN_CONSTEXPR Index innerSize() const
Definition: DenseBase.h:235
internal::traits< Derived >::Scalar Scalar
Definition: DenseBase.h:66
CoeffReturnType value() const
Definition: DenseBase.h:526
Derived & derived()
Definition: EigenBase.h:46
Scalar & x()
Definition: DenseCoeffsBase.h:435
Dense storage base class for matrices and arrays.
Definition: PlainObjectBase.h:100
Derived & _set(const DenseBase< OtherDerived > &other)
Copies the value of the expression other into *this with automatic resizing.
Definition: PlainObjectBase.h:777
const Scalar & coeff(Index rowId, Index colId) const
Definition: PlainObjectBase.h:152
Scalar & coeffRef(Index rowId, Index colId)
Definition: PlainObjectBase.h:175
Derived & setConstant(Index size, const Scalar &val)
Definition: CwiseNullaryOp.h:361
Derived & operator=(const PlainObjectBase &other)
Definition: PlainObjectBase.h:449
Namespace containing all symbols from the Eigen library.
Definition: Core:141
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
const int Dynamic
Definition: Constants.h:22
Definition: EigenBase.h:30
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:39