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: The Array class and coefficient-wise operations, The class hierarchy

Inheritance diagram for Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >:

Public Member Functions
	Array ()

	Array (const Array &other)

template<typename OtherDerived >
	Array (const EigenBase< OtherDerived > &other, std::enable_if_t< internal::is_convertible< typename OtherDerived::Scalar, Scalar >::value, PrivateType >=PrivateType())

template<typename... ArgTypes>
	Array (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)

	Array (const Scalar &val0, const Scalar &val1)

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

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

	Array (const Scalar &value)

	Array (const Scalar *data)
	Constructs a fixed-sized array initialized with coefficients starting at data.

	Array (const std::initializer_list< std::initializer_list< Scalar >> &list)
	Constructs an array and initializes it from the coefficients given as initializer-lists grouped by row. [c++11] More...

	Array (Index dim)

	Array (Index rows, Index cols)

const Scalar &	coeff (Index index) const

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

Scalar &	coeffRef (Index index)

const Scalar &	coeffRef (Index index) const

Scalar &	coeffRef (Index rowId, Index colId)

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

Array &	operator= (const Array &other)

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

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

Array &	operator= (const Scalar &value)

Public Member Functions inherited from Eigen::PlainObjectBase< Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >
const Scalar &	coeff (Index index) const

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

Scalar &	coeffRef (Index index)

const Scalar &	coeffRef (Index index) const

Scalar &	coeffRef (Index rowId, Index colId)

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

void	conservativeResize (Index rows, Index cols)

void	conservativeResize (Index rows, NoChange_t)

void	conservativeResize (Index size)

void	conservativeResize (NoChange_t, Index cols)

void	conservativeResizeLike (const DenseBase< OtherDerived > &other)

Scalar *	data ()

const Scalar *	data () const

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	lazyAssign (const DenseBase< OtherDerived > &other)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	operator= (const PlainObjectBase &other)

void	resize (Index rows, Index cols)

void	resize (Index rows, NoChange_t)

void	resize (Index size)

void	resize (NoChange_t, Index cols)

void	resizeLike (const EigenBase< OtherDerived > &_other)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setConstant (Index size, const Scalar &val)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setConstant (Index rows, Index cols, const Scalar &val)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setConstant (NoChange_t, Index cols, const Scalar &val)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setConstant (Index rows, NoChange_t, const Scalar &val)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setZero (Index size)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setZero (Index rows, Index cols)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setZero (NoChange_t, Index cols)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setZero (Index rows, NoChange_t)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setOnes (Index size)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setOnes (Index rows, Index cols)

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	setOnes (NoChange_t, Index cols)

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)

Public Member Functions inherited from Eigen::ArrayBase< Derived >
MatrixWrapper< Derived >	matrix ()

template<typename OtherDerived >
Derived &	operator*= (const ArrayBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator+= (const ArrayBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator-= (const ArrayBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator/= (const ArrayBase< OtherDerived > &other)

Derived &	operator= (const ArrayBase &other)

Derived &	operator= (const Scalar &value)

Public Member Functions inherited from Eigen::DenseBase< Derived >
bool	all () const

bool	allFinite () const

bool	any () const

iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

const_iterator	cend () const

ColwiseReturnType	colwise ()

ConstColwiseReturnType	colwise () const

Index	count () const

iterator	end ()

const_iterator	end () const

EvalReturnType	eval () const

void	fill (const Scalar &value)

template<unsigned int Added, unsigned int Removed>
EIGEN_DEPRECATED const Derived &	flagged () const

const WithFormat< Derived >	format (const IOFormat &fmt) const

bool	hasNaN () const

EIGEN_CONSTEXPR Index	innerSize () const

template<typename OtherDerived >
bool	isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

bool	isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

bool	isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

template<typename OtherDerived >
bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

template<typename Derived >
bool	isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const

bool	isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

bool	isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

template<typename OtherDerived >
EIGEN_DEPRECATED Derived &	lazyAssign (const DenseBase< OtherDerived > &other)

template<int NaNPropagation>
internal::traits< Derived >::Scalar	maxCoeff () const

template<int NaNPropagation, typename IndexType >
internal::traits< Derived >::Scalar	maxCoeff (IndexType *index) const

template<int NaNPropagation, typename IndexType >
internal::traits< Derived >::Scalar	maxCoeff (IndexType row, IndexType col) const

Scalar	mean () const

template<int NaNPropagation>
internal::traits< Derived >::Scalar	minCoeff () const

template<int NaNPropagation, typename IndexType >
internal::traits< Derived >::Scalar	minCoeff (IndexType *index) const

template<int NaNPropagation, typename IndexType >
internal::traits< Derived >::Scalar	minCoeff (IndexType row, IndexType col) const

const NestByValue< Derived >	nestByValue () const

template<typename OtherDerived >
CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)

CommaInitializer< Derived >	operator<< (const Scalar &s)

Derived &	operator= (const DenseBase &other)

template<typename OtherDerived >
Derived &	operator= (const DenseBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...

EIGEN_CONSTEXPR Index	outerSize () const

Scalar	prod () const

template<typename Func >
internal::traits< Derived >::Scalar	redux (const Func &func) const

template<int RowFactor, int ColFactor>
const Replicate< Derived, RowFactor, ColFactor >	replicate () const

const Replicate< Derived, Dynamic, Dynamic >	replicate (Index rowFactor, Index colFactor) const

void	resize (Index newSize)

void	resize (Index rows, Index cols)

ReverseReturnType	reverse ()

ConstReverseReturnType	reverse () const

void	reverseInPlace ()

RowwiseReturnType	rowwise ()

ConstRowwiseReturnType	rowwise () const

template<typename ThenDerived , typename ElseDerived >
const Select< Derived, ThenDerived, ElseDerived >	select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const

template<typename ThenDerived >
const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType >	select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const

template<typename ElseDerived >
const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived >	select (const typename ElseDerived::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const

Derived &	setConstant (const Scalar &value)

Derived &	setLinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

Derived &	setLinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

Derived &	setOnes ()

Derived &	setRandom ()

Derived &	setZero ()

Scalar	sum () const

template<typename OtherDerived >
void	swap (const DenseBase< OtherDerived > &other)

template<typename OtherDerived >
void	swap (PlainObjectBase< OtherDerived > &other)

TransposeReturnType	transpose ()

const ConstTransposeReturnType	transpose () const

void	transposeInPlace ()

CoeffReturnType	value () const

template<typename Visitor >
void	visit (Visitor &func) const

Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	colStride () const EIGEN_NOEXCEPT

Derived &	derived ()

const Derived &	derived () const

EIGEN_CONSTEXPR Index	innerStride () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	outerStride () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	rowStride () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, WriteAccessors >
Scalar &	coeffRef (Index index)

Scalar &	coeffRef (Index row, Index col)

EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

Derived &	derived ()

const Derived &	derived () const

Scalar &	operator() (Index index)

Scalar &	operator() (Index row, Index col)

Scalar &	operator[] (Index index)

EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Scalar &	w ()

Scalar &	x ()

Scalar &	y ()

Scalar &	z ()

Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
CoeffReturnType	coeff (Index index) const

CoeffReturnType	coeff (Index row, Index col) const

EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

Derived &	derived ()

const Derived &	derived () const

CoeffReturnType	operator() (Index index) const

CoeffReturnType	operator() (Index row, Index col) const

CoeffReturnType	operator[] (Index index) const

EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

CoeffReturnType	w () const

CoeffReturnType	x () const

CoeffReturnType	y () const

CoeffReturnType	z () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

Derived &	derived ()

const Derived &	derived () const

EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

Additional Inherited Members
Public Types inherited from Eigen::DenseBase< Derived >
enum	{ RowsAtCompileTime , ColsAtCompileTime , SizeAtCompileTime , MaxRowsAtCompileTime , MaxColsAtCompileTime , MaxSizeAtCompileTime , IsVectorAtCompileTime , NumDimensions , Flags , IsRowMajor , InnerSizeAtCompileTime , InnerStrideAtCompileTime , OuterStrideAtCompileTime }

typedef random_access_iterator_type	const_iterator

typedef random_access_iterator_type	iterator

typedef Array< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign\|(internal::traits< Derived >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime >	PlainArray

typedef Matrix< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign\|(internal::traits< Derived >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime >	PlainMatrix

typedef std::conditional_t< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >	PlainObject
	The plain matrix or array type corresponding to this expression. More...

typedef internal::traits< Derived >::Scalar	Scalar

typedef internal::traits< Derived >::StorageIndex	StorageIndex
	The type used to store indices. More...

typedef Scalar	value_type

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

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 Public Member Functions inherited from Eigen::DenseBase< Derived >
static const ConstantReturnType	Constant (const Scalar &value)

static const ConstantReturnType	Constant (Index rows, Index cols, const Scalar &value)

static const ConstantReturnType	Constant (Index size, const Scalar &value)

static const RandomAccessLinSpacedReturnType	LinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

static const RandomAccessLinSpacedReturnType	LinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

static EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)

static EIGEN_DEPRECATED const RandomAccessLinSpacedReturnType	LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)

template<typename CustomNullaryOp >
static const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (const CustomNullaryOp &func)

template<typename CustomNullaryOp >
static const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)

template<typename CustomNullaryOp >
static const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index size, const CustomNullaryOp &func)

static const ConstantReturnType	Ones ()

static const ConstantReturnType	Ones (Index rows, Index cols)

static const ConstantReturnType	Ones (Index size)

static const RandomReturnType	Random ()

static const RandomReturnType	Random (Index rows, Index cols)

static const RandomReturnType	Random (Index size)

static const ConstantReturnType	Zero ()

static const ConstantReturnType	Zero (Index rows, Index cols)

static const ConstantReturnType	Zero (Index size)

Protected Member Functions inherited from Eigen::PlainObjectBase< Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > >
	PlainObjectBase (const DenseBase< OtherDerived > &other)

	PlainObjectBase (const EigenBase< OtherDerived > &other)

	PlainObjectBase (const PlainObjectBase &other)

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

	PlainObjectBase (const Scalar &a0, const Scalar &a1, const Scalar &a2, const Scalar &a3, const ArgTypes &... args)
	Construct a row of column vector with fixed size from an arbitrary number of coefficients. More...

	PlainObjectBase (const std::initializer_list< std::initializer_list< Scalar >> &list)
	Constructs a Matrix or Array and initializes it by elements given by an initializer list of initializer lists.

void	_resize_to_match (const EigenBase< OtherDerived > &other)

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

Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &	_set_noalias (const DenseBase< OtherDerived > &other)

void	_init2 (Index rows, Index cols, std::enable_if_t< Base::SizeAtCompileTime!=2, T0 > *=0)

void	_init2 (const T0 &val0, const T1 &val1, std::enable_if_t< Base::SizeAtCompileTime==2, T0 > *=0)

void	_init2 (const Index &val0, const Index &val1, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< T0, Index >::value) &&(internal::is_same< T1, Index >::value) &&Base::SizeAtCompileTime==2, T1 > *=0)

void	_init1 (Index size, std::enable_if_t<(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 > *=0)

void	_init1 (const Scalar &val0, std::enable_if_t< Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T > *=0)

void	_init1 (const Index &val0, std::enable_if_t<(!internal::is_same< Index, Scalar >::value) &&(internal::is_same< Index, T >::value) &&Base::SizeAtCompileTime==1 &&internal::is_convertible< T, Scalar >::value, T * > *=0)

void	_init1 (const Scalar *data)

void	_init1 (const DenseBase< OtherDerived > &other)

void	_init1 (const Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > &other)

void	_init1 (const EigenBase< OtherDerived > &other)

void	_init1 (const ReturnByValue< OtherDerived > &other)

void	_init1 (const RotationBase< OtherDerived, ColsAtCompileTime > &r)

void	_init1 (const Scalar &val0, std::enable_if_t< 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 > *=0)

void	_init1 (const Index &val0, std::enable_if_t<(!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 * > *=0)

Protected Member Functions inherited from Eigen::DenseBase< Derived >
	DenseBase ()

Related Functions inherited from Eigen::ArrayBase< Derived >
template<typename Derived , typename ExponentDerived >
const Eigen::CwiseBinaryOp< Eigen::internal::scalar_pow_op< typename Derived::Scalar, typename ExponentDerived::Scalar >, const Derived, const ExponentDerived >	pow (const Eigen::ArrayBase< Derived > &x, const Eigen::ArrayBase< ExponentDerived > &exponents)

template<typename Derived , typename ScalarExponent >
const CwiseBinaryOp< internal::scalar_pow_op< Derived::Scalar, ScalarExponent >, Derived, Constant< ScalarExponent > >	pow (const Eigen::ArrayBase< Derived > &x, const ScalarExponent &exponent)

template<typename Scalar , typename Derived >
const CwiseBinaryOp< internal::scalar_pow_op< Scalar, Derived::Scalar >, Constant< Scalar >, Derived >	pow (const Scalar &x, const Eigen::ArrayBase< Derived > &x)

Related Functions inherited from Eigen::DenseBase< Derived >
template<typename Derived >
std::ostream &	operator<< (std::ostream &s, const DenseBase< Derived > &m)

Constructor & Destructor Documentation

◆ Array() [1/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

template<typename... ArgTypes>

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array	(	const Scalar &	a0,
		const Scalar &	a1,
		const Scalar &	a2,
		const Scalar &	a3,
		const ArgTypes &...	args
	)

inline

Example:

Array<int, 1, 6> a(1, 2, 3, 4, 5, 6);
Array<int, 3, 1> b {1, 2, 3};
cout << a << "\n\n" << b << endl;

Output:

1 2 3 4 5 6

1
2
3

See also: Array(const std::initializer_list<std::initializer_list<Scalar>>&); Array(const Scalar&), Array(const Scalar&,const Scalar&)

◆ Array() [3/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array ( const std::initializer_list< std::initializer_list< Scalar >> & list )

inline

Constructs an array and initializes it from the coefficients given as initializer-lists grouped by row. [c++11]

In the general case, the constructor takes a list of rows, each row being represented as a list of coefficients:

Example:

ArrayXXi a {
  {1, 2, 3},
  {3, 4, 5}
};
cout << a << endl;

Output:

1 2 3
3 4 5

Each of the inner initializer lists must contain the exact same number of elements, otherwise an assertion is triggered.

In the case of a compile-time column 1D array, implicit transposition from a single row is allowed. Therefore Array<int,Dynamic,1>{{1,2,3,4,5}} is legal and the more verbose syntax Array<int,Dynamic,1>{{1},{2},{3},{4},{5}} can be avoided:

Example:

Array<int, Dynamic, 1> v {{1, 2, 3, 4, 5}};

cout << v << endl;

Output:

In the case of fixed-sized arrays, the initializer list sizes must exactly match the array sizes, and implicit transposition is allowed for compile-time 1D arrays only.

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

◆ Array() [4/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array ( Index dim )

inlineexplicit

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 Array() instead.

◆ Array() [5/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array ( const Scalar & value )

constructs an initialized 1x1 Array with the given coefficient

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

◆ Array() [6/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array	(	Index	rows,
		Index	cols
	)

constructs an uninitialized array with rows rows and cols columns.

This is useful for dynamic-size arrays. For fixed-size arrays, it is redundant to pass these parameters, so one should use the default constructor Array() instead.

◆ Array() [7/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array	(	const Scalar &	val0,
		const Scalar &	val1
	)

constructs an initialized 2D vector with given coefficients

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

◆ Array() [8/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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)

◆ Array() [9/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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)

◆ Array() [10/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array ( const Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ > & other )

inline

Copy constructor

◆ Array() [11/11]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

template<typename OtherDerived >

Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >::Array	(	const EigenBase< OtherDerived > &	other,
		std::enable_if_t< internal::is_convertible< typename OtherDerived::Scalar, Scalar >::value, PrivateType >	= `PrivateType()`
	)

inline

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

Member Function Documentation

◆ coeff() [1/2]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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

◆ coeff() [2/2]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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

◆ coeffRef() [1/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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.

◆ coeffRef() [2/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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

◆ coeffRef() [3/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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.

◆ coeffRef() [4/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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

◆ operator=() [1/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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

◆ operator=() [2/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

template<typename OtherDerived >

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=() [3/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

template<typename OtherDerived >

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=() [4/4]

template<typename Scalar_ , int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>

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

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

Array.h

Detailed Description

template<typename Scalar_, int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_> class Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Array() [1/11]

◆ Array() [2/11]

◆ Array() [3/11]

◆ Array() [4/11]

◆ Array() [5/11]

◆ Array() [6/11]

◆ Array() [7/11]

◆ Array() [8/11]

◆ Array() [9/11]

◆ Array() [10/11]

◆ Array() [11/11]

Member Function Documentation

◆ coeff() [1/2]

◆ coeff() [2/2]

◆ coeffRef() [1/4]

◆ coeffRef() [2/4]

◆ coeffRef() [3/4]

◆ coeffRef() [4/4]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

template<typename Scalar_, int Rows_, int Cols_, int Options_, int MaxRows_, int MaxCols_>
class Eigen::Array< Scalar_, Rows_, Cols_, Options_, MaxRows_, MaxCols_ >