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

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

#include <Product.h>

Inheritance diagram for Eigen::Product< _Lhs, _Rhs, Option >:

Collaboration diagram for Eigen::Product< _Lhs, _Rhs, Option >:

List of all members.

Public Types
typedef _Lhs	Lhs
typedef _Rhs	Rhs
typedef ProductImpl< Lhs, Rhs, Option, typename internal::product_promote_storage_type < typename internal::traits < Lhs >::StorageKind, typename internal::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 Member Functions
EIGEN_DEVICE_FUNC	Product (const Lhs &lhs, const Rhs &rhs)
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC const LhsNestedCleaned &	lhs () const
EIGEN_DEVICE_FUNC const RhsNestedCleaned &	rhs () 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:

_Lhs	the type of the left-hand side expression
_Rhs	the 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:

Option

can be DefaultProduct, AliasFreeProduct, or LazyProduct

Definition at line 104 of file Product.h.

---

Member Typedef Documentation

template<typename _Lhs, typename _Rhs, int Option>

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

Reimplemented 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 >.

Definition at line 118 of file Product.h.

template<typename _Lhs, typename _Rhs, int Option>

typedef _Lhs Eigen::Product< _Lhs, _Rhs, Option >::Lhs

Definition at line 111 of file Product.h.

template<typename _Lhs, typename _Rhs, int Option>

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

Definition at line 121 of file Product.h.

template<typename _Lhs, typename _Rhs, int Option>

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

Definition at line 123 of file Product.h.

template<typename _Lhs, typename _Rhs, int Option>

typedef _Rhs Eigen::Product< _Lhs, _Rhs, Option >::Rhs

Definition at line 112 of file Product.h.

template<typename _Lhs, typename _Rhs, int Option>

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

Definition at line 122 of file Product.h.

template<typename _Lhs, typename _Rhs, int Option>

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

Definition at line 124 of file Product.h.

---

Constructor & Destructor Documentation

template<typename _Lhs, typename _Rhs, int Option>

EIGEN_DEVICE_FUNC Eigen::Product< _Lhs, _Rhs, Option >::Product	(	const Lhs &	lhs,
		const Rhs &	rhs
	)		[inline]

Definition at line 126 of file Product.h.

                                                              : m_lhs(lhs), m_rhs(rhs)
    {
      eigen_assert(lhs.cols() == rhs.rows()
        && "invalid matrix product"
        && "if you wanted a coeff-wise or a dot product use the respective explicit functions");
    }

---

Member Function Documentation

template<typename _Lhs, typename _Rhs, int Option>

EIGEN_DEVICE_FUNC Index Eigen::Product< _Lhs, _Rhs, Option >::cols

(

void

)

const [inline]

Definition at line 134 of file Product.h.

{ return m_rhs.cols(); }

template<typename _Lhs, typename _Rhs, int Option>

EIGEN_DEVICE_FUNC const LhsNestedCleaned& Eigen::Product< _Lhs, _Rhs, Option >::lhs

(

)

const [inline]

Definition at line 136 of file Product.h.

{ return m_lhs; }

template<typename _Lhs, typename _Rhs, int Option>

EIGEN_DEVICE_FUNC const RhsNestedCleaned& Eigen::Product< _Lhs, _Rhs, Option >::rhs

(

)

const [inline]

Definition at line 137 of file Product.h.

{ return m_rhs; }

template<typename _Lhs, typename _Rhs, int Option>

EIGEN_DEVICE_FUNC Index Eigen::Product< _Lhs, _Rhs, Option >::rows

(

void

)

const [inline]

Definition at line 133 of file Product.h.

{ return m_lhs.rows(); }

---

Member Data Documentation

template<typename _Lhs, typename _Rhs, int Option>

LhsNested Eigen::Product< _Lhs, _Rhs, Option >::m_lhs [protected]

Definition at line 141 of file Product.h.

template<typename _Lhs, typename _Rhs, int Option>

RhsNested Eigen::Product< _Lhs, _Rhs, Option >::m_rhs [protected]

Definition at line 142 of file Product.h.

---

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

• Product.h