General-purpose arrays with easy API for coefficient-wise operations. More...
Public Member Functions | |
Array () | |
Array (Index dim) | |
Array (Index rows, Index cols) | |
Array (const Scalar &x, const Scalar &y) | |
Array (const Scalar &x, const Scalar &y, const Scalar &z) | |
Array (const Scalar &x, const Scalar &y, const Scalar &z, const Scalar &w) | |
template<typename OtherDerived > | |
Array (const ArrayBase< OtherDerived > &other) | |
Array (const Array &other) | |
template<typename OtherDerived > | |
Array (const ReturnByValue< OtherDerived > &other) | |
template<typename OtherDerived > | |
Array (const EigenBase< OtherDerived > &other) | |
template<typename OtherDerived > | |
Array & | operator= (const EigenBase< OtherDerived > &other) |
template<typename OtherDerived > | |
Array & | operator= (const ArrayBase< OtherDerived > &other) |
Array & | operator= (const Array &other) |
template<typename OtherDerived > | |
void | swap (ArrayBase< OtherDerived > const &other) |
General-purpose arrays with easy API for coefficient-wise operations.
The Array class is very similar to the Matrix class. It provides general-purpose one- and two-dimensional arrays. The difference between the Array and the Matrix class is primarily in the API: the API for the Array class provides easy access to coefficient-wise operations, while the API for the Matrix class provides easy access to linear-algebra operations.
This class can be extended with the help of the plugin mechanism described on the page Customizing/Extending Eigen by defining the preprocessor symbol EIGEN_ARRAY_PLUGIN
.
Array | ( | ) | [inline, explicit] |
Default constructor.
For fixed-size matrices, does nothing.
For dynamic-size matrices, creates an empty matrix of size 0. Does not allocate any array. Such a matrix is called a null matrix. This constructor is the unique way to create null matrices: resizing a matrix to 0 is not supported.
Array | ( | Index | dim | ) | [inline, explicit] |
Constructs a vector or row-vector with given dimension. This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column.
Note that this is only useful for dynamic-size vectors. For fixed-size vectors, it is redundant to pass the dimension here, so it makes more sense to use the default constructor Matrix() instead.
Array | ( | Index | rows, |
Index | cols | ||
) |
constructs an uninitialized matrix with rows rows and cols columns.
This is useful for dynamic-size matrices. For fixed-size matrices, it is redundant to pass these parameters, so one should use the default constructor Matrix() instead.
Array | ( | const Scalar & | x, |
const Scalar & | y | ||
) |
constructs an initialized 2D vector with given coefficients
Array | ( | const Scalar & | x, |
const Scalar & | y, | ||
const Scalar & | z | ||
) | [inline] |
constructs an initialized 3D vector with given coefficients
Array | ( | const Scalar & | x, |
const Scalar & | y, | ||
const Scalar & | z, | ||
const Scalar & | w | ||
) | [inline] |
constructs an initialized 4D vector with given coefficients
Constructor copying the value of the expression other
Copy constructor
Array | ( | const ReturnByValue< OtherDerived > & | other | ) | [inline] |
Copy constructor with in-place evaluation
The usage of using Base::operator=; fails on MSVC. Since the code below is working with GCC and MSVC, we skipped the usage of 'using'. This should be done only for operator=.
Reimplemented from PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >.
Copies the value of the expression other into *this
with automatic resizing.
*this might be resized to match the dimensions of other. If *this was a null matrix (not already initialized), it will be initialized.
Note that copying a row-vector into a vector (and conversely) is allowed. The resizing, if any, is then done in the appropriate way so that row-vectors remain row-vectors and vectors remain vectors.
Array& operator= | ( | const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & | other | ) | [inline] |
This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.
Override MatrixBase::swap() since for dynamic-sized matrices of same type it is enough to swap the data pointers.