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 >:

Classes
struct	PrivateType

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

typedef Eigen::Map< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, AlignedMax >	AlignedMapType

typedef internal::dense_xpr_base< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::type	Base

typedef Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >	DenseType

typedef Eigen::Map< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Unaligned >	MapType

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef NumTraits< Scalar >::Real	RealScalar

typedef internal::traits< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::Scalar	Scalar

typedef internal::traits< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::StorageKind	StorageKind

enum

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array ()

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const Array &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const EigenBase< OtherDerived > &other, typename internal::enable_if< internal::is_convertible< typename OtherDerived::Scalar, Scalar >::value, PrivateType >::type=PrivateType())

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const Scalar &val0, const Scalar &val1, const Scalar &val2)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	Array (const Scalar &val0, const Scalar &val1, const Scalar &val2, const Scalar &val3)

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	Array (internal::constructor_without_unaligned_array_assert)

EIGEN_DEVICE_FUNC Base &	base ()

const EIGEN_DEVICE_FUNC Base &	base () const

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeff (Index index) const

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeff (Index rowId, Index colId) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId)

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	innerStride () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const Array &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const DenseBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const EigenBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array &	operator= (const Scalar &value)

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outerStride () const EIGEN_NOEXCEPT

Public Member Functions inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
EIGEN_DEVICE_FUNC Base &	base ()

const EIGEN_DEVICE_FUNC Base &	base () const

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeff (Index index) const

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeff (Index rowId, Index colId) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId)

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar &	coeffRef (Index rowId, Index colId) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, Index cols)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index rows, NoChange_t)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (Index size)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResize (NoChange_t, Index cols)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	conservativeResizeLike (const DenseBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar *	data ()

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar *	data () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	lazyAssign (const DenseBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const PlainObjectBase &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	operator= (const ReturnByValue< OtherDerived > &func)

EIGEN_STRONG_INLINE PacketScalar	packet (Index index) const

EIGEN_STRONG_INLINE PacketScalar	packet (Index rowId, Index colId) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resize (Index rows, Index cols)

EIGEN_DEVICE_FUNC void	resize (Index rows, NoChange_t)

EIGEN_DEVICE_FUNC void	resize (Index size)

EIGEN_DEVICE_FUNC void	resize (NoChange_t, Index cols)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	resizeLike (const EigenBase< OtherDerived > &_other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_STRONG_INLINE void	writePacket (Index index, const PacketScalar &val)

EIGEN_STRONG_INLINE void	writePacket (Index rowId, Index colId, const PacketScalar &val)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index size, const Scalar &val)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index rows, Index cols, const Scalar &val)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (NoChange_t, Index cols, const Scalar &val)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setConstant (Index rows, NoChange_t, const Scalar &val)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index size)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index rows, Index cols)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (NoChange_t, Index cols)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setZero (Index rows, NoChange_t)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index size)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index rows, Index cols)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (NoChange_t, Index cols)

EIGEN_DEVICE_FUNC Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setOnes (Index rows, NoChange_t)

Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setRandom (Index size)

Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setRandom (Index rows, Index cols)

Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setRandom (NoChange_t, Index cols)

Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &	setRandom (Index rows, NoChange_t)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	swap (DenseBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	swap (DenseBase< OtherDerived > const &other)

Protected Attributes
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options >	m_storage

Protected Attributes inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
DenseStorage< Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options >	m_storage

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 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)

static EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	_check_template_params ()

Public Attributes inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
const typedef Eigen::Map< const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, AlignedMax >	ConstAlignedMapType

const typedef Eigen::Map< const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >, Unaligned >	ConstMapType

Protected Member Functions inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase ()

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 PlainObjectBase &other)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (const ReturnByValue< OtherDerived > &other)
	Copy constructor with in-place evaluation. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	PlainObjectBase (Index size, Index rows, Index cols)

EIGEN_DEVICE_FUNC	PlainObjectBase (internal::constructor_without_unaligned_array_assert)

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 Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > &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)

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: \blank TutorialArrayClass, The class hierarchy

Definition at line 45 of file Array.h.

Member Typedef Documentation

◆ Base

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

typedef PlainObjectBase<Array> Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Base

Definition at line 50 of file Array.h.

◆ PlainObject

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

typedef Base::PlainObject Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::PlainObject

Definition at line 54 of file Array.h.

Member Enumeration Documentation

◆ anonymous enum

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

anonymous enum

Enumerator
Options

Definition at line 53 of file Array.h.

Constructor & Destructor Documentation

◆ Array() [1/8]

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)

Definition at line 132 of file Array.h.

◆ Array() [2/8]

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

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

inline

Definition at line 142 of file Array.h.

◆ Array() [3/8]

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

template<typename T >

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

inlineexplicit

Definition at line 207 of file Array.h.

◆ Array() [4/8]

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

template<typename T0 , typename T1 >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array	(	const T0 &	val0,
		const T1 &	val1
	)

inline

Definition at line 215 of file Array.h.

◆ Array() [5/8]

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	(	const Scalar &	val0,
		const Scalar &	val1,
		const Scalar &	val2
	)

inline

constructs an initialized 3D vector with given coefficients

See also: Array(const Scalar& a0, const Scalar& a1, const Scalar& a2, const Scalar& a3, const ArgTypes&... args)

Definition at line 250 of file Array.h.

◆ Array() [6/8]

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	(	const Scalar &	val0,
		const Scalar &	val1,
		const Scalar &	val2,
		const Scalar &	val3
	)

inline

constructs an initialized 4D vector with given coefficients

See also: Array(const Scalar& a0, const Scalar& a1, const Scalar& a2, const Scalar& a3, const ArgTypes&... args)

Definition at line 262 of file Array.h.

◆ Array() [7/8]

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 ( const Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > & other )

inline

Copy constructor

Definition at line 274 of file Array.h.

◆ Array() [8/8]

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,
		typename internal::enable_if< internal::is_convertible< typename OtherDerived::Scalar, Scalar >::value, PrivateType >::type	= `PrivateType()`
	)

inline

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

Definition at line 285 of file Array.h.

Member Function Documentation

◆ base() [1/2]

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

EIGEN_DEVICE_FUNC Base& Eigen::PlainObjectBase< Derived >::base

inline

Definition at line 138 of file PlainObjectBase.h.

◆ base() [2/2]

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

const EIGEN_DEVICE_FUNC Base& Eigen::PlainObjectBase< Derived >::base

inline

Definition at line 140 of file PlainObjectBase.h.

◆ coeff() [1/2]

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

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeff

inline

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.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details.

Definition at line 165 of file PlainObjectBase.h.

◆ coeff() [2/2]

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

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeff

inline

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.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details.

Definition at line 152 of file PlainObjectBase.h.

◆ coeffRef() [1/4]

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

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

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.

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index) const for details.

Definition at line 188 of file PlainObjectBase.h.

◆ coeffRef() [2/4]

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

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). It is provided for convenience.

Definition at line 207 of file PlainObjectBase.h.

◆ coeffRef() [3/4]

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

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

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.

See DenseCoeffsBase<Derived,WriteAccessors>::coeffRef(Index,Index) const for details.

Definition at line 175 of file PlainObjectBase.h.

◆ coeffRef() [4/4]

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

EIGEN_DEVICE_FUNC const EIGEN_STRONG_INLINE Scalar& Eigen::PlainObjectBase< Derived >::coeffRef

inline

This is the const version of coeffRef(Index,Index) which is thus synonym of coeff(Index,Index). It is provided for convenience.

Definition at line 196 of file PlainObjectBase.h.

◆ innerStride()

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

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::innerStride ( ) const

inline

Definition at line 292 of file Array.h.

◆ operator=() [1/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=.

Definition at line 116 of file Array.h.

◆ operator=() [2/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.

Definition at line 107 of file Array.h.

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

Definition at line 76 of file Array.h.

◆ 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 Scalar & value )

inline

Set all the entries to value.

See also: DenseBase::setConstant(), DenseBase::fill()

Definition at line 90 of file Array.h.

◆ outerStride()

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

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::outerStride ( ) const

inline

Definition at line 294 of file Array.h.

Friends And Related Function Documentation

◆ internal::conservative_resize_like_impl

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

template<typename Derived , typename OtherDerived , bool IsVector>

friend struct internal::conservative_resize_like_impl

friend

Definition at line 58 of file Array.h.

◆ internal::matrix_swap_impl

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

template<typename MatrixType , typename OtherDerived , bool SwapPointers>

friend struct internal::matrix_swap_impl

friend

Definition at line 303 of file Array.h.

Member Data Documentation

◆ m_storage

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

DenseStorage<Scalar, Base::MaxSizeAtCompileTime, Base::RowsAtCompileTime, Base::ColsAtCompileTime, Options> Eigen::PlainObjectBase< Derived >::m_storage

protected

Definition at line 131 of file PlainObjectBase.h.

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

Array.h

Classes

Public Types

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ PlainObject

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Array() [1/8]

◆ Array() [2/8]

◆ Array() [3/8]

◆ Array() [4/8]

◆ Array() [5/8]

◆ Array() [6/8]

◆ Array() [7/8]

◆ Array() [8/8]

Member Function Documentation

◆ base() [1/2]

◆ base() [2/2]

◆ coeff() [1/2]

◆ coeff() [2/2]

◆ coeffRef() [1/4]

◆ coeffRef() [2/4]

◆ coeffRef() [3/4]

◆ coeffRef() [4/4]

◆ innerStride()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ outerStride()

Friends And Related Function Documentation

◆ internal::conservative_resize_like_impl

◆ internal::matrix_swap_impl

Member Data Documentation

◆ m_storage

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