Typedefs | Functions
CommonCwiseUnaryOps.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const Derived >, const Derived &>::type ConjugateReturnType
 
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const Derived > ImagReturnType
 
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, Derived > NonConstImagReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, Derived >, Derived &>::type NonConstRealReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const Derived >, const Derived &>::type RealReturnType
 
typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const Derived > ScalarMultipleReturnType
 
typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const Derived > ScalarQuotient1ReturnType
 

Functions

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
 
const ImagReturnType imag () const
 
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
 
const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const Derived > operator* (const std::complex< Scalar > &scalar) const
 
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_opposite_op< typename internal::traits< Derived >::Scalar >, const Derived > operator- () const
 
const CwiseUnaryOp< internal::scalar_quotient1_op< typename internal::traits< Derived >::Scalar >, const Derived > operator/ (const Scalar &scalar) const
 
RealReturnType real () 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
 

Typedef Documentation

◆ ConjugateReturnType

typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>, const Derived& >::type ConjugateReturnType

Definition at line 23 of file CommonCwiseUnaryOps.h.

◆ ImagReturnType

typedef CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived> ImagReturnType

Definition at line 35 of file CommonCwiseUnaryOps.h.

◆ NonConstImagReturnType

typedef CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived> NonConstImagReturnType

Definition at line 37 of file CommonCwiseUnaryOps.h.

◆ NonConstRealReturnType

typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>, Derived& >::type NonConstRealReturnType

Definition at line 33 of file CommonCwiseUnaryOps.h.

◆ RealReturnType

typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>, const Derived& >::type RealReturnType

Definition at line 28 of file CommonCwiseUnaryOps.h.

◆ ScalarMultipleReturnType

typedef CwiseUnaryOp<internal::scalar_multiple_op<Scalar>, const Derived> ScalarMultipleReturnType

Definition at line 16 of file CommonCwiseUnaryOps.h.

◆ ScalarQuotient1ReturnType

typedef CwiseUnaryOp<internal::scalar_quotient1_op<Scalar>, const Derived> ScalarQuotient1ReturnType

Definition at line 18 of file CommonCwiseUnaryOps.h.

Function Documentation

◆ cast()

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
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 92 of file CommonCwiseUnaryOps.h.

◆ conjugate()

ConjugateReturnType conjugate ( ) const
inline
Returns
an expression of the complex conjugate of *this.
See also
adjoint()

Definition at line 101 of file CommonCwiseUnaryOps.h.

◆ imag()

NonConstImagReturnType imag ( ) const
inline
Returns
an read-only expression of the imaginary part of *this.
See also
real()
Returns
a non const expression of the imaginary part of *this.
See also
real()

Definition at line 116 of file CommonCwiseUnaryOps.h.

◆ operator*() [1/4]

const ScalarMultipleReturnType operator* ( const Scalar &  scalar) const
inline
Returns
an expression of *this scaled by the scalar factor scalar

Definition at line 49 of file CommonCwiseUnaryOps.h.

◆ operator*() [2/4]

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

Overloaded for efficient real matrix times complex scalar value

Definition at line 69 of file CommonCwiseUnaryOps.h.

◆ operator*() [3/4]

friend const ScalarMultipleReturnType operator* ( const Scalar &  scalar,
const StorageBaseType &  matrix 
)
inline

Definition at line 76 of file CommonCwiseUnaryOps.h.

◆ operator*() [4/4]

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

Definition at line 80 of file CommonCwiseUnaryOps.h.

◆ operator-()

const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<Derived>::Scalar>, const Derived> operator- ( ) const
inline
Returns
an expression of the opposite of *this

Definition at line 44 of file CommonCwiseUnaryOps.h.

◆ operator/()

const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>, const Derived> operator/ ( const Scalar &  scalar) const
inline
Returns
an expression of *this divided by the scalar value scalar

Definition at line 61 of file CommonCwiseUnaryOps.h.

◆ real()

NonConstRealReturnType real ( ) const
inline
Returns
a read-only expression of the real part of *this.
See also
imag()
Returns
a non const expression of the real part of *this.
See also
imag()

Definition at line 110 of file CommonCwiseUnaryOps.h.

◆ unaryExpr()

template<typename CustomUnaryOp >
const CwiseUnaryOp<CustomUnaryOp, const Derived> unaryExpr ( const CustomUnaryOp &  func = CustomUnaryOp()) const
inline

Apply a unary operator coefficient-wise.

Parameters
[in]funcFunctor implementing the unary operator
Template Parameters
CustomUnaryOpType 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 139 of file CommonCwiseUnaryOps.h.








◆ unaryViewExpr()








template<typename CustomViewOp > 



  

  
      

        

          const CwiseUnaryView<CustomViewOp, const 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 



Definition at line 157 of file CommonCwiseUnaryOps.h.













tuw_aruco

Author(s): Lukas Pfeifhofer

autogenerated on Mon Feb 28 2022 23:58:06