Proxy for the matrix function of some matrix (expression). More...

#include <MatrixFunction.h>

Inheritance diagram for Eigen::MatrixFunctionReturnValue< Derived >:

Public Types
typedef Derived::Scalar	Scalar

typedef internal::stem_function< Scalar >::type	StemFunction

Public Types inherited from Eigen::ReturnByValue< MatrixFunctionReturnValue< Derived > >
typedef internal::traits< MatrixFunctionReturnValue< Derived > >::ReturnType	ReturnType

typedef internal::dense_xpr_base< ReturnByValue >::type	Base

Public Member Functions
	MatrixFunctionReturnValue (const Derived &A, StemFunction f)
	Constructor. More...

template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix function. More...

Index	rows () const

Index	cols () const

Public Member Functions inherited from Eigen::ReturnByValue< MatrixFunctionReturnValue< Derived > >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

const Unusable &	coeff (Index) const

const Unusable &	coeff (Index, Index) const

Unusable &	coeffRef (Index)

Unusable &	coeffRef (Index, Index)

Protected Types
typedef internal::ref_selector< Derived >::type	DerivedNested

Private Attributes
const DerivedNested	m_A

StemFunction *	m_f

Detailed Description

template<typename Derived>
class Eigen::MatrixFunctionReturnValue< Derived >

Proxy for the matrix function of some matrix (expression).

Template Parameters

Derived Type of the argument to the matrix function.

This class holds the argument to the matrix function until it is assigned or evaluated for some other reason (so the argument should not be changed in the meantime). It is the return type of matrixBase::matrixFunction() and related functions and most of the time this is the only way it is used.

Member Typedef Documentation

◆ DerivedNested

template<typename Derived >

typedef internal::ref_selector<Derived>::type Eigen::MatrixFunctionReturnValue< Derived >::DerivedNested

protected

◆ Scalar

template<typename Derived >

typedef Derived::Scalar Eigen::MatrixFunctionReturnValue< Derived >::Scalar

◆ StemFunction

template<typename Derived >

typedef internal::stem_function<Scalar>::type Eigen::MatrixFunctionReturnValue< Derived >::StemFunction

Constructor & Destructor Documentation

◆ MatrixFunctionReturnValue()

template<typename Derived >

Eigen::MatrixFunctionReturnValue< Derived >::MatrixFunctionReturnValue	(	const Derived &	A,
		StemFunction	f
	)

inline

Constructor.

Parameters

[in]	A	Matrix (expression) forming the argument of the matrix function.
[in]	f	Stem function for matrix function under consideration.

468 : m_A(A), m_f(f) {}

A

Matrix< SCALARA, Dynamic, Dynamic, opt_A > A

Definition: bench_gemm.cpp:47

Eigen::MatrixFunctionReturnValue::m_f

StemFunction * m_f

Definition: MatrixFunction.h:494

Eigen::MatrixFunctionReturnValue::m_A

const DerivedNested m_A

Definition: MatrixFunction.h:493

f

static int f(const TensorMap< Tensor< int, 3 > > &tensor)

Definition: cxx11_tensor_map.cpp:237

Member Function Documentation

◆ cols()

template<typename Derived >

Index Eigen::MatrixFunctionReturnValue< Derived >::cols ( ) const

inline

490 { return m_A.cols(); }

References Eigen::MatrixFunctionReturnValue< Derived >::m_A.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

◆ evalTo()

template<typename Derived >

template<typename ResultType >

void Eigen::MatrixFunctionReturnValue< Derived >::evalTo ( ResultType & result ) const

inline

Compute the matrix function.

Parameters

[out] result f applied to A, where f and A are as in the constructor.

                                                {
     typedef typename internal::nested_eval<Derived, 10>::type NestedEvalType;
     typedef internal::remove_all_t<NestedEvalType> NestedEvalTypeClean;
     typedef internal::traits<NestedEvalTypeClean> Traits;
     typedef std::complex<typename NumTraits<Scalar>::Real> ComplexScalar;
     typedef Matrix<ComplexScalar, Dynamic, Dynamic, 0, Traits::RowsAtCompileTime, Traits::ColsAtCompileTime>
         DynMatrixType;
  
     typedef internal::MatrixFunctionAtomic<DynMatrixType> AtomicType;
     AtomicType atomic(m_f);
  
     internal::matrix_function_compute<typename NestedEvalTypeClean::PlainObject>::run(m_A, atomic, result);
   }