Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs > Struct Template Reference

#include <InnerProduct.h>

Public Types
using	Scalar = typename Func::result_type
using	Packet = typename find_inner_product_packet< Scalar, SizeAtCompileTime >::type

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	inner_product_evaluator (const Lhs &lhs, const Rhs &rhs, Func func=Func())
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	size () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar	coeff (Index index) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar	coeff (const Scalar &value, Index index) const
template<typename PacketType , int LhsMode = LhsAlignment, int RhsMode = RhsAlignment>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType	packet (Index index) const
template<typename PacketType , int LhsMode = LhsAlignment, int RhsMode = RhsAlignment>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType	packet (const PacketType &value, Index index) const

Public Attributes
const Func	m_func
const evaluator< Lhs >	m_lhs
const evaluator< Rhs >	m_rhs
const variable_if_dynamic< Index, SizeAtCompileTime >	m_size

Static Public Attributes
static constexpr int	LhsFlags = evaluator<Lhs>::Flags
static constexpr int	RhsFlags = evaluator<Rhs>::Flags
static constexpr int	SizeAtCompileTime = min_size_prefer_fixed(Lhs::SizeAtCompileTime, Rhs::SizeAtCompileTime)
static constexpr int	LhsAlignment = evaluator<Lhs>::Alignment
static constexpr int	RhsAlignment = evaluator<Rhs>::Alignment
static constexpr bool	Vectorize

Member Typedef Documentation

Packet

template<typename Func , typename Lhs , typename Rhs >

using Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::Packet = typename find_inner_product_packet<Scalar, SizeAtCompileTime>::type

Scalar

template<typename Func , typename Lhs , typename Rhs >

using Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::Scalar = typename Func::result_type

Constructor & Destructor Documentation

inner_product_evaluator()

template<typename Func , typename Lhs , typename Rhs >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::inner_product_evaluator ( const Lhs &  lhs, const Rhs &  rhs, Func  func = Func()  )

inlineexplicit

      : m_func(func), m_lhs(lhs), m_rhs(rhs), m_size(lhs.size()) {
    inner_product_assert<Lhs, Rhs>::run(lhs, rhs);
  }

References Eigen::internal::inner_product_assert< Lhs, Rhs >::run().

Member Function Documentation

coeff() [1/2]

template<typename Func , typename Lhs , typename Rhs >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::coeff ( const Scalar &  value, Index  index  ) const

inline

                                                                                             {
    return m_func.coeff(value, m_lhs.coeff(index), m_rhs.coeff(index));
  }

References Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_func, Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_lhs, Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_rhs, and Eigen::value.

coeff() [2/2]

template<typename Func , typename Lhs , typename Rhs >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::coeff ( Index  index ) const

inline

                                                                        {
    return m_func.coeff(m_lhs.coeff(index), m_rhs.coeff(index));
  }

References Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_func, Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_lhs, and Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_rhs.

packet() [1/2]

template<typename Func , typename Lhs , typename Rhs >

template<typename PacketType , int LhsMode = LhsAlignment, int RhsMode = RhsAlignment>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::packet ( const PacketType &  value, Index  index  ) const

inline

                                                                                                      {
    return m_func.packet(value, m_lhs.template packet<LhsMode, PacketType>(index),
                         m_rhs.template packet<RhsMode, PacketType>(index));
  }

References Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_func, Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_lhs, Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_rhs, and Eigen::value.

packet() [2/2]

template<typename Func , typename Lhs , typename Rhs >

template<typename PacketType , int LhsMode = LhsAlignment, int RhsMode = RhsAlignment>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE PacketType Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::packet ( Index  index ) const

inline

                                                                             {
    return m_func.packet(m_lhs.template packet<LhsMode, PacketType>(index),
                         m_rhs.template packet<RhsMode, PacketType>(index));
  }

References Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_func, Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_lhs, and Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_rhs.

size()

template<typename Func , typename Lhs , typename Rhs >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::size ( ) const

inline

{ return m_size.value(); }

References Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_size, and Eigen::internal::variable_if_dynamic< T, Value >::value().

Member Data Documentation

LhsAlignment

template<typename Func , typename Lhs , typename Rhs >

constexpr int Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::LhsAlignment = evaluator<Lhs>::Alignment

static

LhsFlags

template<typename Func , typename Lhs , typename Rhs >

constexpr int Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::LhsFlags = evaluator<Lhs>::Flags

staticconstexpr

m_func

template<typename Func , typename Lhs , typename Rhs >

const Func Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_func

Referenced by Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::coeff(), and Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::packet().

m_lhs

template<typename Func , typename Lhs , typename Rhs >

const evaluator<Lhs> Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_lhs

Referenced by Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::coeff(), and Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::packet().

m_rhs

template<typename Func , typename Lhs , typename Rhs >

const evaluator<Rhs> Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_rhs

Referenced by Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::coeff(), and Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::packet().

m_size

template<typename Func , typename Lhs , typename Rhs >

const variable_if_dynamic<Index, SizeAtCompileTime> Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::m_size

Referenced by Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::size().

RhsAlignment

template<typename Func , typename Lhs , typename Rhs >

constexpr int Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::RhsAlignment = evaluator<Rhs>::Alignment

static

RhsFlags

template<typename Func , typename Lhs , typename Rhs >

constexpr int Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::RhsFlags = evaluator<Rhs>::Flags

static

SizeAtCompileTime

template<typename Func , typename Lhs , typename Rhs >

constexpr int Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::SizeAtCompileTime = min_size_prefer_fixed(Lhs::SizeAtCompileTime, Rhs::SizeAtCompileTime)

static

Vectorize

template<typename Func , typename Lhs , typename Rhs >

constexpr bool Eigen::internal::inner_product_evaluator< Func, Lhs, Rhs >::Vectorize

staticconstexpr

Initial value:

=
      bool(LhsFlags & RhsFlags & PacketAccessBit) && Func::PacketAccess &&
      ((SizeAtCompileTime == Dynamic) || (unpacket_traits<Packet>::size <= SizeAtCompileTime))

---

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

• InnerProduct.h