Eigen::MapBase< Derived, WriteAccessors > Class Template Reference

#include <MapBase.h>

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

Collaboration diagram for Eigen::MapBase< Derived, WriteAccessors >:

List of all members.

Public Types
typedef MapBase< Derived, ReadOnlyAccessors >	Base
typedef Base::Scalar	Scalar
typedef Base::PacketScalar	PacketScalar
typedef Base::StorageIndex	StorageIndex
typedef Base::PointerType	PointerType
typedef internal::conditional < internal::is_lvalue< Derived > ::value, Scalar, const Scalar > ::type	ScalarWithConstIfNotLvalue
Public Member Functions
EIGEN_DEVICE_FUNC const Scalar *	data () const
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue *	data ()
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue &	coeffRef (Index row, Index col)
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue &	coeffRef (Index index)
template<int StoreMode>
void	writePacket (Index row, Index col, const PacketScalar &val)
template<int StoreMode>
void	writePacket (Index index, const PacketScalar &val)
EIGEN_DEVICE_FUNC	MapBase (PointerType dataPtr)
EIGEN_DEVICE_FUNC	MapBase (PointerType dataPtr, Index vecSize)
EIGEN_DEVICE_FUNC	MapBase (PointerType dataPtr, Index p_rows, Index p_cols)
EIGEN_DEVICE_FUNC Derived &	operator= (const MapBase &other)
Private Types
typedef MapBase< Derived, ReadOnlyAccessors >	ReadOnlyMapBase

---

Detailed Description

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

Definition at line 184 of file MapBase.h.

---

Member Typedef Documentation

template<typename Derived >

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

Reimplemented from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 190 of file MapBase.h.

template<typename Derived >

typedef Base::PacketScalar Eigen::MapBase< Derived, WriteAccessors >::PacketScalar

Reimplemented from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 193 of file MapBase.h.

template<typename Derived >

typedef Base::PointerType Eigen::MapBase< Derived, WriteAccessors >::PointerType

Reimplemented from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 195 of file MapBase.h.

template<typename Derived >

typedef MapBase<Derived, ReadOnlyAccessors> Eigen::MapBase< Derived, WriteAccessors >::ReadOnlyMapBase [private]

Definition at line 187 of file MapBase.h.

template<typename Derived >

typedef Base::Scalar Eigen::MapBase< Derived, WriteAccessors >::Scalar

Reimplemented from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 192 of file MapBase.h.

template<typename Derived >

typedef internal::conditional< internal::is_lvalue<Derived>::value, Scalar, const Scalar >::type Eigen::MapBase< Derived, WriteAccessors >::ScalarWithConstIfNotLvalue

Definition at line 213 of file MapBase.h.

template<typename Derived >

typedef Base::StorageIndex Eigen::MapBase< Derived, WriteAccessors >::StorageIndex

Definition at line 194 of file MapBase.h.

---

Constructor & Destructor Documentation

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, WriteAccessors >::MapBase

(

PointerType

dataPtr

)

[inline, explicit]

Reimplemented from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 248 of file MapBase.h.

: Base(dataPtr) {}

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, WriteAccessors >::MapBase	(	PointerType	dataPtr,
		Index	vecSize
	)		[inline]

Reimplemented from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 249 of file MapBase.h.

: Base(dataPtr, vecSize) {}

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::MapBase< Derived, WriteAccessors >::MapBase	(	PointerType	dataPtr,
		Index	p_rows,
		Index	p_cols
	)		[inline]

Reimplemented from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 250 of file MapBase.h.

: Base(dataPtr, p_rows, p_cols) {}

---

Member Function Documentation

template<typename Derived >

EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue& Eigen::MapBase< Derived, WriteAccessors >::coeffRef	(	Index	row,
		Index	col
	)		[inline]

Definition at line 221 of file MapBase.h.

    {
      return this->m_data[col * colStride() + row * rowStride()];
    }

template<typename Derived >

EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue& Eigen::MapBase< Derived, WriteAccessors >::coeffRef

(

Index

index

)

[inline]

Definition at line 227 of file MapBase.h.

    {
      EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
      return this->m_data[index * innerStride()];
    }

template<typename Derived >

EIGEN_DEVICE_FUNC const Scalar* Eigen::MapBase< Derived, WriteAccessors >::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 from Eigen::MapBase< Derived, ReadOnlyAccessors >.

Definition at line 216 of file MapBase.h.

{ return this->m_data; }

template<typename Derived >

EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue* Eigen::MapBase< Derived, WriteAccessors >::data

(

)

[inline]

Definition at line 218 of file MapBase.h.

{ return this->m_data; } // no const-cast here so non-const-correct code will give a compile error

template<typename Derived >

EIGEN_DEVICE_FUNC Derived& Eigen::MapBase< Derived, WriteAccessors >::operator=

(

const MapBase< Derived, WriteAccessors > &

other

)

[inline]

Definition at line 253 of file MapBase.h.

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

template<typename Derived >

template<int StoreMode>

void Eigen::MapBase< Derived, WriteAccessors >::writePacket	(	Index	row,
		Index	col,
		const PacketScalar &	val
	)		[inline]

Definition at line 234 of file MapBase.h.

    {
      internal::pstoret<Scalar, PacketScalar, StoreMode>
               (this->m_data + (col * colStride() + row * rowStride()), val);
    }

template<typename Derived >

template<int StoreMode>

void Eigen::MapBase< Derived, WriteAccessors >::writePacket	(	Index	index,
		const PacketScalar &	val
	)		[inline]

Definition at line 241 of file MapBase.h.

    {
      EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
      internal::pstoret<Scalar, PacketScalar, StoreMode>
                (this->m_data + index * innerStride(), val);
    }

---

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

• MapBase.h