WPILibC++ 2023.4.3
Eigen::Product< _Lhs, _Rhs, Option > Class Template Reference

Expression of the product of two arbitrary matrices or vectors. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/Product.h>

Inheritance diagram for Eigen::Product< _Lhs, _Rhs, Option >:
Eigen::ProductImpl< _Lhs, _Rhs, Option, internal::product_promote_storage_type< internal::traits< _Lhs >::StorageKind, internal::traits< _Rhs >::StorageKind, internal::product_type< _Lhs, _Rhs >::ret >::ret >

Public Types

typedef _Lhs Lhs
 
typedef _Rhs Rhs
 
typedef ProductImpl< Lhs, Rhs, Option, typenameinternal::product_promote_storage_type< typenameinternal::traits< Lhs >::StorageKind, typenameinternal::traits< Rhs >::StorageKind, internal::product_type< Lhs, Rhs >::ret >::ret >::Base Base
 
typedef internal::ref_selector< Lhs >::type LhsNested
 
typedef internal::ref_selector< Rhs >::type RhsNested
 
typedef internal::remove_all< LhsNested >::type LhsNestedCleaned
 
typedef internal::remove_all< RhsNested >::type RhsNestedCleaned
 
- Public Types inherited from Eigen::ProductImpl< _Lhs, _Rhs, Option, internal::product_promote_storage_type< internal::traits< _Lhs >::StorageKind, internal::traits< _Rhs >::StorageKind, internal::product_type< _Lhs, _Rhs >::ret >::ret >
typedef internal::generic_xpr_base< Product< _Lhs, _Rhs, Option >, MatrixXpr, internal::product_promote_storage_type< internal::traits< _Lhs >::StorageKind, internal::traits< _Rhs >::StorageKind, internal::product_type< _Lhs, _Rhs >::ret >::ret >::type Base
 

Public Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Product (const Lhs &lhs, const Rhs &rhs)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const LhsNestedCleanedlhs () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const RhsNestedCleanedrhs () const
 

Protected Attributes

LhsNested m_lhs
 
RhsNested m_rhs
 

Detailed Description

template<typename _Lhs, typename _Rhs, int Option>
class Eigen::Product< _Lhs, _Rhs, Option >

Expression of the product of two arbitrary matrices or vectors.

Template Parameters
_Lhsthe type of the left-hand side expression
_Rhsthe type of the right-hand side expression

This class represents an expression of the product of two arbitrary matrices.

The other template parameters are:

Template Parameters
Optioncan be DefaultProduct, AliasFreeProduct, or LazyProduct

Member Typedef Documentation

◆ Base

template<typename _Lhs , typename _Rhs , int Option>
typedef ProductImpl<Lhs,Rhs,Option,typenameinternal::product_promote_storage_type<typenameinternal::traits<Lhs>::StorageKind,typenameinternal::traits<Rhs>::StorageKind,internal::product_type<Lhs,Rhs>::ret>::ret>::Base Eigen::Product< _Lhs, _Rhs, Option >::Base

◆ Lhs

template<typename _Lhs , typename _Rhs , int Option>
typedef _Lhs Eigen::Product< _Lhs, _Rhs, Option >::Lhs

◆ LhsNested

template<typename _Lhs , typename _Rhs , int Option>
typedef internal::ref_selector<Lhs>::type Eigen::Product< _Lhs, _Rhs, Option >::LhsNested

◆ LhsNestedCleaned

template<typename _Lhs , typename _Rhs , int Option>
typedef internal::remove_all<LhsNested>::type Eigen::Product< _Lhs, _Rhs, Option >::LhsNestedCleaned

◆ Rhs

template<typename _Lhs , typename _Rhs , int Option>
typedef _Rhs Eigen::Product< _Lhs, _Rhs, Option >::Rhs

◆ RhsNested

template<typename _Lhs , typename _Rhs , int Option>
typedef internal::ref_selector<Rhs>::type Eigen::Product< _Lhs, _Rhs, Option >::RhsNested

◆ RhsNestedCleaned

template<typename _Lhs , typename _Rhs , int Option>
typedef internal::remove_all<RhsNested>::type Eigen::Product< _Lhs, _Rhs, Option >::RhsNestedCleaned

Constructor & Destructor Documentation

◆ Product()

template<typename _Lhs , typename _Rhs , int Option>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::Product< _Lhs, _Rhs, Option >::Product ( const Lhs lhs,
const Rhs rhs 
)
inline

Member Function Documentation

◆ cols()

template<typename _Lhs , typename _Rhs , int Option>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::Product< _Lhs, _Rhs, Option >::cols ( void  ) const
inline

◆ lhs()

template<typename _Lhs , typename _Rhs , int Option>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const LhsNestedCleaned & Eigen::Product< _Lhs, _Rhs, Option >::lhs ( ) const
inline

◆ rhs()

template<typename _Lhs , typename _Rhs , int Option>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const RhsNestedCleaned & Eigen::Product< _Lhs, _Rhs, Option >::rhs ( ) const
inline

◆ rows()

template<typename _Lhs , typename _Rhs , int Option>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::Product< _Lhs, _Rhs, Option >::rows ( void  ) const
inline

Member Data Documentation

◆ m_lhs

template<typename _Lhs , typename _Rhs , int Option>
LhsNested Eigen::Product< _Lhs, _Rhs, Option >::m_lhs
protected

◆ m_rhs

template<typename _Lhs , typename _Rhs , int Option>
RhsNested Eigen::Product< _Lhs, _Rhs, Option >::m_rhs
protected

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