Cwise< ExpressionType > Class Template Reference

Pseudo expression providing additional coefficient-wise operations. More...

#include <Cwise.h>

List of all members.

Public Types

typedef ei_meta_if
< ei_must_nest_by_value
< ExpressionType >::ret,
ExpressionType, const
ExpressionType & >::ret 
ExpressionTypeNested
typedef ei_traits
< ExpressionType >::Scalar 
Scalar
typedef CwiseUnaryOp
< ei_scalar_add_op< Scalar >
, ExpressionType > 
ScalarAddReturnType

Public Member Functions

const ExpressionType & _expression () const
 Cwise (const ExpressionType &matrix)
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (std::not_equal_to) operator!
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (std::equal_to) operator
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (std::greater_equal) operator>
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (std::greater) operator>(const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (std::less_equal) operator<
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (std::less) operator<(const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (ei_scalar_max_op) max(const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (ei_scalar_min_op) min(const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
const EIGEN_CWISE_BINOP_RETURN_TYPE (ei_scalar_quotient_op) operator/(const MatrixBase< OtherDerived > &other) const
const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE (std::not_equal_to) operator!
const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE (std::equal_to) operator
const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE (std::greater_equal) operator>
const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE (std::greater) operator>(Scalar s) const
const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE (std::less_equal) operator<
const EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE (std::less) operator<(Scalar s) const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_pow_op) pow(const Scalar &exponent) const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_sin_op) sin() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_cos_op) cos() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_log_op) log() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_exp_op) exp() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_sqrt_op) sqrt() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_inverse_op) inverse() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_cube_op) cube() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_square_op) square() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_abs2_op) abs2() const
const EIGEN_CWISE_UNOP_RETURN_TYPE (ei_scalar_abs_op) abs() const
template<typename OtherDerived >
const
EIGEN_CWISE_PRODUCT_RETURN_TYPE 
operator* (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
ExpressionType & operator*= (const MatrixBase< OtherDerived > &other)
const ScalarAddReturnType operator+ (const Scalar &scalar) const
ExpressionType & operator+= (const Scalar &scalar)
const ScalarAddReturnType operator- (const Scalar &scalar) const
ExpressionType & operator-= (const Scalar &scalar)
template<typename OtherDerived >
ExpressionType & operator/= (const MatrixBase< OtherDerived > &other)

Protected Attributes

ExpressionTypeNested m_matrix

Private Member Functions

Cwiseoperator= (const Cwise &)

Related Functions

(Note that these are not member functions.)



const ScalarAddReturnType operator+ (const Scalar &scalar, const Cwise &mat)

Detailed Description

template<typename ExpressionType>
class Cwise< ExpressionType >

Pseudo expression providing additional coefficient-wise operations.

Parameters:
ExpressionType the type of the object on which to do coefficient-wise operations

This class represents an expression with additional coefficient-wise features. It is the return type of MatrixBase::cwise() and most of the time this is the only way it is used.

Note that some methods are defined in the Array module.

Example:

Output:

See also:
MatrixBase::cwise() const, MatrixBase::cwise()

Definition at line 74 of file Cwise.h.


Member Typedef Documentation

template<typename ExpressionType>
typedef ei_meta_if<ei_must_nest_by_value<ExpressionType>::ret, ExpressionType, const ExpressionType&>::ret Cwise< ExpressionType >::ExpressionTypeNested

Definition at line 80 of file Cwise.h.

template<typename ExpressionType>
typedef ei_traits<ExpressionType>::Scalar Cwise< ExpressionType >::Scalar

Definition at line 78 of file Cwise.h.

template<typename ExpressionType>
typedef CwiseUnaryOp<ei_scalar_add_op<Scalar>, ExpressionType> Cwise< ExpressionType >::ScalarAddReturnType

Definition at line 81 of file Cwise.h.


Constructor & Destructor Documentation

template<typename ExpressionType>
Cwise< ExpressionType >::Cwise ( const ExpressionType &  matrix  )  [inline]

Definition at line 83 of file Cwise.h.


Member Function Documentation

template<typename ExpressionType>
const ExpressionType& Cwise< ExpressionType >::_expression (  )  const [inline]

Definition at line 86 of file Cwise.h.

template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( std::not_equal_to   )  [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( std::equal_to   )  [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( std::greater_equal   )  [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( std::greater   )  const [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( std::less_equal   )  [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( std::less   )  const [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( ei_scalar_max_op   )  const [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( ei_scalar_min_op   )  const [inline]
template<typename ExpressionType>
template<typename OtherDerived >
const Cwise< ExpressionType >::EIGEN_CWISE_BINOP_RETURN_TYPE ( ei_scalar_quotient_op   )  const [inline]
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE ( std::not_equal_to   ) 
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE ( std::equal_to   ) 
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE ( std::greater_equal   ) 
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE ( std::greater   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE ( std::less_equal   ) 
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_COMP_TO_SCALAR_RETURN_TYPE ( std::less   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_pow_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_sin_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_cos_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_log_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_exp_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_sqrt_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_inverse_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_cube_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_square_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_abs2_op   )  const
template<typename ExpressionType>
const Cwise< ExpressionType >::EIGEN_CWISE_UNOP_RETURN_TYPE ( ei_scalar_abs_op   )  const
template<typename ExpressionType >
template<typename OtherDerived >
EIGEN_STRONG_INLINE const EIGEN_CWISE_PRODUCT_RETURN_TYPE Cwise< ExpressionType >::operator* ( const MatrixBase< OtherDerived > &  other  )  const [inline]
Returns:
an expression of the Schur product (coefficient wise product) of *this and other

Example:

Output:

See also:
class CwiseBinaryOp, operator/(), square()

Definition at line 205 of file CwiseBinaryOp.h.

template<typename ExpressionType >
template<typename OtherDerived >
ExpressionType & Cwise< ExpressionType >::operator*= ( const MatrixBase< OtherDerived > &  other  )  [inline]

Replaces this expression by its coefficient-wise product with other.

Example:

Output:

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

Definition at line 234 of file CwiseBinaryOp.h.

template<typename ExpressionType >
const Cwise< ExpressionType >::ScalarAddReturnType Cwise< ExpressionType >::operator+ ( const Scalar scalar  )  const [inline]
Returns:
an expression of *this with each coeff incremented by the constant scalar

Example:

Output:

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

Definition at line 401 of file CwiseOperators.h.

template<typename ExpressionType >
ExpressionType & Cwise< ExpressionType >::operator+= ( const Scalar scalar  )  [inline]

Adds the given scalar to each coeff of this expression.

Example:

Output:

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

Definition at line 416 of file CwiseOperators.h.

template<typename ExpressionType >
const Cwise< ExpressionType >::ScalarAddReturnType Cwise< ExpressionType >::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-=()

Definition at line 432 of file CwiseOperators.h.

template<typename ExpressionType >
ExpressionType & Cwise< ExpressionType >::operator-= ( const Scalar scalar  )  [inline]

Substracts the given scalar from each coeff of this expression.

Example:

Output:

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

Definition at line 448 of file CwiseOperators.h.

template<typename ExpressionType >
template<typename OtherDerived >
ExpressionType & Cwise< ExpressionType >::operator/= ( const MatrixBase< OtherDerived > &  other  )  [inline]

Replaces this expression by its coefficient-wise quotient by other.

Example:

Output:

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

Definition at line 248 of file CwiseBinaryOp.h.

template<typename ExpressionType>
Cwise& Cwise< ExpressionType >::operator= ( const Cwise< ExpressionType > &   )  [private]

Friends And Related Function Documentation

template<typename ExpressionType>
const ScalarAddReturnType operator+ ( const Scalar scalar,
const Cwise< ExpressionType > &  mat 
) [friend]

Definition at line 121 of file Cwise.h.


Member Data Documentation

template<typename ExpressionType>
ExpressionTypeNested Cwise< ExpressionType >::m_matrix [protected]

Definition at line 180 of file Cwise.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


vcglib
Author(s): Christian Bersch
autogenerated on Fri Jan 11 09:21:59 2013