ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ > Class Template Reference

Eigen3 view into an ndarray::Array. More...

#include <eigen.h>

Inheritance diagram for ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >:

Public Types
enum	{ Options = ST::Options }
typedef Eigen::internal::dense_xpr_base < EigenView< T, N, C, XprKind_, Rows_, Cols_ > >::type	Base
typedef boost::mpl::if_ < boost::is_same< XprKind_, Eigen::MatrixXpr > , Eigen::Matrix< Scalar, Rows_, Cols_, Options, Rows_, Cols_ > , Eigen::Array< Scalar, Rows_, Cols_, Options, Rows_, Cols_ > >::type	PlainEigenType
typedef T *	PointerType

Public Member Functions
	EigenView ()
	EigenView (EigenView const &other)
	EigenView (Array< T, N, C > const &array)
EigenView &	operator= (EigenView const &other)
template<typename Other >
EigenView &	operator= (Eigen::DenseBase< Other > const &other)
template<typename Other >
EigenView &	operator= (Eigen::EigenBase< Other > const &other)
template<typename Other >
EigenView &	operator= (Eigen::ReturnByValue< Other > const &other)
Index	innerStride () const
Index	outerStride () const
Index	rowStride () const
Index	colStride () const
Index	rows () const
Index	cols () const
T *	data () const
T *	data ()
T &	coeff (Index row, Index col) const
T &	coeff (Index index) const
T &	coeffRef (Index row, Index col) const
T &	coeffRef (Index row, Index col)
T &	coeffRef (Index index) const
T &	coeffRef (Index index)
template<int LoadMode>
PacketScalar	packet (Index row, Index col) const
template<int LoadMode>
PacketScalar	packet (Index index) const
template<int StoreMode>
void	writePacket (Index row, Index col, const PacketScalar &x)
template<int StoreMode>
void	writePacket (Index index, const PacketScalar &x)
Array< T, N, C > const &	shallow () const
ArrayRef< T, N, C >	deep () const
void	reset (Array< T, N, C > const &array)
void	reset (ArrayRef< T, N, C > const &array)

Private Types
typedef detail::EigenStrideTraits< N, C, Rows_, Cols_ >	ST
typedef detail::ArrayAccess < Array< T, N, C > >	Access

Private Member Functions
void	checkDimensions ()

Private Attributes
Array< T, N, C >	_array

Detailed Description

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>
class ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >

Eigen3 view into an ndarray::Array.

EigenView provides an Eigen DenseBase-derived object based on an ndarray::Array internally. Any one or two dimensional Array can be viewed as an Eigen object.

Assignment to an EigenView is deep, and uses the Eigen assignment operators, but construction from an ndarray::Array or ArrayRef is shallow with reference counting. Block and transpose operations use the standard Eigen Block and Transpose classes, and do not do reference counting (in fact, they hold a plain C++ reference to the EigenView, so they should be considered extremely temporary).

Todo:

Add reference-counted share and transpose operations that return EigenViews.

Definition at line 232 of file eigen.h.

Member Typedef Documentation

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

typedef detail::ArrayAccess< Array<T,N,C> > ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::Access

private

Definition at line 236 of file eigen.h.

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

typedef Eigen::internal::dense_xpr_base< EigenView<T,N,C,XprKind_,Rows_,Cols_> >::type ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::Base

Definition at line 245 of file eigen.h.

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

typedef boost::mpl::if_< boost::is_same<XprKind_,Eigen::MatrixXpr>, Eigen::Matrix<Scalar,Rows_,Cols_,Options,Rows_,Cols_>, Eigen::Array<Scalar,Rows_,Cols_,Options,Rows_,Cols_> >::type ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::PlainEigenType

Definition at line 255 of file eigen.h.

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

typedef T* ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::PointerType

Definition at line 257 of file eigen.h.

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

typedef detail::EigenStrideTraits<N,C,Rows_,Cols_> ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::ST

private

Definition at line 235 of file eigen.h.

Member Enumeration Documentation

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

anonymous enum

Enumerator
Options

Definition at line 249 of file eigen.h.

{ Options = ST::Options };

Constructor & Destructor Documentation

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::EigenView ( )

inline

Definition at line 259 of file eigen.h.

: _array() {}

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::EigenView ( EigenView< T, N, C, XprKind_, Rows_, Cols_ > const &  other )

inline

Definition at line 261 of file eigen.h.

: _array(other._array) {}

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::EigenView ( Array< T, N, C > const &  array )

inlineexplicit

Definition at line 263 of file eigen.h.

: _array(array) { checkDimensions(); }

Member Function Documentation

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

void ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::checkDimensions ( )

inlineprivate

Definition at line 238 of file eigen.h.

                           {
        NDARRAY_ASSERT( Rows_ == Eigen::Dynamic || Rows_ == rows() );
        NDARRAY_ASSERT( Cols_ == Eigen::Dynamic || Cols_ == cols() );
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::coeff ( Index  row, Index  col  ) const

inline

Definition at line 304 of file eigen.h.

                                                {
        return _array.getData()[row * rowStride() + col * colStride()];
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::coeff ( Index  index ) const

inline

Definition at line 308 of file eigen.h.

                                       {
        return _array.getData()[index * innerStride()];
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::coeffRef ( Index  row, Index  col  ) const

inline

Definition at line 312 of file eigen.h.

                                                   {
      return _array.getData()[row * rowStride() + col * colStride()];
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::coeffRef ( Index  row, Index  col  )

inline

Definition at line 316 of file eigen.h.

                                             {
      return _array.getData()[row * rowStride() + col * colStride()];
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::coeffRef ( Index  index ) const

inline

Definition at line 320 of file eigen.h.

                                          {
        return _array.getData()[index * innerStride()];
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::coeffRef ( Index  index )

inline

Definition at line 324 of file eigen.h.

                                    {
        return _array.getData()[index * innerStride()];
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Index ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::cols ( ) const

inline

Definition at line 298 of file eigen.h.

{ return ST::getCols(*Access::getCore(_array)); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Index ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::colStride ( ) const

inline

Definition at line 295 of file eigen.h.

{ return ST::getColStride(*Access::getCore(_array)); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T* ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::data ( ) const

inline

Definition at line 300 of file eigen.h.

{ return _array.getData(); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

T* ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::data ( )

inline

Definition at line 302 of file eigen.h.

{ return _array.getData(); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

ArrayRef<T,N,C> ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::deep ( ) const

inline

Definition at line 361 of file eigen.h.

{ return _array.deep(); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Index ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::innerStride ( ) const

inline

Definition at line 291 of file eigen.h.

{ return ST::getInnerStride(*Access::getCore(_array)); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

EigenView& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::operator= ( EigenView< T, N, C, XprKind_, Rows_, Cols_ > const &  other )

inline

Definition at line 265 of file eigen.h.

                                                   {
        // Weird behavior to please SWIG: if we're default-constructed, and it's an exact match,
        // do shallow assignment; otherwise all assignment is deep.
        if (_array.getData() == 0) {
            _array = other._array;
        } else {
            Base::operator=(other);
        }
        return *this;
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

template<typename Other >

EigenView& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::operator= ( Eigen::DenseBase< Other > const &  other )

inline

Definition at line 277 of file eigen.h.

                                                               {
        return Base::operator=(other);
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

template<typename Other >

EigenView& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::operator= ( Eigen::EigenBase< Other > const &  other )

inline

Definition at line 282 of file eigen.h.

                                                               {
        return Base::operator=(other);
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

template<typename Other >

EigenView& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::operator= ( Eigen::ReturnByValue< Other > const &  other )

inline

Definition at line 287 of file eigen.h.

                                                                   {
        return Base::operator=(other);
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Index ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::outerStride ( ) const

inline

Definition at line 292 of file eigen.h.

{ return ST::getOuterStride(*Access::getCore(_array)); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

template<int LoadMode>

PacketScalar ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::packet ( Index  row, Index  col  ) const

inline

Definition at line 329 of file eigen.h.

                                                           {
        return Eigen::internal::ploadt<PacketScalar, LoadMode>(
            _array.getData() + (col * colStride() + row * rowStride())
        );
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

template<int LoadMode>

PacketScalar ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::packet ( Index  index ) const

inline

Definition at line 336 of file eigen.h.

                                                  {
        BOOST_STATIC_ASSERT( N == 1 );
        return Eigen::internal::ploadt<PacketScalar, LoadMode>(
            _array.getData() + index * innerStride()
        );
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

void ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::reset ( Array< T, N, C > const &  array )

inline

Definition at line 363 of file eigen.h.

{ _array = array; checkDimensions(); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

void ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::reset ( ArrayRef< T, N, C > const &  array )

inline

Definition at line 364 of file eigen.h.

{ reset(array.shallow()); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Index ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::rows ( ) const

inline

Definition at line 297 of file eigen.h.

{ return ST::getRows(*Access::getCore(_array)); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Index ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::rowStride ( ) const

inline

Definition at line 294 of file eigen.h.

{ return ST::getRowStride(*Access::getCore(_array)); }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Array<T,N,C> const& ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::shallow ( ) const

inline

Definition at line 360 of file eigen.h.

{ return _array; }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

template<int StoreMode>

void ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::writePacket ( Index  row, Index  col, const PacketScalar &  x  )

inline

Definition at line 344 of file eigen.h.

                                                                         {
        BOOST_STATIC_ASSERT( !boost::is_const<T>::value );
        Eigen::internal::pstoret<Scalar, PacketScalar, StoreMode>(
            _array.getData() + (col * colStride() + row * rowStride()), x
        );
    }

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

template<int StoreMode>

void ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::writePacket ( Index  index, const PacketScalar &  x  )

inline

Definition at line 352 of file eigen.h.

                                                                {
        BOOST_STATIC_ASSERT( !boost::is_const<T>::value );
        BOOST_STATIC_ASSERT( N == 1 );
        Eigen::internal::pstoret<Scalar, PacketScalar, StoreMode>(
            _array.getData() + index * innerStride(), x
        );
    }

Member Data Documentation

template<typename T, int N, int C, typename XprKind_, int Rows_, int Cols_>

Array<T,N,C> ndarray::EigenView< T, N, C, XprKind_, Rows_, Cols_ >::_array

private

Definition at line 367 of file eigen.h.

---

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

• /home/lsstsw/stack/Linux64/ndarray/11.0.rc2+1/include/ndarray/eigen.h