Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
 
Loading...
Searching...
No Matches
Matrix.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2006-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
5// Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr>
6//
7// This Source Code Form is subject to the terms of the Mozilla
8// Public License v. 2.0. If a copy of the MPL was not distributed
9// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
11#ifndef EIGEN_MATRIX_H
12#define EIGEN_MATRIX_H
13
14namespace Eigen {
15
16namespace internal {
17template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
18struct traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
19{
20private:
21 enum { size = internal::size_at_compile_time<_Rows,_Cols>::ret };
22 typedef typename find_best_packet<_Scalar,size>::type PacketScalar;
23 enum {
24 row_major_bit = _Options&RowMajor ? RowMajorBit : 0,
25 is_dynamic_size_storage = _MaxRows==Dynamic || _MaxCols==Dynamic,
26 max_size = is_dynamic_size_storage ? Dynamic : _MaxRows*_MaxCols,
27 default_alignment = compute_default_alignment<_Scalar,max_size>::value,
28 actual_alignment = ((_Options&DontAlign)==0) ? default_alignment : 0,
29 required_alignment = unpacket_traits<PacketScalar>::alignment,
30 packet_access_bit = (packet_traits<_Scalar>::Vectorizable && (EIGEN_UNALIGNED_VECTORIZE || (actual_alignment>=required_alignment))) ? PacketAccessBit : 0
31 };
32
33public:
34 typedef _Scalar Scalar;
35 typedef Dense StorageKind;
36 typedef Eigen::Index StorageIndex;
37 typedef MatrixXpr XprKind;
38 enum {
39 RowsAtCompileTime = _Rows,
40 ColsAtCompileTime = _Cols,
41 MaxRowsAtCompileTime = _MaxRows,
42 MaxColsAtCompileTime = _MaxCols,
43 Flags = compute_matrix_flags<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::ret,
44 Options = _Options,
45 InnerStrideAtCompileTime = 1,
46 OuterStrideAtCompileTime = (Options&RowMajor) ? ColsAtCompileTime : RowsAtCompileTime,
47
48 // FIXME, the following flag in only used to define NeedsToAlign in PlainObjectBase
49 EvaluatorFlags = LinearAccessBit | DirectAccessBit | packet_access_bit | row_major_bit,
50 Alignment = actual_alignment
51 };
52};
53}
54
177template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
179 : public PlainObjectBase<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
180{
181 public:
182
187
188 enum { Options = _Options };
189
190 EIGEN_DENSE_PUBLIC_INTERFACE(Matrix)
191
192 typedef typename Base::PlainObject PlainObject;
193
194 using Base::base;
195 using Base::coeffRef;
196
205 EIGEN_DEVICE_FUNC
206 EIGEN_STRONG_INLINE Matrix& operator=(const Matrix& other)
207 {
208 return Base::_set(other);
209 }
210
221 template<typename OtherDerived>
222 EIGEN_DEVICE_FUNC
223 EIGEN_STRONG_INLINE Matrix& operator=(const DenseBase<OtherDerived>& other)
224 {
225 return Base::_set(other);
226 }
227
228 /* Here, doxygen failed to copy the brief information when using \copydoc */
229
234 template<typename OtherDerived>
235 EIGEN_DEVICE_FUNC
236 EIGEN_STRONG_INLINE Matrix& operator=(const EigenBase<OtherDerived> &other)
237 {
238 return Base::operator=(other);
239 }
240
241 template<typename OtherDerived>
242 EIGEN_DEVICE_FUNC
243 EIGEN_STRONG_INLINE Matrix& operator=(const ReturnByValue<OtherDerived>& func)
244 {
245 return Base::operator=(func);
246 }
247
258 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
260 {
261 Base::_check_template_params();
262 EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED
263 }
264
265 // FIXME is it still needed
266 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
267 explicit Matrix(internal::constructor_without_unaligned_array_assert)
268 : Base(internal::constructor_without_unaligned_array_assert())
269 { Base::_check_template_params(); EIGEN_INITIALIZE_COEFFS_IF_THAT_OPTION_IS_ENABLED }
270
271#if EIGEN_HAS_RVALUE_REFERENCES
272 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
273 Matrix(Matrix&& other) EIGEN_NOEXCEPT_IF(std::is_nothrow_move_constructible<Scalar>::value)
274 : Base(std::move(other))
275 {
276 Base::_check_template_params();
277 }
278 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
279 Matrix& operator=(Matrix&& other) EIGEN_NOEXCEPT_IF(std::is_nothrow_move_assignable<Scalar>::value)
280 {
281 Base::operator=(std::move(other));
282 return *this;
283 }
284#endif
285
286#if EIGEN_HAS_CXX11
294 template <typename... ArgTypes>
295 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
296 Matrix(const Scalar& a0, const Scalar& a1, const Scalar& a2, const Scalar& a3, const ArgTypes&... args)
297 : Base(a0, a1, a2, a3, args...) {}
298
320 EIGEN_DEVICE_FUNC
321 explicit EIGEN_STRONG_INLINE Matrix(const std::initializer_list<std::initializer_list<Scalar>>& list) : Base(list) {}
322#endif // end EIGEN_HAS_CXX11
323
324#ifndef EIGEN_PARSED_BY_DOXYGEN
325
326 // This constructor is for both 1x1 matrices and dynamic vectors
327 template<typename T>
328 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
329 explicit Matrix(const T& x)
330 {
331 Base::_check_template_params();
332 Base::template _init1<T>(x);
333 }
334
335 template<typename T0, typename T1>
336 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
337 Matrix(const T0& x, const T1& y)
338 {
339 Base::_check_template_params();
340 Base::template _init2<T0,T1>(x, y);
341 }
342
343
344#else
346 EIGEN_DEVICE_FUNC
347 explicit Matrix(const Scalar *data);
348
361 EIGEN_STRONG_INLINE explicit Matrix(Index dim);
364 Matrix(const Scalar& x);
377 EIGEN_DEVICE_FUNC
378 Matrix(Index rows, Index cols);
379
382 Matrix(const Scalar& x, const Scalar& y);
383 #endif // end EIGEN_PARSED_BY_DOXYGEN
384
388 EIGEN_DEVICE_FUNC
389 EIGEN_STRONG_INLINE Matrix(const Scalar& x, const Scalar& y, const Scalar& z)
390 {
391 Base::_check_template_params();
392 EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Matrix, 3)
393 m_storage.data()[0] = x;
394 m_storage.data()[1] = y;
395 m_storage.data()[2] = z;
396 }
400 EIGEN_DEVICE_FUNC
401 EIGEN_STRONG_INLINE Matrix(const Scalar& x, const Scalar& y, const Scalar& z, const Scalar& w)
402 {
403 Base::_check_template_params();
404 EIGEN_STATIC_ASSERT_VECTOR_SPECIFIC_SIZE(Matrix, 4)
405 m_storage.data()[0] = x;
406 m_storage.data()[1] = y;
407 m_storage.data()[2] = z;
408 m_storage.data()[3] = w;
409 }
410
411
413 EIGEN_DEVICE_FUNC
414 EIGEN_STRONG_INLINE Matrix(const Matrix& other) : Base(other)
415 { }
416
420 template<typename OtherDerived>
421 EIGEN_DEVICE_FUNC
422 EIGEN_STRONG_INLINE Matrix(const EigenBase<OtherDerived> &other)
423 : Base(other.derived())
424 { }
425
426 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
427 inline Index innerStride() const EIGEN_NOEXCEPT { return 1; }
428 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
429 inline Index outerStride() const EIGEN_NOEXCEPT { return this->innerSize(); }
430
432
433 template<typename OtherDerived>
434 EIGEN_DEVICE_FUNC
435 explicit Matrix(const RotationBase<OtherDerived,ColsAtCompileTime>& r);
436 template<typename OtherDerived>
437 EIGEN_DEVICE_FUNC
438 Matrix& operator=(const RotationBase<OtherDerived,ColsAtCompileTime>& r);
439
440 // allow to extend Matrix outside Eigen
441 #ifdef EIGEN_MATRIX_PLUGIN
442 #include EIGEN_MATRIX_PLUGIN
443 #endif
444
445 protected:
446 template <typename Derived, typename OtherDerived, bool IsVector>
447 friend struct internal::conservative_resize_like_impl;
448
449 using Base::m_storage;
450};
451
481#define EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, Size, SizeSuffix) \
482 \
483typedef Matrix<Type, Size, Size> Matrix##SizeSuffix##TypeSuffix; \
484 \
485typedef Matrix<Type, Size, 1> Vector##SizeSuffix##TypeSuffix; \
486 \
487typedef Matrix<Type, 1, Size> RowVector##SizeSuffix##TypeSuffix;
488
489#define EIGEN_MAKE_FIXED_TYPEDEFS(Type, TypeSuffix, Size) \
490 \
491typedef Matrix<Type, Size, Dynamic> Matrix##Size##X##TypeSuffix; \
492 \
493typedef Matrix<Type, Dynamic, Size> Matrix##X##Size##TypeSuffix;
494
495#define EIGEN_MAKE_TYPEDEFS_ALL_SIZES(Type, TypeSuffix) \
496EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, 2, 2) \
497EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, 3, 3) \
498EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, 4, 4) \
499EIGEN_MAKE_TYPEDEFS(Type, TypeSuffix, Dynamic, X) \
500EIGEN_MAKE_FIXED_TYPEDEFS(Type, TypeSuffix, 2) \
501EIGEN_MAKE_FIXED_TYPEDEFS(Type, TypeSuffix, 3) \
502EIGEN_MAKE_FIXED_TYPEDEFS(Type, TypeSuffix, 4)
503
504EIGEN_MAKE_TYPEDEFS_ALL_SIZES(int, i)
505EIGEN_MAKE_TYPEDEFS_ALL_SIZES(float, f)
506EIGEN_MAKE_TYPEDEFS_ALL_SIZES(double, d)
507EIGEN_MAKE_TYPEDEFS_ALL_SIZES(std::complex<float>, cf)
508EIGEN_MAKE_TYPEDEFS_ALL_SIZES(std::complex<double>, cd)
509
510#undef EIGEN_MAKE_TYPEDEFS_ALL_SIZES
511#undef EIGEN_MAKE_TYPEDEFS
512#undef EIGEN_MAKE_FIXED_TYPEDEFS
513
514#if EIGEN_HAS_CXX11
515
516#define EIGEN_MAKE_TYPEDEFS(Size, SizeSuffix) \
517 \
518 \
519template <typename Type> \
520using Matrix##SizeSuffix = Matrix<Type, Size, Size>; \
521 \
522 \
523template <typename Type> \
524using Vector##SizeSuffix = Matrix<Type, Size, 1>; \
525 \
526 \
527template <typename Type> \
528using RowVector##SizeSuffix = Matrix<Type, 1, Size>;
529
530#define EIGEN_MAKE_FIXED_TYPEDEFS(Size) \
531 \
532 \
533template <typename Type> \
534using Matrix##Size##X = Matrix<Type, Size, Dynamic>; \
535 \
536 \
537template <typename Type> \
538using Matrix##X##Size = Matrix<Type, Dynamic, Size>;
539
540EIGEN_MAKE_TYPEDEFS(2, 2)
541EIGEN_MAKE_TYPEDEFS(3, 3)
542EIGEN_MAKE_TYPEDEFS(4, 4)
543EIGEN_MAKE_TYPEDEFS(Dynamic, X)
544EIGEN_MAKE_FIXED_TYPEDEFS(2)
545EIGEN_MAKE_FIXED_TYPEDEFS(3)
546EIGEN_MAKE_FIXED_TYPEDEFS(4)
547
550template <typename Type, int Size>
551using Vector = Matrix<Type, Size, 1>;
552
555template <typename Type, int Size>
556using RowVector = Matrix<Type, 1, Size>;
557
558#undef EIGEN_MAKE_TYPEDEFS
559#undef EIGEN_MAKE_FIXED_TYPEDEFS
560
561#endif // EIGEN_HAS_CXX11
562
563} // end namespace Eigen
564
565#endif // EIGEN_MATRIX_H
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:47
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:180
Matrix(const Scalar &x, const Scalar &y, const Scalar &z, const Scalar &w)
Constructs an initialized 4D vector with given coefficients.
Definition: Matrix.h:401
Matrix(Index dim)
Constructs a vector or row-vector with given dimension. This is only for vectors (either row-vectors ...
Matrix(const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)
Definition: Matrix.h:296
Matrix & operator=(const Matrix &other)
Assigns matrices to each other.
Definition: Matrix.h:206
Matrix(const Scalar &x, const Scalar &y)
Constructs an initialized 2D vector with given coefficients.
Matrix(const Scalar &x, const Scalar &y, const Scalar &z)
Constructs an initialized 3D vector with given coefficients.
Definition: Matrix.h:389
Matrix(const Matrix &other)
Copy constructor.
Definition: Matrix.h:414
Matrix(const std::initializer_list< std::initializer_list< Scalar > > &list)
Constructs a Matrix and initializes it from the coefficients given as initializer-lists grouped by ro...
Definition: Matrix.h:321
Matrix()
Default constructor.
Definition: Matrix.h:259
Matrix(const Scalar &x)
Constructs an initialized 1x1 matrix with the given coefficient.
PlainObjectBase< Matrix > Base
Base class typedef.
Definition: Matrix.h:186
Matrix(const EigenBase< OtherDerived > &other)
Copy constructor for generic expressions.
Definition: Matrix.h:422
Matrix(const Scalar *data)
Constructs a fixed-sized matrix initialized with coefficients starting at data.
Matrix & operator=(const EigenBase< OtherDerived > &other)
Copies the generic expression other into *this.
Definition: Matrix.h:236
Matrix(Index rows, Index cols)
Constructs an uninitialized matrix with rows rows and cols columns.
Dense storage base class for matrices and arrays.
Definition: PlainObjectBase.h:100
Scalar & coeffRef(Index rowId, Index colId)
Definition: PlainObjectBase.h:175
Derived & _set(const DenseBase< OtherDerived > &other)
Copies the value of the expression other into *this with automatic resizing.
Definition: PlainObjectBase.h:777
Derived & operator=(const PlainObjectBase &other)
Definition: PlainObjectBase.h:449
@ DontAlign
Definition: Constants.h:325
@ RowMajor
Definition: Constants.h:321
const unsigned int RowMajorBit
Definition: Constants.h:66
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