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 Scalar *data)
	Constructs a fixed-sized array initialized with coefficients starting at data.

	Array (Index dim)

	Array (const Scalar &value)

	Array (Index rows, Index cols)

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

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

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

const Scalar &	coeff (Index index) const

Scalar &	coeffRef (Index index)

Scalar &	coeffRef (Index rowId, Index colId)

const Scalar &	coeffRef (Index index) const

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

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

Array &	operator= (const Scalar &value)

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

Array &	operator= (const Array &other)

Public Member Functions inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
const Scalar &	coeff (Index rowId, Index colId) const

const Scalar &	coeff (Index index) const

Scalar &	coeffRef (Index rowId, Index colId)

Scalar &	coeffRef (Index index)

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

const Scalar &	coeffRef (Index index) const

void	conservativeResize (Index rows, Index cols)

void	conservativeResize (Index rows, NoChange_t)

void	conservativeResize (NoChange_t, Index cols)

void	conservativeResize (Index size)

void	conservativeResizeLike (const DenseBase< OtherDerived > &other)

const Scalar *	data () const

Scalar *	data ()

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

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

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

void	resize (Index rows, Index cols)

void	resize (Index size)

void	resize (NoChange_t, Index cols)

void	resize (Index rows, NoChange_t)

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 > &	setOnes (Index size)

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

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 > &	setZero (Index size)

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

Public Member Functions inherited from Eigen::ArrayBase< Derived >
const AbsReturnType	abs () const

const Abs2ReturnType	abs2 () const

const AcosReturnType	acos () const

const ArgReturnType	arg () const

const AsinReturnType	asin () const

const AtanReturnType	atan () const

template<typename CustomBinaryOp , typename OtherDerived >
const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived >	binaryExpr (const Eigen::ArrayBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

template<typename NewType >
CastXpr< NewType >::Type	cast () const

const CeilReturnType	ceil () const

ConjugateReturnType	conjugate () const
	More...

const CosReturnType	cos () const

const CoshReturnType	cosh () const

const CubeReturnType	cube () const

const CwiseAbsReturnType	cwiseAbs () const

const CwiseAbs2ReturnType	cwiseAbs2 () const

template<typename OtherDerived >
const CwiseBinaryOp< std::equal_to< Scalar >, const Derived, const OtherDerived >	cwiseEqual (const Eigen::ArrayBase< OtherDerived > &other) const

const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

const CwiseInverseReturnType	cwiseInverse () const

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const OtherDerived >	cwiseMax (const Eigen::ArrayBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const ConstantReturnType >	cwiseMax (const Scalar &other) const

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const OtherDerived >	cwiseMin (const Eigen::ArrayBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const ConstantReturnType >	cwiseMin (const Scalar &other) const

template<typename OtherDerived >
const CwiseBinaryOp< std::not_equal_to< Scalar >, const Derived, const OtherDerived >	cwiseNotEqual (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_product_op< Derived ::Scalar, OtherDerived ::Scalar >, const Derived, const OtherDerived >	cwiseProduct (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const Derived, const OtherDerived >	cwiseQuotient (const Eigen::ArrayBase< OtherDerived > &other) const

const CwiseSignReturnType	cwiseSign () const

const CwiseSqrtReturnType	cwiseSqrt () const

const DigammaReturnType	digamma () const

const ErfReturnType	erf () const

const ErfcReturnType	erfc () const

const ExpReturnType	exp () const

const FloorReturnType	floor () const

const ImagReturnType	imag () const
	More...

NonConstImagReturnType	imag ()
	More...

const InverseReturnType	inverse () const

const IsFiniteReturnType	isFinite () const

const IsInfReturnType	isInf () const

const IsNaNReturnType	isNaN () const

const LgammaReturnType	lgamma () const

const LogReturnType	log () const

const Log10ReturnType	log10 () const

const Log1pReturnType	log1p () const

MatrixWrapper< Derived >	matrix ()

template<typename OtherDerived >
const CwiseBinaryOp< max< Scalar >, const Derived, const OtherDerived >	max (const Eigen::ArrayBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject > >	max (const Scalar &other) const

template<typename OtherDerived >
const CwiseBinaryOp< min< Scalar >, const Derived, const OtherDerived >	min (const Eigen::ArrayBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject > >	min (const Scalar &other) const

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_boolean_and_op, const Derived, const OtherDerived >	operator && (const Eigen::ArrayBase< OtherDerived > &other) const

const BooleanNotReturnType	operator! () const

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_product_op< Derived ::Scalar, OtherDerived ::Scalar >, const Derived, const OtherDerived >	operator* (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename T >
const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, Derived, Constant< T > >	operator* (const T &scalar) const

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

template<typename OtherDerived >
const CwiseBinaryOp< sum< Scalar >, const Derived, const OtherDerived >	operator+ (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename T >
const CwiseBinaryOp< internal::scalar_sum_op< Scalar, T >, Derived, Constant< T > >	operator+ (const T &scalar) const

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

template<typename OtherDerived >
const CwiseBinaryOp< difference< Scalar >, const Derived, const OtherDerived >	operator- (const Eigen::ArrayBase< OtherDerived > &other) const

const NegativeReturnType	operator- () const

template<typename T >
const CwiseBinaryOp< internal::scalar_difference_op< Scalar, T >, Derived, Constant< T > >	operator- (const T &scalar) const

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

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar, typename OtherDerived::Scalar >, const Derived, const OtherDerived >	operator/ (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename T >
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar, T >, Derived, Constant< T > >	operator/ (const T &scalar) const

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

Derived &	operator= (const ArrayBase &other)

Derived &	operator= (const Scalar &value)

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_boolean_xor_op, const Derived, const OtherDerived >	operator^ (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename OtherDerived >
const CwiseBinaryOp< internal::scalar_boolean_or_op, const Derived, const OtherDerived >	operator\|\| (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename OtherDerived >
const CwiseBinaryOp< pow< Scalar >, const Derived, const OtherDerived >	pow (const Eigen::ArrayBase< OtherDerived > &other) const

template<typename T >
const CwiseBinaryOp< internal::scalar_pow_op< Scalar, T >, Derived, Constant< T > >	pow (const T &exponent) const

RealReturnType	real () const
	More...

NonConstRealReturnType	real ()
	More...

const RoundReturnType	round () const

const RsqrtReturnType	rsqrt () const

const SignReturnType	sign () const

const SinReturnType	sin () const

const SinhReturnType	sinh () const

const SqrtReturnType	sqrt () const

const SquareReturnType	square () const

const TanReturnType	tan () const

const TanhReturnType	tanh () const

template<typename CustomUnaryOp >
const CwiseUnaryOp< CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...

template<typename CustomViewOp >
const CwiseUnaryView< CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const

template<typename DerivedQ >
const CwiseBinaryOp< internal::scalar_zeta_op< Scalar >, const Derived, const DerivedQ >	zeta (const Eigen::ArrayBase< DerivedQ > &q) const

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

bool	allFinite () const

bool	any () const

BlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const ConstBlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index). */.

template<int NRows, int NCols>
FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol)

template<int NRows, int NCols>
const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). */.

template<int NRows, int NCols>
FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

template<int NRows, int NCols>
const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index).

BlockXpr	bottomLeftCorner (Index cRows, Index cCols)

const ConstBlockXpr	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index).

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner ()

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>().

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index).

BlockXpr	bottomRightCorner (Index cRows, Index cCols)

const ConstBlockXpr	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index).

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner ()

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>().

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index).

RowsBlockXpr	bottomRows (Index n)

ConstRowsBlockXpr	bottomRows (Index n) const
	This is the const version of bottomRows(Index).

template<int N>
NRowsBlockXpr< N >::Type	bottomRows (Index n=N)

template<int N>
ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>().

ColXpr	col (Index i)

ConstColXpr	col (Index i) const
	This is the const version of col().

ConstColwiseReturnType	colwise () const

ColwiseReturnType	colwise ()

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

SegmentReturnType	head (Index n)

ConstSegmentReturnType	head (Index n) const
	This is the const version of head(Index).

template<int N>
FixedSegmentReturnType< N >::Type	head (Index n=N)

template<int N>
ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>().

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 Derived >
bool	isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const

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

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

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

ColsBlockXpr	leftCols (Index n)

ConstColsBlockXpr	leftCols (Index n) const
	This is the const version of leftCols(Index).

template<int N>
NColsBlockXpr< N >::Type	leftCols (Index n=N)

template<int N>
ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>().

internal::traits< Derived >::Scalar	maxCoeff () const

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

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

Scalar	mean () const

ColsBlockXpr	middleCols (Index startCol, Index numCols)

ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
	This is the const version of middleCols(Index,Index).

template<int N>
NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)

template<int N>
ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>().

RowsBlockXpr	middleRows (Index startRow, Index n)

ConstRowsBlockXpr	middleRows (Index startRow, Index n) const
	This is the const version of middleRows(Index,Index).

template<int N>
NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)

template<int N>
ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>().

internal::traits< Derived >::Scalar	minCoeff () const

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

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

const NestByValue< Derived >	nestByValue () const

Index	nonZeros () const

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

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

template<typename CustomNullaryOp >
const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (const CustomNullaryOp &func)

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

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

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

Derived &	operator= (const DenseBase &other)

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

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

ColsBlockXpr	rightCols (Index n)

ConstColsBlockXpr	rightCols (Index n) const
	This is the const version of rightCols(Index).

template<int N>
NColsBlockXpr< N >::Type	rightCols (Index n=N)

template<int N>
ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>().

RowXpr	row (Index i)

ConstRowXpr	row (Index i) const
	This is the const version of row(). */.

ConstRowwiseReturnType	rowwise () const

RowwiseReturnType	rowwise ()

SegmentReturnType	segment (Index start, Index n)

ConstSegmentReturnType	segment (Index start, Index n) const
	This is the const version of segment(Index,Index).

template<int N>
FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)

template<int N>
ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index).

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 (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...

Derived &	setLinSpaced (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)

SegmentReturnType	tail (Index n)

ConstSegmentReturnType	tail (Index n) const
	This is the const version of tail(Index).

template<int N>
FixedSegmentReturnType< N >::Type	tail (Index n=N)

template<int N>
ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>.

BlockXpr	topLeftCorner (Index cRows, Index cCols)

const ConstBlockXpr	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index).

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	topLeftCorner ()

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>().

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index).

BlockXpr	topRightCorner (Index cRows, Index cCols)

const ConstBlockXpr	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index).

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	topRightCorner ()

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
	This is the const version of topRightCorner<int, int>().

template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index).

RowsBlockXpr	topRows (Index n)

ConstRowsBlockXpr	topRows (Index n) const
	This is the const version of topRows(Index).

template<int N>
NRowsBlockXpr< N >::Type	topRows (Index n=N)

template<int N>
ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>().

TransposeReturnType	transpose ()

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 >
Index	cols () const

Index	colStride () const

Derived &	derived ()

const Derived &	derived () const

Index	innerStride () const

Index	outerStride () const

Index	rows () const

Index	rowStride () const

Index	size () const

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

Scalar &	coeffRef (Index index)

Index	cols () const

const Derived &	derived () const

Derived &	derived ()

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

Scalar &	operator() (Index index)

Scalar &	operator[] (Index index)

Index	rows () const

Index	size () const

Scalar &	w ()

Scalar &	x ()

Scalar &	y ()

Scalar &	z ()

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

CoeffReturnType	coeff (Index index) const

Index	cols () const

Derived &	derived ()

const Derived &	derived () const

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

CoeffReturnType	operator() (Index index) const

CoeffReturnType	operator[] (Index index) const

Index	rows () const

Index	size () const

CoeffReturnType	w () const

CoeffReturnType	x () const

CoeffReturnType	y () const

CoeffReturnType	z () const

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

Derived &	derived ()

const Derived &	derived () const

Index	rows () const

Index	size () const

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

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 internal::conditional< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type	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 (Index rows, Index cols, const Scalar &value)

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

static const ConstantReturnType	Constant (const Scalar &value)

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

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

static const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)

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

static const ConstantReturnType	Ones (Index rows, Index cols)

static const ConstantReturnType	Ones (Index size)

static const ConstantReturnType	Ones ()

static const RandomReturnType	Random (Index rows, Index cols)

static const RandomReturnType	Random (Index size)

static const RandomReturnType	Random ()

static const ConstantReturnType	Zero (Index rows, Index cols)

static const ConstantReturnType	Zero (Index size)

static const ConstantReturnType	Zero ()

Protected Member Functions inherited from Eigen::PlainObjectBase< Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >
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...

	PlainObjectBase (const PlainObjectBase &other)

	PlainObjectBase (const DenseBase< OtherDerived > &other)

	PlainObjectBase (const EigenBase< OtherDerived > &other)

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

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

Related Functions inherited from Eigen::ArrayBase< Derived >
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 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 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/9]

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

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

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

◆ Array() [4/9]

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() [5/9]

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

◆ Array() [6/9]

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

◆ Array() [7/9]

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

◆ Array() [8/9]

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

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

◆ 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) which is thus synonym of coeff(Index). It is provided for convenience.

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

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

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:

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

◆ Array() [2/9]

◆ Array() [3/9]

◆ Array() [4/9]

◆ Array() [5/9]

◆ Array() [6/9]

◆ Array() [7/9]

◆ Array() [8/9]

◆ Array() [9/9]

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 >