Eigen::RefBase< Derived > Class Template Reference

#include <src/eigen/Eigen/src/Core/Ref.h>

Inheritance diagram for Eigen::RefBase< Derived >:

Collaboration diagram for Eigen::RefBase< Derived >:

Public Types
typedef MapBase< Derived >	Base

Public Member Functions
EIGEN_DEVICE_FUNC Index	innerStride () const
EIGEN_DEVICE_FUNC Index	outerStride () const
EIGEN_DEVICE_FUNC	RefBase ()

Protected Types
typedef Stride< StrideType::OuterStrideAtCompileTime, StrideType::InnerStrideAtCompileTime >	StrideBase

Protected Member Functions
template<typename Expression >
EIGEN_DEVICE_FUNC void	construct (Expression &expr)

Protected Attributes
StrideBase	m_stride

Private Types
typedef internal::traits< Derived >::PlainObjectType	PlainObjectType
typedef internal::traits< Derived >::StrideType	StrideType

Detailed Description

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

Member Typedef Documentation

Base

template<typename Derived >

typedef MapBase<Derived> Eigen::RefBase< Derived >::Base

PlainObjectType

template<typename Derived >

typedef internal::traits<Derived>::PlainObjectType Eigen::RefBase< Derived >::PlainObjectType

private

StrideBase

template<typename Derived >

typedef Stride<StrideType::OuterStrideAtCompileTime,StrideType::InnerStrideAtCompileTime> Eigen::RefBase< Derived >::StrideBase

protected

StrideType

template<typename Derived >

typedef internal::traits<Derived>::StrideType Eigen::RefBase< Derived >::StrideType

private

Constructor & Destructor Documentation

RefBase()

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::RefBase< Derived >::RefBase ( )

inline

    : Base(0,RowsAtCompileTime==Dynamic?0:RowsAtCompileTime,ColsAtCompileTime==Dynamic?0:ColsAtCompileTime),
      // Stride<> does not allow default ctor for Dynamic strides, so let' initialize it with dummy values:
      m_stride(StrideType::OuterStrideAtCompileTime==Dynamic?0:StrideType::OuterStrideAtCompileTime,
               StrideType::InnerStrideAtCompileTime==Dynamic?0:StrideType::InnerStrideAtCompileTime)
  {}

Member Function Documentation

construct()

template<typename Derived >

template<typename Expression >

EIGEN_DEVICE_FUNC void Eigen::RefBase< Derived >::construct ( Expression &  expr )

inlineprotected

  {
    EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(PlainObjectType,Expression);
 
    if(PlainObjectType::RowsAtCompileTime==1)
    {
      eigen_assert(expr.rows()==1 || expr.cols()==1);
      ::new (static_cast<Base*>(this)) Base(expr.data(), 1, expr.size());
    }
    else if(PlainObjectType::ColsAtCompileTime==1)
    {
      eigen_assert(expr.rows()==1 || expr.cols()==1);
      ::new (static_cast<Base*>(this)) Base(expr.data(), expr.size(), 1);
    }
    else
      ::new (static_cast<Base*>(this)) Base(expr.data(), expr.rows(), expr.cols());
    
    if(Expression::IsVectorAtCompileTime && (!PlainObjectType::IsVectorAtCompileTime) && ((Expression::Flags&RowMajorBit)!=(PlainObjectType::Flags&RowMajorBit)))
      ::new (&m_stride) StrideBase(expr.innerStride(), StrideType::InnerStrideAtCompileTime==0?0:1);
    else
      ::new (&m_stride) StrideBase(StrideType::OuterStrideAtCompileTime==0?0:expr.outerStride(),
                                   StrideType::InnerStrideAtCompileTime==0?0:expr.innerStride());    
  }

References eigen_assert, EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE, Eigen::RefBase< Derived >::m_stride, and Eigen::RowMajorBit.

Referenced by Eigen::Ref< PlainObjectType, Options, StrideType >::Ref(), Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref(), Eigen::Ref< SparseVector< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref(), Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref(), Eigen::Ref< PlainObjectType, Options, StrideType >::Ref(), Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref(), Eigen::Ref< SparseVector< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref(), Eigen::Ref< const TPlainObjectType, Options, StrideType >::construct(), Eigen::Ref< const SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::construct(), Eigen::Ref< const SparseVector< MatScalar, MatOptions, MatIndex >, Options, StrideType >::construct(), Eigen::Ref< const TPlainObjectType, Options, StrideType >::construct(), Eigen::Ref< const SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::construct(), and Eigen::Ref< const SparseVector< MatScalar, MatOptions, MatIndex >, Options, StrideType >::construct().

Here is the caller graph for this function:

innerStride()

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::RefBase< Derived >::innerStride ( ) const

inline

  {
    return StrideType::InnerStrideAtCompileTime != 0 ? m_stride.inner() : 1;
  }

References Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::inner(), and Eigen::RefBase< Derived >::m_stride.

Here is the call graph for this function:

outerStride()

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::RefBase< Derived >::outerStride ( ) const

inline

  {
    return StrideType::OuterStrideAtCompileTime != 0 ? m_stride.outer()
         : IsVectorAtCompileTime ? this->size()
         : int(Flags)&RowMajorBit ? this->cols()
         : this->rows();
  }

References Eigen::RefBase< Derived >::m_stride, Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::outer(), and Eigen::RowMajorBit.

Here is the call graph for this function:

Member Data Documentation

m_stride

template<typename Derived >

StrideBase Eigen::RefBase< Derived >::m_stride

protected

Referenced by Eigen::RefBase< Derived >::construct(), Eigen::RefBase< Derived >::innerStride(), and Eigen::RefBase< Derived >::outerStride().

---

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

• src/eigen/Eigen/src/Core/Ref.h