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

#include <DenseCoeffsBase.h>

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

[legend]

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::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 Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

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

Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index row, Index col) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeffByOuterInner (Index outer, Index inner) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	colIndexByOuterInner (Index outer, Index inner) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index row, Index col) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator[] (Index index) const

template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index index) const

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

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rowIndexByOuterInner (Index outer, Index inner) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	w () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	x () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	y () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	z () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

const EIGEN_DEVICE_FUNC Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) 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

Note: 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>, The class hierarchy

Definition at line 35 of file DenseCoeffsBase.h.

Member Typedef Documentation

◆ Base

template<typename Derived >

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

Definition at line 58 of file DenseCoeffsBase.h.

◆ CoeffReturnType

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.

◆ PacketReturnType

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.

◆ PacketScalar

template<typename Derived >

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

Definition at line 40 of file DenseCoeffsBase.h.

◆ Scalar

template<typename Derived >

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

Definition at line 39 of file DenseCoeffsBase.h.

◆ StorageKind

template<typename Derived >

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

Definition at line 38 of file DenseCoeffsBase.h.

Member Function Documentation

◆ coeff() [1/2]

template<typename Derived >

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

◆ coeff() [2/2]

template<typename Derived >

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

◆ coeffByOuterInner()

template<typename Derived >

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

inline

Definition at line 105 of file DenseCoeffsBase.h.

◆ coeffRef()

template<typename Derived >

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

protected

◆ coeffRefByOuterInner()

template<typename Derived >

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

protected

◆ colIndexByOuterInner()

template<typename Derived >

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

inline

Definition at line 74 of file DenseCoeffsBase.h.

◆ cols()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols

inline

Returns: the number of columns.

See also: rows(), ColsAtCompileTime

Definition at line 63 of file EigenBase.h.

◆ colStride()

template<typename Derived >

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

protected

◆ copyCoeff()

template<typename Derived >

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

protected

◆ copyCoeffByOuterInner()

template<typename Derived >

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

protected

◆ copyPacket()

template<typename Derived >

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

protected

◆ copyPacketByOuterInner()

template<typename Derived >

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

protected

◆ derived() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC Derived& Eigen::EigenBase< Derived >::derived

inline

Returns: a reference to the derived object

Definition at line 46 of file EigenBase.h.

◆ derived() [2/2]

template<typename Derived >

const EIGEN_DEVICE_FUNC Derived& Eigen::EigenBase< Derived >::derived

inline

Returns: a const reference to the derived object

Definition at line 49 of file EigenBase.h.

◆ innerStride()

template<typename Derived >

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

protected

◆ operator()() [1/2]

template<typename Derived >

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

◆ operator()() [2/2]

template<typename Derived >

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

◆ operator[]()

template<typename Derived >

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

◆ outerStride()

template<typename Derived >

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

protected

◆ packet() [1/2]

template<typename Derived >

template<int LoadMode>

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

inline

Definition at line 259 of file DenseCoeffsBase.h.

◆ packet() [2/2]

template<typename Derived >

template<int LoadMode>

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

inline

Definition at line 232 of file DenseCoeffsBase.h.

◆ packetByOuterInner()

template<typename Derived >

template<int LoadMode>

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

inline

Definition at line 242 of file DenseCoeffsBase.h.

◆ rowIndexByOuterInner()

template<typename Derived >

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

inline

Definition at line 65 of file DenseCoeffsBase.h.

◆ rows()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows

inline

Returns: the number of rows.

See also: cols(), RowsAtCompileTime

Definition at line 60 of file EigenBase.h.

◆ rowStride()

template<typename Derived >

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

protected

◆ size()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::size

inline

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

See also: rows(), cols(), SizeAtCompileTime.

Definition at line 67 of file EigenBase.h.

◆ stride()

template<typename Derived >

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

protected

◆ w()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::w ( ) const

inline

equivalent to operator[](3).

Definition at line 215 of file DenseCoeffsBase.h.

◆ writePacket()

template<typename Derived >

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

protected

◆ writePacketByOuterInner()

template<typename Derived >

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

protected

◆ x()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::x ( ) const

inline

equivalent to operator[](0).

Definition at line 189 of file DenseCoeffsBase.h.

◆ y()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::y ( ) const

inline

equivalent to operator[](1).

Definition at line 195 of file DenseCoeffsBase.h.

◆ z()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >::z ( ) const

inline

equivalent to operator[](2).

Definition at line 205 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

◆ Base

◆ CoeffReturnType

◆ PacketReturnType

◆ PacketScalar

◆ Scalar

◆ StorageKind

Member Function Documentation

◆ coeff() [1/2]

◆ coeff() [2/2]

◆ coeffByOuterInner()

◆ coeffRef()

◆ coeffRefByOuterInner()

◆ colIndexByOuterInner()

◆ cols()

◆ colStride()

◆ copyCoeff()

◆ copyCoeffByOuterInner()

◆ copyPacket()

◆ copyPacketByOuterInner()

◆ derived() [1/2]

◆ derived() [2/2]

◆ innerStride()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator[]()

◆ outerStride()

◆ packet() [1/2]

◆ packet() [2/2]

◆ packetByOuterInner()

◆ rowIndexByOuterInner()

◆ rows()

◆ rowStride()

◆ size()

◆ stride()

◆ w()

◆ writePacket()

◆ writePacketByOuterInner()

◆ x()

◆ y()

◆ z()

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