Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > Class Template Reference

General-purpose arrays with easy API for coefficient-wise operations. More...

#include <Array.h>

Inheritance diagram for Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >:

Public Types
enum	{ Options = _Options }
typedef PlainObjectBase< Array >	Base
typedef Base::PlainObject	PlainObject
Public Types inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
enum
enum
enum
typedef internal::dense_xpr_base< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::type	Base
typedef internal::traits< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::StorageKind	StorageKind
typedef internal::traits< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::Scalar	Scalar
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >	DenseType
typedef Eigen::Map< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Unaligned >	MapType
typedef const Eigen::Map< const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Unaligned >	ConstMapType
typedef Eigen::Map< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, AlignedMax >	AlignedMapType
typedef const Eigen::Map< const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, AlignedMax >	ConstAlignedMapType

Public Member Functions
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const EigenBase< OtherDerived > &other)
	The usage of using Base::operator=; fails on MSVC. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const Scalar &value)
	Set all the entries to value. More...
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const DenseBase< OtherDerived > &other)
	Copies the value of the expression other into *this with automatic resizing. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const Array &other)
	This is a special case of the templated operator=. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array ()
	Default constructor. More...
EIGEN_DEVICE_FUNC	Array (internal::constructor_without_unaligned_array_assert)
template<typename T >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const T &x)
template<typename T0 , typename T1 >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const T0 &val0, const T1 &val1)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const Scalar &val0, const Scalar &val1, const Scalar &val2)
	constructs an initialized 3D vector with given coefficients
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const Scalar &val0, const Scalar &val1, const Scalar &val2, const Scalar &val3)
	constructs an initialized 4D vector with given coefficients
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const Array &other)
	Copy constructor.
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC Index	innerStride () const
EIGEN_DEVICE_FUNC Index	outerStride () const
Public Member Functions inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
EIGEN_DEVICE_FUNC Base &	base ()
EIGEN_DEVICE_FUNC const Base &	base () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rows () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	cols () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeff (Index rowId, Index colId) const
	This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeff (Index index) const
	This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId)
	This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)
	This is an overloaded version of DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeffRef (Index rowId, Index colId) const
	This is the const version of coeffRef(Index,Index) which is thus synonym of coeff(Index,Index). More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar &	coeffRef (Index index) const
	This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). More...
EIGEN_STRONG_INLINE PacketScalar	packet (Index rowId, Index colId) const
EIGEN_STRONG_INLINE PacketScalar	packet (Index index) const
EIGEN_STRONG_INLINE void	writePacket (Index rowId, Index colId, const PacketScalar &val)
EIGEN_STRONG_INLINE void	writePacket (Index index, const PacketScalar &val)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Scalar *	data () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar *	data ()
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resize (Index rows, Index cols)
	Resizes *this to a rows x cols matrix. More...
EIGEN_DEVICE_FUNC void	resize (Index size)
	Resizes *this to a vector of length size. More...
EIGEN_DEVICE_FUNC void	resize (NoChange_t, Index cols)
	Resizes the matrix, changing only the number of columns. More...
EIGEN_DEVICE_FUNC void	resize (Index rows, NoChange_t)
	Resizes the matrix, changing only the number of rows. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resizeLike (const EigenBase< OtherDerived > &_other)
	Resizes *this to have the same dimensions as other. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, Index cols)
	Resizes the matrix to rows x cols while leaving old values untouched. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, NoChange_t)
	Resizes the matrix to rows x cols while leaving old values untouched. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (NoChange_t, Index cols)
	Resizes the matrix to rows x cols while leaving old values untouched. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index size)
	Resizes the vector to size while retaining old values. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResizeLike (const DenseBase< OtherDerived > &other)
	Resizes the matrix to rows x cols of other, while leaving old values untouched. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const PlainObjectBase &other)
	This is a special case of the templated operator=. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const ReturnByValue< OtherDerived > &func)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	lazyAssign (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index size, const Scalar &val)
	Resizes to the given size, and sets all coefficients in this expression to the given value val. More...
EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index rows, Index cols, const Scalar &val)
	Resizes to the given size, and sets all coefficients in this expression to the given value val. More...
EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index size)
	Resizes to the given size, and sets all coefficients in this expression to zero. More...
EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index rows, Index cols)
	Resizes to the given size, and sets all coefficients in this expression to zero. More...
EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index size)
	Resizes to the given newSize, and sets all coefficients in this expression to one. More...
EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index rows, Index cols)
	Resizes to the given size, and sets all coefficients in this expression to one. More...
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setRandom (Index size)
	Resizes to the given newSize, and sets all coefficients in this expression to random values. More...
Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setRandom (Index rows, Index cols)
	Resizes to the given size, and sets all coefficients in this expression to random values. More...
EIGEN_DEVICE_FUNC void	swap (DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC void	swap (DenseBase< OtherDerived > const &other)

Friends
template<typename Derived , typename OtherDerived , bool IsVector>
struct	internal::conservative_resize_like_impl
template<typename MatrixType , typename OtherDerived , bool SwapPointers>
struct	internal::matrix_swap_impl

Additional Inherited Members
Static Public Member Functions inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_check_template_params ()
static ConstMapType	Map (const Scalar *data)
static MapType	Map (Scalar *data)
static ConstMapType	Map (const Scalar *data, Index size)
static MapType	Map (Scalar *data, Index size)
static ConstMapType	Map (const Scalar *data, Index rows, Index cols)
static MapType	Map (Scalar *data, Index rows, Index cols)
static StridedConstMapType< Stride< Outer, Inner > >::type	Map (const Scalar *data, const Stride< Outer, Inner > &stride)
static StridedMapType< Stride< Outer, Inner > >::type	Map (Scalar *data, const Stride< Outer, Inner > &stride)
static StridedConstMapType< Stride< Outer, Inner > >::type	Map (const Scalar *data, Index size, const Stride< Outer, Inner > &stride)
static StridedMapType< Stride< Outer, Inner > >::type	Map (Scalar *data, Index size, const Stride< Outer, Inner > &stride)
static StridedConstMapType< Stride< Outer, Inner > >::type	Map (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)
static StridedMapType< Stride< Outer, Inner > >::type	Map (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)
static ConstAlignedMapType	MapAligned (const Scalar *data)
static AlignedMapType	MapAligned (Scalar *data)
static ConstAlignedMapType	MapAligned (const Scalar *data, Index size)
static AlignedMapType	MapAligned (Scalar *data, Index size)
static ConstAlignedMapType	MapAligned (const Scalar *data, Index rows, Index cols)
static AlignedMapType	MapAligned (Scalar *data, Index rows, Index cols)
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (const Scalar *data, const Stride< Outer, Inner > &stride)
static StridedAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (Scalar *data, const Stride< Outer, Inner > &stride)
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (const Scalar *data, Index size, const Stride< Outer, Inner > &stride)
static StridedAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (Scalar *data, Index size, const Stride< Outer, Inner > &stride)
static StridedConstAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (const Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)
static StridedAlignedMapType< Stride< Outer, Inner > >::type	MapAligned (Scalar *data, Index rows, Index cols, const Stride< Outer, Inner > &stride)
Protected Member Functions inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
EIGEN_DEVICE_FUNC	PlainObjectBase (internal::constructor_without_unaligned_array_assert)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const PlainObjectBase &other)
	Copy constructor.
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (Index size, Index rows, Index cols)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation.
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_resize_to_match (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	_set (const DenseBase< OtherDerived > &other)
	Copies the value of the expression other into *this with automatic resizing. More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	_set_noalias (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (Index rows, Index cols, typename internal::enable_if< Base::SizeAtCompileTime!=2, T0 >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (const T0 &val0, const T1 &val1, typename internal::enable_if< Base::SizeAtCompileTime==2, T0 >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init2 (const Index &val0, const Index &val1, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< T0, Index >::value) &&(internal::is_same< T1, Index >::value) &&Base::SizeAtCompileTime==2, T1 >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (Index size, typename internal::enable_if<(Base::SizeAtCompileTime!=1||!internal::is_convertible< T, Scalar >::value) &&((!internal::is_same< typename internal::traits< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::XprKind, ArrayXpr >::value||Base::SizeAtCompileTime==Dynamic)), T >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar &val0, typename internal::enable_if< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Index &val0, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T * >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar *data)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const ReturnByValue< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Scalar &val0, typename internal::enable_if< Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::XprKind, ArrayXpr >::value, T >::type *=0)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_init1 (const Index &val0, typename internal::enable_if<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime!=Dynamic &&Base::SizeAtCompileTime!=1 &&internal::is_convertible< T, Scalar >::value &&internal::is_same< typename internal::traits< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::XprKind, ArrayXpr >::value, T * >::type *=0)
Protected Attributes inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options >	m_storage

Detailed Description

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
class Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >

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.

See documentation of class Matrix for detailed information on the template parameters storage layout.

This class can be extended with the help of the plugin mechanism described on the page Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_ARRAY_PLUGIN.

See also

TutorialArrayClass, The class hierarchy

Constructor & Destructor Documentation

Array() [1/2]

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( )

inline

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.

See also

resize(Index,Index)

Array() [2/2]

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array ( const EigenBase< OtherDerived > &  other )

inline

See also

MatrixBase::operator=(const EigenBase<OtherDerived>&)

Member Function Documentation

operator=() [1/4]

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const EigenBase< OtherDerived > &  other )

inline

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=.

operator=() [2/4]

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const Scalar &  value )

inline

Set all the entries to value.

See also

DenseBase::setConstant(), DenseBase::fill()

operator=() [3/4]

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::operator= ( const DenseBase< OtherDerived > &  other )

inline

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.

operator=() [4/4]

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array& Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::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=.

---

The documentation for this class was generated from the following file:

• third-party-libs/eigen3/Eigen/src/Core/Array.h