Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more
ArrayBase< Derived > Class Template Reference
[Core module]
Base class for all 1D and 2D array, and related expressions. More...
#include <ArrayBase.h>
Inherits DenseBase< Derived >.
Public Types | |
typedef ArrayBase | StorageBaseType |
The base class for a given storage type. | |
Public Member Functions | |
Derived & | operator= (const ArrayBase &other) |
Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1) | |
template<typename OtherDerived > | |
Derived & | operator+= (const ArrayBase< OtherDerived > &other) |
replaces *this by *this + other. | |
template<typename OtherDerived > | |
Derived & | operator-= (const ArrayBase< OtherDerived > &other) |
replaces *this by *this - other. | |
template<typename OtherDerived > | |
Derived & | operator*= (const ArrayBase< OtherDerived > &other) |
replaces *this by *this * other coefficient wise. | |
template<typename OtherDerived > | |
Derived & | operator/= (const ArrayBase< OtherDerived > &other) |
replaces *this by *this / other coefficient wise. | |
MatrixWrapper< Derived > | matrix () |
Detailed Description
template<typename Derived>
class Eigen::ArrayBase< Derived >
Base class for all 1D and 2D array, and related expressions.
An array is similar to a dense vector or matrix. While matrices are mathematical objects with well defined linear algebra operators, an array is just a collection of scalar values arranged in a one or two dimensionnal fashion. As the main consequence, all operations applied to an array are performed coefficient wise. Furthermore, arrays support scalar math functions of the c++ standard library (e.g., std::sin(x)), and convenient constructors allowing to easily write generic code working for both scalar values and arrays.
This class is the base that is inherited by all array expression types.
- Template Parameters:
-
Derived is the derived type, e.g., an array or an expression type.
This class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN
.
- See also:
- class MatrixBase, TopicClassHierarchy
Definition at line 39 of file ArrayBase.h.
Member Typedef Documentation
typedef ArrayBase StorageBaseType |
The base class for a given storage type.
Definition at line 45 of file ArrayBase.h.
Member Function Documentation
MatrixWrapper<Derived> matrix | ( | ) |
- Returns:
- an Matrix expression of this array
- See also:
- MatrixBase::array()
Definition at line 146 of file ArrayBase.h.
EIGEN_STRONG_INLINE Derived & operator*= | ( | const ArrayBase< OtherDerived > & | other ) |
replaces *this
by *this
* other coefficient wise.
- Returns:
- a reference to
*this
Definition at line 203 of file ArrayBase.h.
EIGEN_STRONG_INLINE Derived & operator+= | ( | const ArrayBase< OtherDerived > & | other ) |
replaces *this
by *this
+ other.
- Returns:
- a reference to
*this
Definition at line 189 of file ArrayBase.h.
EIGEN_STRONG_INLINE Derived & operator-= | ( | const ArrayBase< OtherDerived > & | other ) |
replaces *this
by *this
- other.
- Returns:
- a reference to
*this
Definition at line 175 of file ArrayBase.h.
EIGEN_STRONG_INLINE Derived & operator/= | ( | const ArrayBase< OtherDerived > & | other ) |
replaces *this
by *this
/ other coefficient wise.
- Returns:
- a reference to
*this
Definition at line 217 of file ArrayBase.h.
Derived& operator= | ( | const ArrayBase< Derived > & | other ) |
Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1)
Definition at line 119 of file ArrayBase.h.
Generated on Tue Jul 12 2022 17:47:03 by
