Public Types | Public Member Functions | Protected Member Functions | Friends

ArrayBase< Derived > Class Template Reference

Base class for all 1D and 2D array, and related expressions. More...

#include <ArrayBase.h>

Inheritance diagram for ArrayBase< Derived >:
DenseBase< Derived > internal::special_scalar_op_base< Derived, internal::traits< Derived >::Scalar, NumTraits< internal::traits< Derived >::Scalar >::Real > DenseCoeffsBase

List of all members.

Public Types

typedef ArrayBase StorageBaseType
typedef ArrayBase Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl
typedef internal::traits
< Derived >::StorageKind 		StorageKind
typedef internal::traits
< Derived >::Index 		Index
typedef internal::traits
< Derived >::Scalar 		Scalar
typedef
internal::packet_traits
< Scalar >::type 		PacketScalar
typedef NumTraits< Scalar >::Real RealScalar
typedef DenseBase< Derived > Base
typedef Base::CoeffReturnType CoeffReturnType
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 > 		PlainObject
typedef CwiseNullaryOp
< internal::scalar_constant_op
< Scalar >, Derived > 		ConstantReturnType
typedef CwiseUnaryOp
< internal::scalar_multiple_op
< Scalar >, const Derived > 		ScalarMultipleReturnType
typedef CwiseUnaryOp
< internal::scalar_quotient1_op
< Scalar >, const Derived > 		ScalarQuotient1ReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, const
CwiseUnaryOp
< internal::scalar_conjugate_op
< Scalar >, const Derived >
, const Derived & >::type 		ConjugateReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, const
CwiseUnaryOp
< internal::scalar_real_op
< Scalar >, const Derived >
, const Derived & >::type 		RealReturnType
typedef internal::conditional
< NumTraits< Scalar >
::IsComplex, CwiseUnaryView
< internal::scalar_real_ref_op
< Scalar >, Derived >, Derived & >
::type 		NonConstRealReturnType
typedef CwiseUnaryOp
< internal::scalar_imag_op
< Scalar >, const Derived > 		ImagReturnType
typedef CwiseUnaryView
< internal::scalar_imag_ref_op
< Scalar >, Derived > 		NonConstImagReturnType

Public Member Functions

const CwiseUnaryOp
< internal::scalar_opposite_op
< typename internal::traits
< Derived >::Scalar >, const
Derived > 		operator- () const
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
const CwiseUnaryOp
< internal::scalar_quotient1_op
< typename internal::traits
< Derived >::Scalar >, const
Derived > 		operator/ (const Scalar &scalar) const
const CwiseUnaryOp
< internal::scalar_multiple2_op
< Scalar, std::complex< Scalar >
>, const Derived > 		operator* (const std::complex< Scalar > &scalar) const
template<typename NewType >
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
const ImagReturnType imag () const
template<typename CustomUnaryOp >
const CwiseUnaryOp
< CustomUnaryOp, const Derived > 		unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise.
template<typename CustomViewOp >
const CwiseUnaryView
< CustomViewOp, const Derived > 		unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
NonConstRealReturnType real ()
NonConstImagReturnType imag ()
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
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
template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp< CustomBinaryOp,
const Derived, const
OtherDerived > 		binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
const CwiseBinaryOp
< std::equal_to< Scalar >
, const Derived, const
OtherDerived > 		cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
const CwiseBinaryOp
< std::not_equal_to< Scalar >
, const Derived, const
OtherDerived > 		cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_min_op
< Scalar >, const Derived,
const OtherDerived > 		cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_max_op
< Scalar >, const Derived,
const OtherDerived > 		cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar >, const Derived,
const OtherDerived > 		cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) operator*(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_STRONG_INLINE const
CwiseBinaryOp
< internal::scalar_quotient_op
< Scalar >, const Derived,
const OtherDerived > 		operator/ (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseUnaryOp
< internal::scalar_add_op
< Scalar >, const Derived > 		operator+ (const Scalar &scalar) const
const CwiseUnaryOp
< internal::scalar_add_op
< Scalar >, const Derived > 		operator- (const Scalar &scalar) const
Derived & operator= (const ArrayBase &other)
Derived & operator+= (const Scalar &scalar)
Derived & operator-= (const Scalar &scalar)
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)
ArrayBase< Derived > & array ()
const ArrayBase< Derived > & array () const
MatrixWrapper< Derived > matrix ()
const MatrixWrapper< Derived > matrix () const

Protected Member Functions

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

Friends

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

Detailed Description

template<typename Derived>
class ArrayBase< Derived >

Base class for all 1D and 2D array, and related expressions.

An array is similar to a dense vector or matrix. While matrices are mathematical objects with well defined linear algebra operators, an array is just a collection of scalar values arranged in a one or two dimensionnal fashion. As the main consequence, all operations applied to an array are performed coefficient wise. Furthermore, arrays support scalar math functions of the c++ standard library (e.g., std::sin(x)), and convenient constructors allowing to easily write generic code working for both scalar values and arrays.

This class is the base that is inherited by all array expression types.

Template Parameters:
Derived is the derived type, e.g., an array or an expression type.

This class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_ARRAYBASE_PLUGIN.

See also:
class MatrixBase, TopicClassHierarchy

Member Typedef Documentation

template<typename Derived>
typedef DenseBase<Derived> ArrayBase< Derived >::Base

Reimplemented from DenseBase< Derived >.

Reimplemented in ArrayWrapper< ExpressionType >.

template<typename Derived>
typedef Base::CoeffReturnType ArrayBase< Derived >::CoeffReturnType

Reimplemented from DenseBase< Derived >.

template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>, const Derived& >::type ArrayBase< Derived >::ConjugateReturnType
template<typename Derived>
typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>,Derived> ArrayBase< Derived >::ConstantReturnType

Reimplemented from DenseBase< Derived >.

template<typename Derived>
typedef ArrayBase ArrayBase< Derived >::Eigen_BaseClassForSpecializationOfGlobalMathFuncImpl
template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived> ArrayBase< Derived >::ImagReturnType
template<typename Derived>
typedef internal::traits<Derived>::Index ArrayBase< Derived >::Index

The type of indices

Reimplemented from DenseBase< Derived >.

template<typename Derived>
typedef CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived> ArrayBase< Derived >::NonConstImagReturnType
template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>, Derived& >::type ArrayBase< Derived >::NonConstRealReturnType
template<typename Derived>
typedef internal::packet_traits<Scalar>::type ArrayBase< Derived >::PacketScalar

Reimplemented from DenseBase< Derived >.

template<typename Derived>
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 > ArrayBase< Derived >::PlainObject
template<typename Derived>
typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>, const Derived& >::type ArrayBase< Derived >::RealReturnType
template<typename Derived>
typedef NumTraits<Scalar>::Real ArrayBase< Derived >::RealScalar

Reimplemented from DenseBase< Derived >.

template<typename Derived>
typedef internal::traits<Derived>::Scalar ArrayBase< Derived >::Scalar

Reimplemented from DenseBase< Derived >.

template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_multiple_op<Scalar>, const Derived> ArrayBase< Derived >::ScalarMultipleReturnType
template<typename Derived>
typedef CwiseUnaryOp<internal::scalar_quotient1_op<Scalar>, const Derived> ArrayBase< Derived >::ScalarQuotient1ReturnType
template<typename Derived>
typedef ArrayBase ArrayBase< Derived >::StorageBaseType

The base class for a given storage type.

template<typename Derived>
typedef internal::traits<Derived>::StorageKind ArrayBase< Derived >::StorageKind

Reimplemented from DenseBase< Derived >.

Constructor & Destructor Documentation

template<typename Derived>
ArrayBase< Derived >::ArrayBase (  )  [inline, protected]

Member Function Documentation

template<typename Derived>
EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> ArrayBase< Derived >::abs (  )  const [inline]
Returns:
an expression of the coefficient-wise absolute value of *this

Example: 

 Output: 


See also:
abs2() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
abs(), square() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
cos(), asin() 













template<typename Derived> 

      

        

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

      

















template<typename Derived> 

      

        

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

      

















template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
sin(), acos() 













template<typename Derived> 



template<typename CustomBinaryOp , typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> ArrayBase< Derived >::binaryExpr 
          (
          const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & 
           other, 
        

        

          
          
          const CustomBinaryOp & 
           func = CustomBinaryOp() 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 



template<typename NewType > 

      

        

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

      






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 













template<typename Derived> 

      

        

          ConjugateReturnType ArrayBase< Derived >::conjugate 
          (
          
           ) 
           const [inline]
        

      






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


See also:
adjoint() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
sin(), acos() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
square(), pow() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
cwiseAbs2() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
cwiseAbs() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      






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













template<typename Derived> 

      

        

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

      






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 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
cwiseProduct() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      






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


Example: 


 Output: 


See also:
class CwiseBinaryOp, min() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      






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


Example: 


 Output: 


See also:
class CwiseBinaryOp, max() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      






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













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      






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


Example: 


 Output: 


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













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
cwisePow(), cwiseSquare() 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE const ArrayBase< Derived >::EIGEN_CWISE_PRODUCT_RETURN_TYPE 
          (
          Derived 
          , 
        

        

          
          
          OtherDerived 
           
        

        

          
          )
           const [inline]
        

      






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


Example: 


 Output: 


See also:
class CwiseBinaryOp, cwiseAbs2 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE const ArrayBase< Derived >::EIGEN_CWISE_PRODUCT_RETURN_TYPE 
          (
          Derived 
          , 
        

        

          
          
          OtherDerived 
           
        

        

          
          )
           const [inline]
        

      






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


See also:
MatrixBase::cwiseProduct 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


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













template<typename Derived> 

      

        

          const ImagReturnType ArrayBase< Derived >::imag 
          (
          
           ) 
           const [inline]
        

      






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


See also:
real() 













template<typename Derived> 

      

        

          NonConstImagReturnType ArrayBase< Derived >::imag 
          (
          
           ) 
           [inline]
        

      






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


See also:
real() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


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













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
exp() 













template<typename Derived> 

      

        

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

      

















template<typename Derived> 

      

        

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

      






Returns:
an Matrix  expression of this array 


See also:
MatrixBase::array() 













template<typename Derived> 

      

        

          const ScalarMultipleReturnType ArrayBase< Derived >::operator* 
          (
          const Scalar & 
           scalar
           ) 
           const [inline]
        

      






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













template<typename Derived> 

      

        

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

      






Overloaded for efficient real matrix times complex scalar value 













template<typename Derived > 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE Derived & ArrayBase< Derived >::operator*= 
          (
          const ArrayBase< OtherDerived > & 
           other
           ) 
          
        

      






replaces *this by *this * other coefficient wise.


Returns:
a reference to *this 













template<typename Derived> 

      

        

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

      






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













template<typename Derived> 

      

        

          Derived& ArrayBase< Derived >::operator+= 
          (
          const Scalar & 
           scalar
           ) 
           [inline]
        

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE Derived & ArrayBase< Derived >::operator+= 
          (
          const ArrayBase< OtherDerived > & 
           other
           ) 
          
        

      






replaces *this by *this + other.


Returns:
a reference to *this 













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived> 

      

        

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

      






Returns:
an expression of the opposite of *this 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


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













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE Derived & ArrayBase< Derived >::operator-= 
          (
          const ArrayBase< OtherDerived > & 
           other
           ) 
          
        

      






replaces *this by *this - other.


Returns:
a reference to *this 













template<typename Derived> 

      

        

          Derived& ArrayBase< Derived >::operator-= 
          (
          const Scalar & 
           scalar
           ) 
           [inline]
        

      

















template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      






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


See also:
MatrixBase::cwiseQuotient 













template<typename Derived> 

      

        

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

      






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













template<typename Derived > 



template<typename OtherDerived > 

      

        

          EIGEN_STRONG_INLINE Derived & ArrayBase< Derived >::operator/= 
          (
          const ArrayBase< OtherDerived > & 
           other
           ) 
          
        

      






replaces *this by *this / other coefficient wise.


Returns:
a reference to *this 













template<typename Derived> 

      

        

          Derived& ArrayBase< Derived >::operator= 
          (
          const ArrayBase< Derived > & 
           other
           ) 
           [inline]
        

      






Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1) 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
exp(), log() 













template<typename Derived> 

      

        

          RealReturnType ArrayBase< Derived >::real 
          (
          
           ) 
           const [inline]
        

      






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


See also:
imag() 













template<typename Derived> 

      

        

          NonConstRealReturnType ArrayBase< Derived >::real 
          (
          
           ) 
           [inline]
        

      






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


See also:
imag() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
cos(), asin() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
pow(), square() 













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


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













template<typename Derived> 

      

        

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

      






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


Example: 


 Output: 


See also:
cos(), sin() 













template<typename Derived> 



template<typename CustomUnaryOp > 

      

        

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

      







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 













template<typename Derived> 



template<typename CustomViewOp > 

      

        

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

      






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 







Friends And Related Function Documentation








template<typename Derived> 

      

        

          const ScalarMultipleReturnType operator* 
          (
          const Scalar & 
           scalar, 
        

        

          
          
          const StorageBaseType & 
           matrix 
        

        

          
          )
           [friend]
        

      

















template<typename Derived> 

      

        

          const CwiseUnaryOp<internal::scalar_multiple2_op<Scalar,std::complex<Scalar> >, const Derived> operator* 
          (
          const std::complex< Scalar > & 
           scalar, 
        

        

          
          
          const StorageBaseType & 
           matrix 
        

        

          
          )
           [friend]
        

      

















template<typename Derived> 

      

        

          const CwiseUnaryOp<internal::scalar_add_op<Scalar>, const Derived> operator+ 
          (
          const Scalar & 
           scalar, 
        

        

          
          
          const EIGEN_CURRENT_STORAGE_BASE_CLASS< Derived > & 
           other 
        

        

          
          )
           [friend]
        

      

















template<typename Derived> 

      

        

          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]
        

      











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



Generated on Thu Dec 1 2011 12:54:10 for HUMIM Tracker by 

doxygen 1.7.1