Base class for dense Map and Block expression with direct access. More...

#include <MapBase.h>

Inheritance diagram for Eigen::MapBase< Derived, ReadOnlyAccessors >:

Public Types
enum	{ RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, InnerStrideAtCompileTime = internal::traits<Derived>::InnerStrideAtCompileTime, SizeAtCompileTime = Base::SizeAtCompileTime }

typedef internal::dense_xpr_base< Derived >::type	Base

typedef Base::CoeffReturnType	CoeffReturnType

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), Scalar , const Scalar >::type	PointerType

typedef NumTraits< Scalar >::Real	RealScalar

typedef internal::traits< Derived >::Scalar	Scalar

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
const EIGEN_DEVICE_FUNC Scalar &	coeff (Index index) const

const EIGEN_DEVICE_FUNC Scalar &	coeff (Index rowId, Index colId) const

const EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index index) const

const EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index rowId, Index colId) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

const EIGEN_DEVICE_FUNC Scalar *	data () const

EIGEN_DEVICE_FUNC	MapBase (PointerType dataPtr)

EIGEN_DEVICE_FUNC	MapBase (PointerType dataPtr, Index rows, Index cols)

EIGEN_DEVICE_FUNC	MapBase (PointerType dataPtr, Index vecSize)

template<int LoadMode>
PacketScalar	packet (Index index) const

template<int LoadMode>
PacketScalar	packet (Index rowId, Index colId) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

Protected Member Functions
template<typename T >
EIGEN_DEVICE_FUNC void	checkSanity (typename internal::enable_if< internal::traits< T >::Alignment==0, void * >::type=0) const

template<typename T >
EIGEN_DEVICE_FUNC void	checkSanity (typename internal::enable_if<(internal::traits< T >::Alignment >0), void * >::type=0) const

Protected Attributes
const internal::variable_if_dynamic< Index, ColsAtCompileTime >	m_cols

PointerType	m_data

const internal::variable_if_dynamic< Index, RowsAtCompileTime >	m_rows

Detailed Description

template<typename Derived>
class Eigen::MapBase< Derived, ReadOnlyAccessors >

Base class for dense Map and Block expression with direct access.

This base class provides the const low-level accessors (e.g. coeff, coeffRef) of dense Map and Block objects with direct access. Typical users do not have to directly deal with this class.

This class can be extended by through the macro plugin EIGEN_MAPBASE_PLUGIN. See customizing Eigen for details.

The Derived class has to provide the following two methods describing the memory layout:

Index innerStride() const;

Index outerStride() const;

See also: class Map, class Block

Definition at line 37 of file MapBase.h.

Member Typedef Documentation

◆ Base

template<typename Derived >

typedef internal::dense_xpr_base<Derived>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::Base

Definition at line 42 of file MapBase.h.

◆ CoeffReturnType

template<typename Derived >

typedef Base::CoeffReturnType Eigen::MapBase< Derived, ReadOnlyAccessors >::CoeffReturnType

Definition at line 87 of file MapBase.h.

◆ PacketScalar

template<typename Derived >

typedef internal::packet_traits<Scalar>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::PacketScalar

Definition at line 52 of file MapBase.h.

◆ PointerType

template<typename Derived >

typedef internal::conditional< bool(internal::is_lvalue<Derived>::value), Scalar *, const Scalar *>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::PointerType

Definition at line 58 of file MapBase.h.

◆ RealScalar

template<typename Derived >

typedef NumTraits<Scalar>::Real Eigen::MapBase< Derived, ReadOnlyAccessors >::RealScalar

Definition at line 53 of file MapBase.h.

◆ Scalar

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::MapBase< Derived, ReadOnlyAccessors >::Scalar

Definition at line 51 of file MapBase.h.

◆ StorageKind

template<typename Derived >

typedef internal::traits<Derived>::StorageKind Eigen::MapBase< Derived, ReadOnlyAccessors >::StorageKind

Definition at line 50 of file MapBase.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Derived >

anonymous enum

Enumerator
RowsAtCompileTime
ColsAtCompileTime
InnerStrideAtCompileTime
SizeAtCompileTime

Definition at line 43 of file MapBase.h.

Constructor & Destructor Documentation

◆ MapBase() [1/3]

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase ( PointerType dataPtr )

inlineexplicit

Definition at line 152 of file MapBase.h.

◆ MapBase() [2/3]

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase	(	PointerType	dataPtr,
		Index	vecSize
	)

inline

Definition at line 160 of file MapBase.h.

◆ MapBase() [3/3]

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase	(	PointerType	dataPtr,
		Index	rows,
		Index	cols
	)

inline

Definition at line 173 of file MapBase.h.

Member Function Documentation

◆ checkSanity() [1/2]

template<typename Derived >

template<typename T >

EIGEN_DEVICE_FUNC void Eigen::MapBase< Derived, ReadOnlyAccessors >::checkSanity ( typename internal::enable_if< internal::traits< T >::Alignment==0, void * >::type = 0 ) const

inlineprotected

Definition at line 205 of file MapBase.h.

◆ checkSanity() [2/2]

template<typename Derived >

template<typename T >

EIGEN_DEVICE_FUNC void Eigen::MapBase< Derived, ReadOnlyAccessors >::checkSanity ( typename internal::enable_if<(internal::traits< T >::Alignment >0), void * >::type = 0 ) const

inlineprotected

Definition at line 192 of file MapBase.h.

◆ coeff() [1/2]

template<typename Derived >

const EIGEN_DEVICE_FUNC Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeff ( Index index ) const

inline

This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details.

Definition at line 113 of file MapBase.h.

◆ coeff() [2/2]

template<typename Derived >

const EIGEN_DEVICE_FUNC Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeff	(	Index	rowId,
		Index	colId
	)		const

inline

This is an overloaded version of DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index,Index) const provided to by-pass the creation of an evaluator of the expression, thus saving compilation efforts.

See DenseCoeffsBase<Derived,ReadOnlyAccessors>::coeff(Index) const for details.

Definition at line 106 of file MapBase.h.

◆ coeffRef() [1/2]

template<typename Derived >

const EIGEN_DEVICE_FUNC Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeffRef ( Index index ) const

inline

This is the const version of coeffRef(Index) which is thus synonym of coeff(Index). It is provided for convenience.

Definition at line 128 of file MapBase.h.

◆ coeffRef() [2/2]

template<typename Derived >

const EIGEN_DEVICE_FUNC Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeffRef	(	Index	rowId,
		Index	colId
	)		const

inline

This is the const version of coeffRef(Index,Index) which is thus synonym of coeff(Index,Index). It is provided for convenience.

Definition at line 121 of file MapBase.h.

◆ cols()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MapBase< Derived, ReadOnlyAccessors >::cols ( ) const

inline

Definition at line 94 of file MapBase.h.

◆ data()

template<typename Derived >

const EIGEN_DEVICE_FUNC Scalar* Eigen::MapBase< Derived, ReadOnlyAccessors >::data ( ) const

inline

Returns a pointer to the first coefficient of the matrix or vector.

Note: When addressing this data, make sure to honor the strides returned by innerStride() and outerStride().

See also: innerStride(), outerStride()

Definition at line 102 of file MapBase.h.

◆ packet() [1/2]

template<typename Derived >

template<int LoadMode>

PacketScalar Eigen::MapBase< Derived, ReadOnlyAccessors >::packet ( Index index ) const

inline

Definition at line 144 of file MapBase.h.

◆ packet() [2/2]

template<typename Derived >

template<int LoadMode>

PacketScalar Eigen::MapBase< Derived, ReadOnlyAccessors >::packet	(	Index	rowId,
		Index	colId
	)		const

inline

Definition at line 136 of file MapBase.h.

◆ rows()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MapBase< Derived, ReadOnlyAccessors >::rows ( ) const

inline

Definition at line 91 of file MapBase.h.

Member Data Documentation

◆ m_cols

template<typename Derived >

const internal::variable_if_dynamic<Index, ColsAtCompileTime> Eigen::MapBase< Derived, ReadOnlyAccessors >::m_cols

protected

Definition at line 210 of file MapBase.h.

◆ m_data

template<typename Derived >

PointerType Eigen::MapBase< Derived, ReadOnlyAccessors >::m_data

protected

Definition at line 208 of file MapBase.h.

◆ m_rows

template<typename Derived >

const internal::variable_if_dynamic<Index, RowsAtCompileTime> Eigen::MapBase< Derived, ReadOnlyAccessors >::m_rows

protected

Definition at line 209 of file MapBase.h.

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

MapBase.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename Derived> class Eigen::MapBase< Derived, ReadOnlyAccessors >

Member Typedef Documentation

◆ Base

◆ CoeffReturnType

◆ PacketScalar

◆ PointerType

◆ RealScalar

◆ Scalar

◆ StorageKind

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ MapBase() [1/3]

◆ MapBase() [2/3]

◆ MapBase() [3/3]

Member Function Documentation

◆ checkSanity() [1/2]

◆ checkSanity() [2/2]

◆ coeff() [1/2]

◆ coeff() [2/2]

◆ coeffRef() [1/2]

◆ coeffRef() [2/2]

◆ cols()

◆ data()

◆ packet() [1/2]

◆ packet() [2/2]

◆ rows()

Member Data Documentation

◆ m_cols

◆ m_data

◆ m_rows

template<typename Derived>
class Eigen::MapBase< Derived, ReadOnlyAccessors >