MapBase< Derived, ReadOnlyAccessors > Class Template Reference

---

Detailed Description

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

Definition at line 41 of file MapBase.h.

#include <src/Core/MapBase.h>

Inheritance diagram for MapBase< Derived, ReadOnlyAccessors >:

List of all members.

Public Types
enum	{ RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime = Base::SizeAtCompileTime }
typedef internal::dense_xpr_base < Derived >::type	Base
typedef internal::traits < Derived >::StorageKind	StorageKind
typedef internal::traits < Derived >::Index	Index
typedef internal::traits < Derived >::Scalar	Scalar
typedef internal::packet_traits < Scalar >::type	PacketScalar
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::conditional < bool(internal::is_lvalue < Derived >::value), Scalar *, const Scalar * >::type	PointerType
typedef Base::CoeffReturnType	CoeffReturnType
Public Member Functions
Index	rows () const
Index	cols () const
const Scalar *	data () const
	Returns a pointer to the first coefficient of the matrix or vector.
const Scalar &	coeff (Index row, Index col) const
const Scalar &	coeff (Index index) const
const Scalar &	coeffRef (Index row, Index col) const
const Scalar &	coeffRef (Index index) const
template<int LoadMode>
PacketScalar	packet (Index row, Index col) const
template<int LoadMode>
PacketScalar	packet (Index index) const
	MapBase (PointerType data)
	MapBase (PointerType data, Index size)
	MapBase (PointerType data, Index rows, Index cols)
Protected Member Functions
void	checkSanity () const
Protected Attributes
PointerType	m_data
const internal::variable_if_dynamic < Index, RowsAtCompileTime >	m_rows
const internal::variable_if_dynamic < Index, ColsAtCompileTime >	m_cols

---

Member Typedef Documentation

template<typename Derived >

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

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 46 of file MapBase.h.

template<typename Derived >

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

Definition at line 89 of file MapBase.h.

template<typename Derived >

typedef internal::traits<Derived>::Index MapBase< Derived, ReadOnlyAccessors >::Index

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 54 of file MapBase.h.

template<typename Derived >

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

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 56 of file MapBase.h.

template<typename Derived >

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

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 62 of file MapBase.h.

template<typename Derived >

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

Definition at line 57 of file MapBase.h.

template<typename Derived >

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

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 55 of file MapBase.h.

template<typename Derived >

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

Definition at line 53 of file MapBase.h.

---

Member Enumeration Documentation

template<typename Derived >

anonymous enum

Enumerator:

RowsAtCompileTime
ColsAtCompileTime
SizeAtCompileTime

Definition at line 47 of file MapBase.h.

---

Constructor & Destructor Documentation

template<typename Derived >

MapBase< Derived, ReadOnlyAccessors >::MapBase

(

PointerType

data

)

[inline]

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 138 of file MapBase.h.

References EIGEN_STATIC_ASSERT_FIXED_SIZE.

template<typename Derived >

MapBase< Derived, ReadOnlyAccessors >::MapBase	(	PointerType	data,
		Index	size
	)		[inline]

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 144 of file MapBase.h.

References Dynamic, eigen_assert, and EIGEN_STATIC_ASSERT_VECTOR_ONLY.

template<typename Derived >

MapBase< Derived, ReadOnlyAccessors >::MapBase	(	PointerType	data,
		Index	rows,
		Index	cols
	)		[inline]

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 155 of file MapBase.h.

References Dynamic, and eigen_assert.

---

Member Function Documentation

template<typename Derived >

void MapBase< Derived, ReadOnlyAccessors >::checkSanity

(

)

const [inline, protected]

Definition at line 166 of file MapBase.h.

References AlignedBit, eigen_assert, EIGEN_IMPLIES, EIGEN_STATIC_ASSERT, and PacketAccessBit.

template<typename Derived >

const Scalar& MapBase< Derived, ReadOnlyAccessors >::coeff	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 102 of file MapBase.h.

template<typename Derived >

const Scalar& MapBase< Derived, ReadOnlyAccessors >::coeff

(

Index

index

)

const [inline]

Definition at line 107 of file MapBase.h.

References EIGEN_STATIC_ASSERT_LINEAR_ACCESS.

template<typename Derived >

const Scalar& MapBase< Derived, ReadOnlyAccessors >::coeffRef	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 113 of file MapBase.h.

template<typename Derived >

const Scalar& MapBase< Derived, ReadOnlyAccessors >::coeffRef

(

Index

index

)

const [inline]

Definition at line 118 of file MapBase.h.

References EIGEN_STATIC_ASSERT_LINEAR_ACCESS.

template<typename Derived >

Index MapBase< Derived, ReadOnlyAccessors >::cols

(

void

)

const [inline]

Definition at line 92 of file MapBase.h.

template<typename Derived >

const Scalar* 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()

Reimplemented in MapBase< Derived, WriteAccessors >.

Definition at line 100 of file MapBase.h.

template<typename Derived >

template<int LoadMode>

PacketScalar MapBase< Derived, ReadOnlyAccessors >::packet	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 125 of file MapBase.h.

template<typename Derived >

template<int LoadMode>

PacketScalar MapBase< Derived, ReadOnlyAccessors >::packet

(

Index

index

)

const [inline]

Definition at line 132 of file MapBase.h.

References EIGEN_STATIC_ASSERT_LINEAR_ACCESS.

template<typename Derived >

Index MapBase< Derived, ReadOnlyAccessors >::rows

(

void

)

const [inline]

Definition at line 91 of file MapBase.h.

---

Member Data Documentation

template<typename Derived >

const internal::variable_if_dynamic<Index, ColsAtCompileTime> MapBase< Derived, ReadOnlyAccessors >::m_cols [protected]

Definition at line 177 of file MapBase.h.

template<typename Derived >

PointerType MapBase< Derived, ReadOnlyAccessors >::m_data [protected]

Definition at line 175 of file MapBase.h.

template<typename Derived >

const internal::variable_if_dynamic<Index, RowsAtCompileTime> MapBase< Derived, ReadOnlyAccessors >::m_rows [protected]

Definition at line 176 of file MapBase.h.