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

#include <DenseCoeffsBase.h>

Inheritance diagram for DenseCoeffsBase< Derived, ReadOnlyAccessors >:

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
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
EIGEN_STRONG_INLINE CoeffReturnType	operator[] (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index index) const
EIGEN_STRONG_INLINE CoeffReturnType	x () const
EIGEN_STRONG_INLINE CoeffReturnType	y () const
EIGEN_STRONG_INLINE CoeffReturnType	z () const
EIGEN_STRONG_INLINE CoeffReturnType	w () 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
template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType	packet (Index index) 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 ()

Detailed Description

template<typename Derived>
class 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

Member Typedef Documentation

template<typename Derived >

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

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

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 DenseCoeffsBase< Derived, ReadOnlyAccessors >::CoeffReturnType

template<typename Derived >

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

Reimplemented from EigenBase< Derived >.

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

template<typename Derived >

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

template<typename Derived >

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

Reimplemented in DenseCoeffsBase< Derived, WriteAccessors >.

template<typename Derived >

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

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

template<typename Derived >

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

Reimplemented from EigenBase< Derived >.

Reimplemented in DenseCoeffsBase< Derived, WriteAccessors >.

Member Function Documentation

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType 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

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType 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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType 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

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType 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)

template<typename Derived >

EIGEN_STRONG_INLINE CoeffReturnType 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

template<typename Derived >

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

template<typename Derived >

template<int LoadMode>

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

template<typename Derived >

template<int LoadMode>

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

template<typename Derived >

template<int LoadMode>

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

equivalent to operator[](3).

template<typename Derived >

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

template<typename Derived >

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

template<typename Derived >

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

equivalent to operator[](0).

template<typename Derived >

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

equivalent to operator[](1).

template<typename Derived >

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

equivalent to operator[](2).

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

/home/hauberg/Dokumenter/Capture/humim-tracker-0.1/src/ntk/geometry/Eigen/src/Core/DenseCoeffsBase.h

DenseCoeffsBase< Derived, ReadOnlyAccessors > Class Template Reference

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

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

Member Typedef Documentation

Member Function Documentation

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