Detailed Description

Expression of a mathematical vector or matrix as an array object.

This class is the return type of MatrixBase::array(), and most of the time this is the only way it is use.

See also:: MatrixBase::array(), class MatrixWrapper

Inheritance diagram for Eigen::ArrayWrapper:

Public Types
typedef ArrayBase< ArrayWrapper >	Base
typedef internal::conditional < internal::is_lvalue < ExpressionType >::value, Scalar, const Scalar >::type	ScalarWithConstIfNotLvalue
typedef internal::nested < ExpressionType >::type	NestedExpressionType
Public Member Functions
	ArrayWrapper (const ExpressionType &matrix)
Index	rows () const
Index	cols () const
Index	outerStride () const
Index	innerStride () const
ScalarWithConstIfNotLvalue *	data ()
const Scalar *	data () const
const CoeffReturnType	coeff (Index row, Index col) const
Scalar &	coeffRef (Index row, Index col)
const Scalar &	coeffRef (Index row, Index col) const
const CoeffReturnType	coeff (Index index) const
Scalar &	coeffRef (Index index)
const Scalar &	coeffRef (Index index) const
template<int LoadMode>
const PacketScalar	packet (Index row, Index col) const
template<int LoadMode>
void	writePacket (Index row, Index col, const PacketScalar &x)
template<int LoadMode>
const PacketScalar	packet (Index index) const
template<int LoadMode>
void	writePacket (Index index, const PacketScalar &x)
template<typename Dest >
void	evalTo (Dest &dst) const
const internal::remove_all < NestedExpressionType >::type &	nestedExpression () const
const CwiseUnaryOp < internal::scalar_opposite_op < typename internal::traits < Derived >::Scalar >, const Derived >	operator- () const
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator- (const Scalar &scalar) const
const ScalarMultipleReturnType	operator* (const Scalar &scalar) const
const ScalarMultipleReturnType	operator* (const RealScalar &scalar) const
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const Derived >	operator* (const std::complex< Scalar > &scalar) const
	Overloaded for efficient real matrix times complex scalar value.
const CwiseUnaryOp < internal::scalar_quotient1_op < typename internal::traits < Derived >::Scalar >, const Derived >	operator/ (const Scalar &scalar) const
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const Derived, const OtherDerived >	operator/ (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
internal::cast_return_type < Derived, const CwiseUnaryOp < internal::scalar_cast_op < typename internal::traits < Derived >::Scalar, NewType > , const Derived > >::type	cast () const
ConjugateReturnType	conjugate () const
RealReturnType	real () const
NonConstRealReturnType	real ()
const ImagReturnType	imag () const
NonConstImagReturnType	imag ()
const CwiseUnaryOp < CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise.
const CwiseUnaryView < CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const Derived >	cwiseAbs () const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const Derived >	cwiseAbs2 () const
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const Derived >	cwiseSqrt () const
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const Derived >	cwiseInverse () const
const CwiseUnaryOp < std::binder1st < std::equal_to< Scalar > >, const Derived >	cwiseEqual (const Scalar &s) const
const CwiseBinaryOp < std::equal_to< Scalar > , const Derived, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs_op < Scalar >, const Derived >	abs () const
EIGEN_STRONG_INLINE const CwiseUnaryOp < internal::scalar_abs2_op < Scalar >, const Derived >	abs2 () const
const CwiseUnaryOp < internal::scalar_exp_op < Scalar >, const Derived >	exp () const
const CwiseUnaryOp < internal::scalar_log_op < Scalar >, const Derived >	log () const
const CwiseUnaryOp < internal::scalar_sqrt_op < Scalar >, const Derived >	sqrt () const
const CwiseUnaryOp < internal::scalar_cos_op < Scalar >, const Derived >	cos () const
const CwiseUnaryOp < internal::scalar_sin_op < Scalar >, const Derived >	sin () const
const CwiseUnaryOp < internal::scalar_acos_op < Scalar >, const Derived >	acos () const
const CwiseUnaryOp < internal::scalar_asin_op < Scalar >, const Derived >	asin () const
const CwiseUnaryOp < internal::scalar_tan_op < Scalar >, Derived >	tan () const
const CwiseUnaryOp < internal::scalar_pow_op < Scalar >, const Derived >	pow (const Scalar &exponent) const
const CwiseUnaryOp < internal::scalar_inverse_op < Scalar >, const Derived >	inverse () const
const CwiseUnaryOp < internal::scalar_square_op < Scalar >, const Derived >	square () const
const CwiseUnaryOp < internal::scalar_cube_op < Scalar >, const Derived >	cube () const
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) operator*(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseBinaryOp < std::not_equal_to< Scalar > , const Derived, const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_min_op < Scalar >, const Derived, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_max_op < Scalar >, const Derived, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp < internal::scalar_quotient_op < Scalar >, const Derived, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator+ (const Scalar &scalar) const
const CwiseBinaryOp < internal::scalar_boolean_and_op, const Derived, const OtherDerived >	operator&& (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseBinaryOp < internal::scalar_boolean_or_op, const Derived, const OtherDerived >	operator\|\| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
Derived &	operator+= (const Scalar &scalar)
Derived &	operator+= (const ArrayBase< OtherDerived > &other)
Derived &	operator-= (const Scalar &scalar)
Derived &	operator-= (const ArrayBase< OtherDerived > &other)
Derived &	operator*= (const ArrayBase< OtherDerived > &other)
Derived &	operator/= (const ArrayBase< OtherDerived > &other)
ArrayBase< Derived > &	array ()
const ArrayBase< Derived > &	array () const
MatrixWrapper< Derived >	matrix ()
const MatrixWrapper< Derived >	matrix () const
Protected Member Functions
Derived &	operator+= (const MatrixBase< OtherDerived > &)
Derived &	operator-= (const MatrixBase< OtherDerived > &)
Protected Attributes
const NestedExpressionType	m_expression
Friends
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const CwiseUnaryOp < internal::scalar_opposite_op < Scalar >, const Derived > >	operator- (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)
const ScalarMultipleReturnType	operator* (const Scalar &scalar, const StorageBaseType &matrix)
const CwiseUnaryOp < internal::scalar_multiple2_op < Scalar, std::complex< Scalar > >, const Derived >	operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix)
const CwiseUnaryOp < internal::scalar_add_op < Scalar >, const Derived >	operator+ (const Scalar &scalar, const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &other)

Member Typedef Documentation

typedef ArrayBase<ArrayWrapper> Eigen::ArrayWrapper::Base

Definition at line 53 of file Core.

typedef internal::nested<ExpressionType>::type Eigen::ArrayWrapper::NestedExpressionType

Definition at line 63 of file Core.

typedef internal::conditional< internal::is_lvalue<ExpressionType>::value, Scalar, const Scalar >::type Eigen::ArrayWrapper::ScalarWithConstIfNotLvalue

Definition at line 61 of file Core.

Constructor & Destructor Documentation

Eigen::ArrayWrapper::ArrayWrapper ( const ExpressionType & matrix ) [inline]

Definition at line 65 of file Core.

Member Function Documentation

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::ArrayBase::abs ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise absolute value of *this

Example:

Output:

See also:: abs2()

Definition at line 12 of file Core.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::ArrayBase::abs2 ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise squared absolute value of *this

Example:

Output:

See also:: abs(), square()

Definition at line 25 of file Core.

const CwiseUnaryOp<internal::scalar_acos_op<Scalar>, const Derived> Eigen::ArrayBase::acos ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise arc cosine of *this.

Example:

Output:

See also:: cos(), asin()

Definition at line 104 of file Core.

ArrayBase<Derived>& Eigen::ArrayBase::array ( ) [inline, inherited]

Definition at line 156 of file Core.

const ArrayBase<Derived>& Eigen::ArrayBase::array ( ) const [inline, inherited]

Definition at line 157 of file Core.

const CwiseUnaryOp<internal::scalar_asin_op<Scalar>, const Derived> Eigen::ArrayBase::asin ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise arc sine of *this.

Example:

Output:

See also:: sin(), acos()

Definition at line 117 of file Core.

EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> Eigen::ArrayBase::binaryExpr	(	const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &	other,
		const CustomBinaryOp &	func = `CustomBinaryOp()`
	)		const `[inline, inherited]`

Returns:: an expression of the difference of *this and other

Note:: If you want to substract a given scalar from all coefficients, see Cwise::operator-().

See also:: class CwiseBinaryOp, operator-=()

Returns:: an expression of the sum of *this and other

Note:: If you want to add a given scalar to all coefficients, see Cwise::operator+().

See also:: class CwiseBinaryOp, operator+=()

Returns:: an expression of a custom coefficient-wise operator func of *this and other

The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)

Here is an example illustrating the use of custom functors:

Output:

See also:: class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()

Definition at line 58 of file Core.

internal::cast_return_type<Derived,const CwiseUnaryOp<internal::scalar_cast_op<typename internal::traits<Derived>::Scalar, NewType>, const Derived> >::type Eigen::ArrayBase::cast ( ) const [inline, inherited]

Returns:: an expression of *this with the Scalar type casted to NewScalar.

The template parameter NewScalar is the type we are casting the scalars to.

See also:: class CwiseUnaryOp

Definition at line 108 of file Core.

const CoeffReturnType Eigen::ArrayWrapper::coeff	(	Index	row,
		Index	col
	)		const `[inline]`

Definition at line 75 of file Core.

const CoeffReturnType Eigen::ArrayWrapper::coeff ( Index index ) const [inline]

Definition at line 90 of file Core.

Scalar& Eigen::ArrayWrapper::coeffRef	(	Index	row,
		Index	col
	)		`[inline]`

Definition at line 80 of file Core.

const Scalar& Eigen::ArrayWrapper::coeffRef	(	Index	row,
		Index	col
	)		const `[inline]`

Definition at line 85 of file Core.

Scalar& Eigen::ArrayWrapper::coeffRef ( Index index ) [inline]

Definition at line 95 of file Core.

const Scalar& Eigen::ArrayWrapper::coeffRef ( Index index ) const [inline]

Definition at line 100 of file Core.

Index Eigen::ArrayWrapper::cols ( void ) const [inline]

Definition at line 68 of file Core.

ConjugateReturnType Eigen::ArrayBase::conjugate ( ) const [inline, inherited]

Returns:: an expression of the complex conjugate of *this.

See also:: adjoint()

Definition at line 117 of file Core.

const CwiseUnaryOp<internal::scalar_cos_op<Scalar>, const Derived> Eigen::ArrayBase::cos ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise cosine of *this.

Example:

Output:

See also:: sin(), acos()

Definition at line 77 of file Core.

const CwiseUnaryOp<internal::scalar_cube_op<Scalar>, const Derived> Eigen::ArrayBase::cube ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise cube of *this.

Example:

Output:

See also:: square(), pow()

Definition at line 185 of file Core.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseAbs ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise absolute value of *this

Example:

Output:

See also:: cwiseAbs2()

Definition at line 37 of file Core.

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseAbs2 ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise squared absolute value of *this

Example:

Output:

See also:: cwiseAbs()

Definition at line 47 of file Core.

const CwiseBinaryOp<std::equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient-wise == operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: cwiseNotEqual(), isApprox(), isMuchSmallerThan()

Definition at line 57 of file Core.

const CwiseUnaryOp<std::binder1st<std::equal_to<Scalar> >, const Derived> Eigen::ArrayBase::cwiseEqual ( const Scalar & s ) const [inline, inherited]

Returns:: an expression of the coefficient-wise == operator of *this and a scalar s

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

See also:: cwiseEqual(const MatrixBase<OtherDerived> &) const

Definition at line 79 of file Core.

const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseInverse ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise inverse of *this.

Example:

Output:

See also:: cwiseProduct()

Definition at line 67 of file Core.

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseMax ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient-wise max of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, min()

Definition at line 104 of file Core.

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseMin ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient-wise min of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, max()

Definition at line 90 of file Core.

const CwiseBinaryOp<std::not_equal_to<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseNotEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient-wise != operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: cwiseEqual(), isApprox(), isMuchSmallerThan()

Definition at line 76 of file Core.

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::cwiseQuotient ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient-wise quotient of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, cwiseProduct(), cwiseInverse()

Definition at line 118 of file Core.

const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::ArrayBase::cwiseSqrt ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise square root of *this.

Example:

Output:

See also:: cwisePow(), cwiseSquare()

Definition at line 57 of file Core.

ScalarWithConstIfNotLvalue* Eigen::ArrayWrapper::data ( ) [inline]

Definition at line 72 of file Core.

const Scalar* Eigen::ArrayWrapper::data ( ) const [inline]

Definition at line 73 of file Core.

EIGEN_STRONG_INLINE const Eigen::ArrayBase::EIGEN_CWISE_PRODUCT_RETURN_TYPE	(	Derived	,
		OtherDerived
	)		const `[inline, inherited]`

Returns:: an expression of the coefficient wise product of *this and other

See also:: MatrixBase::cwiseProduct

Definition at line 7 of file Core.

EIGEN_STRONG_INLINE const Eigen::ArrayBase::EIGEN_CWISE_PRODUCT_RETURN_TYPE	(	Derived	,
		OtherDerived
	)		const `[inline, inherited]`

Returns:: an expression of the Schur product (coefficient wise product) of *this and other

Example:

Output:

See also:: class CwiseBinaryOp, cwiseAbs2

Definition at line 37 of file Core.

template<typename Dest >

void Eigen::ArrayWrapper::evalTo ( Dest & dst ) const [inline]

Definition at line 130 of file Core.

const CwiseUnaryOp<internal::scalar_exp_op<Scalar>, const Derived> Eigen::ArrayBase::exp ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise exponential of *this.

Example:

Output:

See also:: pow(), log(), sin(), cos()

Definition at line 38 of file Core.

const ImagReturnType Eigen::ArrayBase::imag ( ) const [inline, inherited]

Returns:: an read-only expression of the imaginary part of *this.

See also:: real()

Definition at line 132 of file Core.

NonConstImagReturnType Eigen::ArrayBase::imag ( ) [inline, inherited]

Returns:: a non const expression of the imaginary part of *this.

See also:: real()

Definition at line 188 of file Core.

Index Eigen::ArrayWrapper::innerStride ( ) const [inline]

Definition at line 70 of file Core.

const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::ArrayBase::inverse ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise inverse of *this.

Example:

Output:

See also:: operator/(), operator*()

Definition at line 159 of file Core.

const CwiseUnaryOp<internal::scalar_log_op<Scalar>, const Derived> Eigen::ArrayBase::log ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise logarithm of *this.

Example:

Output:

See also:: exp()

Definition at line 51 of file Core.

MatrixWrapper<Derived> Eigen::ArrayBase::matrix ( ) [inline, inherited]

Returns:: an Matrix expression of this array

See also:: MatrixBase::array()

Definition at line 161 of file Core.

const MatrixWrapper<Derived> Eigen::ArrayBase::matrix ( ) const [inline, inherited]

Definition at line 162 of file Core.

const internal::remove_all<NestedExpressionType>::type& Eigen::ArrayWrapper::nestedExpression ( ) const [inline]

Definition at line 133 of file Core.

const CwiseBinaryOp<internal::scalar_boolean_and_op, const Derived, const OtherDerived> Eigen::ArrayBase::operator&& ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient-wise && operator of *this and other

Warning:: this operator is for expression of bool only.

Example:

Output:

See also:: operator||(), select()

Definition at line 157 of file Core.

const ScalarMultipleReturnType Eigen::ArrayBase::operator* ( const Scalar & scalar ) const [inline, inherited]

Returns:: an expression of *this scaled by the scalar factor scalar

Definition at line 65 of file Core.

const ScalarMultipleReturnType Eigen::ArrayBase::operator* ( const RealScalar & scalar ) const [inherited]

const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> Eigen::ArrayBase::operator* ( const std::complex< Scalar > & scalar ) const [inline, inherited]

Overloaded for efficient real matrix times complex scalar value.

Definition at line 85 of file Core.

Derived& Eigen::ArrayBase::operator*= ( const ArrayBase< OtherDerived > & other ) [inherited]

replaces *this by *this * other coefficient wise.

Returns:: a reference to *this

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> Eigen::ArrayBase::operator+ ( const Scalar & scalar ) const [inline, inherited]

Returns:: an expression of the coefficient-wise min of *this and other

Example:

Output:

See also:: max()

Returns:: an expression of the coefficient-wise max of *this and other

Example:

Output:

See also:: min()

Returns:: an expression of the coefficient-wise < operator of *this and other

Example:

Output:

See also:: all(), any(), operator>(), operator<=()

Returns:: an expression of the coefficient-wise <= operator of *this and other

Example:

Output:

See also:: all(), any(), operator>=(), operator<()

Returns:: an expression of the coefficient-wise > operator of *this and other

Example:

Output:

See also:: all(), any(), operator>=(), operator<()

Returns:: an expression of the coefficient-wise >= operator of *this and other

Example:

Output:

See also:: all(), any(), operator>(), operator<=()

Returns:: an expression of the coefficient-wise == operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: all(), any(), isApprox(), isMuchSmallerThan()

Returns:: an expression of the coefficient-wise != operator of *this and other

Warning:: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

Output:

See also:: all(), any(), isApprox(), isMuchSmallerThan()

Returns:: an expression of *this with each coeff incremented by the constant scalar

Example:

Output:

See also:: operator+=(), operator-()

Definition at line 116 of file Core.

Derived& Eigen::ArrayBase::operator+= ( const Scalar & scalar ) [inline, inherited]

Definition at line 139 of file Core.

Derived& Eigen::ArrayBase::operator+= ( const ArrayBase< OtherDerived > & other ) [inherited]

replaces *this by *this + other.

Returns:: a reference to *this

Derived& Eigen::ArrayBase::operator+= ( const MatrixBase< OtherDerived > & ) [inline, protected, inherited]

Definition at line 176 of file Core.

const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::ArrayBase::operator- ( ) const [inline, inherited]

Returns:: an expression of the opposite of *this

Definition at line 60 of file Core.

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> Eigen::ArrayBase::operator- ( const Scalar & scalar ) const [inline, inherited]

Returns:: an expression of *this with each coeff decremented by the constant scalar

Example:

Output:

See also:: operator+(), operator-=()

Definition at line 135 of file Core.

Derived& Eigen::ArrayBase::operator-= ( const Scalar & scalar ) [inline, inherited]

Definition at line 141 of file Core.

Derived& Eigen::ArrayBase::operator-= ( const ArrayBase< OtherDerived > & other ) [inherited]

replaces *this by *this - other.

Returns:: a reference to *this

Derived& Eigen::ArrayBase::operator-= ( const MatrixBase< OtherDerived > & ) [inline, protected, inherited]

Definition at line 179 of file Core.

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::ArrayBase::operator/ ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient wise quotient of *this and other

See also:: MatrixBase::cwiseQuotient

Definition at line 19 of file Core.

const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::ArrayBase::operator/ ( const Scalar & scalar ) const [inline, inherited]

Returns:: an expression of *this divided by the scalar value scalar

Definition at line 77 of file Core.

Derived& Eigen::ArrayBase::operator/= ( const ArrayBase< OtherDerived > & other ) [inherited]

replaces *this by *this / other coefficient wise.

Returns:: a reference to *this

const CwiseBinaryOp<internal::scalar_boolean_or_op, const Derived, const OtherDerived> Eigen::ArrayBase::operator|| ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const [inline, inherited]

Returns:: an expression of the coefficient-wise || operator of *this and other

Warning:: this operator is for expression of bool only.

Example:

Output:

See also:: operator&&(), select()

Definition at line 175 of file Core.

Index Eigen::ArrayWrapper::outerStride ( ) const [inline]

Definition at line 69 of file Core.

template<int LoadMode>

const PacketScalar Eigen::ArrayWrapper::packet	(	Index	row,
		Index	col
	)		const `[inline]`

Definition at line 106 of file Core.

template<int LoadMode>

const PacketScalar Eigen::ArrayWrapper::packet ( Index index ) const [inline]

Definition at line 118 of file Core.

const CwiseUnaryOp<internal::scalar_pow_op<Scalar>, const Derived> Eigen::ArrayBase::pow ( const Scalar & exponent ) const [inline, inherited]

Returns:: an expression of the coefficient-wise power of *this to the given exponent.

Example:

Output:

See also:: exp(), log()

Definition at line 144 of file Core.

RealReturnType Eigen::ArrayBase::real ( ) const [inline, inherited]

Returns:: a read-only expression of the real part of *this.

See also:: imag()

Definition at line 126 of file Core.

NonConstRealReturnType Eigen::ArrayBase::real ( ) [inline, inherited]

Returns:: a non const expression of the real part of *this.

See also:: imag()

Definition at line 182 of file Core.

Index Eigen::ArrayWrapper::rows ( void ) const [inline]

Definition at line 67 of file Core.

const CwiseUnaryOp<internal::scalar_sin_op<Scalar>, const Derived> Eigen::ArrayBase::sin ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise sine of *this.

Example:

Output:

See also:: cos(), asin()

Definition at line 91 of file Core.

const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::ArrayBase::sqrt ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise square root of *this.

Example:

Output:

See also:: pow(), square()

Definition at line 64 of file Core.

const CwiseUnaryOp<internal::scalar_square_op<Scalar>, const Derived> Eigen::ArrayBase::square ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise square of *this.

Example:

Output:

See also:: operator/(), operator*(), abs2()

Definition at line 172 of file Core.

const CwiseUnaryOp<internal::scalar_tan_op<Scalar>, Derived> Eigen::ArrayBase::tan ( ) const [inline, inherited]

Returns:: an expression of the coefficient-wise tan of *this.

Example:

Output:

See also:: cos(), sin()

Definition at line 130 of file Core.

const CwiseUnaryOp<CustomUnaryOp, const Derived> Eigen::ArrayBase::unaryExpr ( const CustomUnaryOp & func = CustomUnaryOp() ) const [inline, inherited]

Apply a unary operator coefficient-wise.

Parameters:

[in] func Functor implementing the unary operator

Template Parameters:

CustomUnaryOp Type of func

Returns:: An expression of a custom coefficient-wise unary operator func of *this

The function ptr_fun() from the C++ standard library can be used to make functors out of normal functions.

Example:

Output:

Genuine functors allow for more possibilities, for instance it may contain a state.

Example:

Output:

See also:: class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 155 of file Core.

const CwiseUnaryView<CustomViewOp, const Derived> Eigen::ArrayBase::unaryViewExpr ( const CustomViewOp & func = CustomViewOp() ) const [inline, inherited]

Returns:: an expression of a custom coefficient-wise unary operator func of *this

The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.

Example:

Output:

See also:: class CwiseUnaryOp, class CwiseBinaryOp

Definition at line 173 of file Core.

template<int LoadMode>

void Eigen::ArrayWrapper::writePacket	(	Index	row,
		Index	col,
		const PacketScalar &	x
	)		`[inline]`

Definition at line 112 of file Core.

template<int LoadMode>

void Eigen::ArrayWrapper::writePacket	(	Index	index,
		const PacketScalar &	x
	)		`[inline]`

Definition at line 124 of file Core.

Friends And Related Function Documentation

const ScalarMultipleReturnType operator*	(	const Scalar &	scalar,
		const StorageBaseType &	matrix
	)		`[friend, inherited]`

Definition at line 92 of file Core.

const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> operator*	(	const std::complex< Scalar > &	scalar,
		const StorageBaseType &	matrix
	)		`[friend, inherited]`

Definition at line 96 of file Core.

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> operator+	(	const Scalar &	scalar,
		const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &	other
	)		`[friend, inherited]`

Definition at line 122 of file Core.

const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const CwiseUnaryOp<internal::scalar_opposite_op<Scalar>, const Derived> > operator-	(	const Scalar &	scalar,
		const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > &	other
	)		`[friend, inherited]`

Definition at line 141 of file Core.

Member Data Documentation

const NestedExpressionType Eigen::ArrayWrapper::m_expression [protected]

Definition at line 139 of file Core.

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation