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

#include <DenseCoeffsBase.h>

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

Public Types
typedef EigenBase< Derived >	Base
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::traits < Derived >::Index	Index
typedef internal::add_const_on_value_type_if_arithmetic < typename internal::packet_traits < Scalar >::type >::type	PacketReturnType
typedef internal::packet_traits < Scalar >::type	PacketScalar
typedef internal::traits < Derived >::Scalar	Scalar
typedef internal::traits < Derived >::StorageKind	StorageKind
Public Member Functions
EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index row, Index col) const
EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	coeffByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE Index	colIndexByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index row, Index col) const
EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	operator[] (Index index) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index row, Index col) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index index) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packetByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE Index	rowIndexByOuterInner (Index outer, Index inner) const
EIGEN_STRONG_INLINE CoeffReturnType	w () const
EIGEN_STRONG_INLINE CoeffReturnType	x () const
EIGEN_STRONG_INLINE CoeffReturnType	y () const
EIGEN_STRONG_INLINE CoeffReturnType	z () const
Protected Member Functions
void	coeffRef ()
void	coeffRefByOuterInner ()
void	colStride ()
void	copyCoeff ()
void	copyCoeffByOuterInner ()
void	copyPacket ()
void	copyPacketByOuterInner ()
void	innerStride ()
void	outerStride ()
void	rowStride ()
void	stride ()
void	writePacket ()
void	writePacketByOuterInner ()

Detailed Description

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

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

Definition at line 34 of file DenseCoeffsBase.h.

Member Typedef Documentation

template<typename Derived >

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 58 of file DenseCoeffsBase.h.

template<typename Derived >

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 52 of file DenseCoeffsBase.h.

template<typename Derived >

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 38 of file DenseCoeffsBase.h.

template<typename Derived >

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

Definition at line 56 of file DenseCoeffsBase.h.

template<typename Derived >

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

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

Definition at line 40 of file DenseCoeffsBase.h.

template<typename Derived >

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 39 of file DenseCoeffsBase.h.

template<typename Derived >

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

Reimplemented from Eigen::EigenBase< Derived >.

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

Definition at line 37 of file DenseCoeffsBase.h.

Member Function Documentation

template<typename Derived >

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 94 of file DenseCoeffsBase.h.

template<typename Derived >

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 134 of file DenseCoeffsBase.h.

template<typename Derived >

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

Definition at line 101 of file DenseCoeffsBase.h.

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffRef ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::coeffRefByOuterInner ( ) [protected]

template<typename Derived >

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

Definition at line 72 of file DenseCoeffsBase.h.

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::colStride ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyCoeff ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyCoeffByOuterInner ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyPacket ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::copyPacketByOuterInner ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::innerStride ( ) [protected]

template<typename Derived >

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 111 of file DenseCoeffsBase.h.

template<typename Derived >

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 171 of file DenseCoeffsBase.h.

template<typename Derived >

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 150 of file DenseCoeffsBase.h.

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::outerStride ( ) [protected]

template<typename Derived >

template<int LoadMode>

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

Definition at line 208 of file DenseCoeffsBase.h.

template<typename Derived >

template<int LoadMode>

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

Definition at line 235 of file DenseCoeffsBase.h.

template<typename Derived >

template<int LoadMode>

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

Definition at line 218 of file DenseCoeffsBase.h.

template<typename Derived >

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

Definition at line 64 of file DenseCoeffsBase.h.

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::rowStride ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::stride ( ) [protected]

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w ( ) const [inline]

equivalent to operator[](3).

Definition at line 195 of file DenseCoeffsBase.h.

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::writePacket ( ) [protected]

template<typename Derived >

void Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::writePacketByOuterInner ( ) [protected]

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::x ( ) const [inline]

equivalent to operator[](0).

Definition at line 180 of file DenseCoeffsBase.h.

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::y ( ) const [inline]

equivalent to operator[](1).

Definition at line 185 of file DenseCoeffsBase.h.

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::z ( ) const [inline]

equivalent to operator[](2).

Definition at line 190 of file DenseCoeffsBase.h.

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

DenseCoeffsBase.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

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

Member Typedef Documentation

Member Function Documentation

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