Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType > Class Template Reference
+ Inheritance diagram for Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >:

Public Types

typedef internal::gebp_traits< typename LhsXprType::CoeffReturnType, typename RhsXprType::CoeffReturnType >::ResScalar CoeffReturnType
 
typedef Eigen::internal::traits< TensorContractionOp >::Index Index
 
typedef Eigen::internal::nested< TensorContractionOp >::type Nested
 
typedef Eigen::internal::traits< TensorContractionOp >::Scalar Scalar
 
typedef Eigen::internal::traits< TensorContractionOp >::StorageKind StorageKind
 

Public Member Functions

const Indices & indices () const
 
const internal::remove_all_t< typename LhsXprType::Nested > & lhsExpression () const
 
const OutputKernelType & outputKernel () const
 
const internal::remove_all_t< typename RhsXprType::Nested > & rhsExpression () const
 
 TensorContractionOp (const LhsXprType &lhs, const RhsXprType &rhs, const Indices &dims, const OutputKernelType &output_kernel=OutputKernelType())
 

Protected Attributes

const Indices m_indices
 
LhsXprType::Nested m_lhs_xpr
 
const OutputKernelType m_output_kernel
 
RhsXprType::Nested m_rhs_xpr
 

Detailed Description

template<typename Indices, typename LhsXprType, typename RhsXprType, typename OutputKernelType = const NoOpOutputKernel>
class Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >

Definition at line 326 of file TensorContraction.h.

Member Typedef Documentation

◆ CoeffReturnType

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
typedef internal::gebp_traits<typename LhsXprType::CoeffReturnType, typename RhsXprType::CoeffReturnType>::ResScalar Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::CoeffReturnType

Definition at line 331 of file TensorContraction.h.

◆ Index

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
typedef Eigen::internal::traits<TensorContractionOp>::Index Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::Index

Definition at line 334 of file TensorContraction.h.

◆ Nested

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
typedef Eigen::internal::nested<TensorContractionOp>::type Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::Nested

Definition at line 332 of file TensorContraction.h.

◆ Scalar

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
typedef Eigen::internal::traits<TensorContractionOp>::Scalar Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::Scalar

Definition at line 329 of file TensorContraction.h.

◆ StorageKind

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
typedef Eigen::internal::traits<TensorContractionOp>::StorageKind Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::StorageKind

Definition at line 333 of file TensorContraction.h.

Constructor & Destructor Documentation

◆ TensorContractionOp()

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::TensorContractionOp ( const LhsXprType &  lhs,
const RhsXprType &  rhs,
const Indices &  dims,
const OutputKernelType &  output_kernel = OutputKernelType() 
)
inline

Definition at line 336 of file TensorContraction.h.

339  : m_lhs_xpr(lhs), m_rhs_xpr(rhs), m_indices(dims),
340  m_output_kernel(output_kernel) {}
Eigen::TensorContractionOp::m_output_kernel
const OutputKernelType m_output_kernel
Definition: TensorContraction.h:361
Eigen::TensorContractionOp::m_lhs_xpr
LhsXprType::Nested m_lhs_xpr
Definition: TensorContraction.h:358
Eigen::TensorContractionOp::m_rhs_xpr
RhsXprType::Nested m_rhs_xpr
Definition: TensorContraction.h:359

Member Function Documentation

◆ indices()

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
const Indices& Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::indices ( ) const
inline

Definition at line 343 of file TensorContraction.h.

343 { return m_indices; }

◆ lhsExpression()

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
const internal::remove_all_t<typename LhsXprType::Nested>& Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::lhsExpression ( ) const
inline
Returns
the nested expressions

Definition at line 348 of file TensorContraction.h.

348 { return m_lhs_xpr; }

◆ outputKernel()

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
const OutputKernelType& Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::outputKernel ( ) const
inline

Definition at line 355 of file TensorContraction.h.

355 { return m_output_kernel; }

◆ rhsExpression()

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
const internal::remove_all_t<typename RhsXprType::Nested>& Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::rhsExpression ( ) const
inline

Definition at line 352 of file TensorContraction.h.

352 { return m_rhs_xpr; }

Member Data Documentation

◆ m_indices

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
const Indices Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::m_indices
protected

Definition at line 360 of file TensorContraction.h.

◆ m_lhs_xpr

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
LhsXprType::Nested Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::m_lhs_xpr
protected

Definition at line 358 of file TensorContraction.h.

◆ m_output_kernel

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
const OutputKernelType Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::m_output_kernel
protected

Definition at line 361 of file TensorContraction.h.

◆ m_rhs_xpr

template<typename Indices , typename LhsXprType , typename RhsXprType , typename OutputKernelType = const NoOpOutputKernel>
RhsXprType::Nested Eigen::TensorContractionOp< Indices, LhsXprType, RhsXprType, OutputKernelType >::m_rhs_xpr
protected

Definition at line 359 of file TensorContraction.h.

The documentation for this class was generated from the following file:
Generated on Tue Jul 18 2023 15:28:52 for Eigen-unsupported by Doxygen 1.9.1 and the doxyYoda theme. This is an unofficial themed variant maintained by Rohit Goswami, based on the official documentation.