Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors > Class Reference

---

Detailed Description

Base class providing read-only coefficient access to matrices and arrays.

Template Parameters:

Derived	Type of the derived class
ReadOnlyAccessors	Constant indicating read-only access

This class defines the operator() const function and friends, which can be used to read specific entries of a matrix or array.

See also:

DenseCoeffsBase<Derived, WriteAccessors>, DenseCoeffsBase<Derived, DirectAccessors>, TopicClassHierarchy

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

List of all members.

Public Types
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 internal::conditional < bool(internal::traits < Derived >::Flags &LvalueBit), const Scalar &, typename internal::conditional < internal::is_arithmetic < Scalar >::value, Scalar, const Scalar >::type >::type	CoeffReturnType
typedef internal::add_const_on_value_type_if_arithmetic < typename internal::packet_traits < Scalar >::type >::type	PacketReturnType
typedef EigenBase< Derived >	Base
Public Member Functions
EIGEN_STRONG_INLINE Index	rowIndexByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE Index	colIndexByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index row, Index col) const
	Short version: don't use this function, use operator()(Index,Index) const instead.
EIGEN_STRONG_INLINE CoeffReturnType	coeffByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index row, Index col) const
EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index index) const
	Short version: don't use this function, use operator[](Index) const instead.
EIGEN_STRONG_INLINE CoeffReturnType	operator[] (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	x () const
	equivalent to operator[](0).
EIGEN_STRONG_INLINE CoeffReturnType	y () const
	equivalent to operator[](1).
EIGEN_STRONG_INLINE CoeffReturnType	z () const
	equivalent to operator[](2).
EIGEN_STRONG_INLINE CoeffReturnType	w () const
	equivalent to operator[](3).
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index row, Index col) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packetByOuterInner (Index outer, Index inner) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index index) const
Derived &	derived ()
const Derived &	derived () const
Derived &	const_cast_derived () const
const Derived &	const_derived () const
Index	rows () const
Index	cols () const
Index	size () const
void	evalTo (Dest &dst) const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const
Protected Member Functions
void	coeffRef ()
void	coeffRefByOuterInner ()
void	writePacket ()
void	writePacketByOuterInner ()
void	copyCoeff ()
void	copyCoeffByOuterInner ()
void	copyPacket ()
void	copyPacketByOuterInner ()
void	stride ()
void	innerStride ()
void	outerStride ()
void	rowStride ()
void	colStride ()

---

Member Typedef Documentation

typedef EigenBase<Derived> Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::Base

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >, Eigen::DenseCoeffsBase< Derived, DirectAccessors >, and Eigen::DenseCoeffsBase< Derived, WriteAccessors >.

Definition at line 72 of file Core.

typedef internal::conditional<bool(internal::traits<Derived>::Flags&LvalueBit), const Scalar&, typename internal::conditional<internal::is_arithmetic<Scalar>::value, Scalar, const Scalar>::type >::type Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::CoeffReturnType

Definition at line 66 of file Core.

typedef internal::traits<Derived>::Index Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::Index

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >, Eigen::DenseCoeffsBase< Derived, DirectAccessors >, and Eigen::DenseCoeffsBase< Derived, WriteAccessors >.

Definition at line 52 of file Core.

typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits<Scalar>::type >::type Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::PacketReturnType

Definition at line 70 of file Core.

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

Reimplemented in Eigen::DenseCoeffsBase< Derived, WriteAccessors >.

Definition at line 54 of file Core.

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

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >, Eigen::DenseCoeffsBase< Derived, DirectAccessors >, and Eigen::DenseCoeffsBase< Derived, WriteAccessors >.

Definition at line 53 of file Core.

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

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::DenseCoeffsBase< Derived, WriteAccessors >.

Definition at line 51 of file Core.

---

Member Function Documentation

void Eigen::EigenBase::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Definition at line 91 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff	(	Index	row,
		Index	col
	)		const [inline]

Short version: don't use this function, use operator()(Index,Index) const instead.

Long version: this function is similar to operator()(Index,Index) const , but without the assertion. Use this for limiting the performance cost of debugging code when doing repeated coefficient access. Only use this when it is guaranteed that the parameters row and col are in range.

If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this function equivalent to operator()(Index,Index) const .

See also:

operator()(Index,Index) const, coeffRef(Index,Index), coeff(Index) const

Definition at line 108 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeff

(

Index

index

)

const [inline]

Short version: don't use this function, use operator[](Index) const instead.

Long version: this function is similar to operator[](Index) const , but without the assertion. Use this for limiting the performance cost of debugging code when doing repeated coefficient access. Only use this when it is guaranteed that the parameter index is in range.

If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this function equivalent to operator[](Index) const .

See also:

operator[](Index) const, coeffRef(Index), coeff(Index,Index) const

Definition at line 148 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffByOuterInner	(	Index	outer,
		Index	inner
	)		const [inline]

Definition at line 115 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffRef

(

)

[protected]

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffRefByOuterInner

(

)

[protected]

EIGEN_STRONG_INLINE Index Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::colIndexByOuterInner	(	Index	outer,
		Index	inner
	)		const [inline]

Definition at line 86 of file Core.

Index Eigen::EigenBase::cols

(

)

const [inline, inherited]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented in Eigen::SparseMatrixBase, Eigen::PermutationBase, and Eigen::TriangularBase.

Definition at line 61 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::colStride

(

)

[protected]

Derived& Eigen::EigenBase::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

const Derived& Eigen::EigenBase::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyCoeff

(

)

[protected]

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyCoeffByOuterInner

(

)

[protected]

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyPacket

(

)

[protected]

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyPacketByOuterInner

(

)

[protected]

Derived& Eigen::EigenBase::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

const Derived& Eigen::EigenBase::derived

(

)

const [inline, inherited]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

void Eigen::EigenBase::evalTo

(

Dest &

dst

)

const [inline, inherited]

Reimplemented in Eigen::internal::BandMatrixBase.

Definition at line 67 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::innerStride

(

)

[protected]

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator()	(	Index	row,
		Index	col
	)		const [inline]

Returns:

the coefficient at given the given row and column.

See also:

operator()(Index,Index), operator[](Index)

Definition at line 125 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator()

(

Index

index

)

const [inline]

Returns:

the coefficient at given index.

This is synonymous to operator[](Index) const.

This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.

See also:

operator[](Index), operator()(Index,Index) const, x() const, y() const, z() const, w() const

Definition at line 185 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::operator[]

(

Index

index

)

const [inline]

Returns:

the coefficient at given index.

This method is allowed only for vector expressions, and for matrix expressions having the LinearAccessBit.

See also:

operator[](Index), operator()(Index,Index) const, x() const, y() const, z() const, w() const

Definition at line 164 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::outerStride

(

)

[protected]

template<int LoadMode>

EIGEN_STRONG_INLINE PacketReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::packet	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 222 of file Core.

template<int LoadMode>

EIGEN_STRONG_INLINE PacketReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::packet

(

Index

index

)

const [inline]

Definition at line 249 of file Core.

template<int LoadMode>

EIGEN_STRONG_INLINE PacketReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::packetByOuterInner	(	Index	outer,
		Index	inner
	)		const [inline]

Definition at line 232 of file Core.

EIGEN_STRONG_INLINE Index Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::rowIndexByOuterInner	(	Index	outer,
		Index	inner
	)		const [inline]

Definition at line 78 of file Core.

Index Eigen::EigenBase::rows

(

)

const [inline, inherited]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented in Eigen::SparseMatrixBase, Eigen::PermutationBase, and Eigen::TriangularBase.

Definition at line 59 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::rowStride

(

)

[protected]

Index Eigen::EigenBase::size

(

)

const [inline, inherited]

Returns:

the number of coefficients, which is rows()*cols().

See also:

rows(), cols(), SizeAtCompileTime.

Reimplemented in Eigen::SparseMatrixBase, and Eigen::PermutationBase.

Definition at line 64 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::stride

(

)

[protected]

void Eigen::EigenBase::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w

(

)

const [inline]

equivalent to operator[](3).

Definition at line 209 of file Core.

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::writePacket

(

)

[protected]

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::writePacketByOuterInner

(

)

[protected]

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::x

(

)

const [inline]

equivalent to operator[](0).

Definition at line 194 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::y

(

)

const [inline]

equivalent to operator[](1).

Definition at line 199 of file Core.

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::z

(

)

const [inline]

equivalent to operator[](2).

Definition at line 204 of file Core.