Base class providing read/write coefficient access to matrices and arrays. More...

#include <DenseCoeffsBase.h>

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

Public Types
typedef DenseCoeffsBase< Derived, ReadOnlyAccessors >	Base

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

typedef internal::traits< Derived >::Scalar	Scalar

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef NumTraits< Scalar >::Real	RealScalar

Public Types inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
typedef internal::traits< Derived >::StorageKind	StorageKind

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 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 Scalar &	coeffRef (Index row, Index col)
	Short version: don't use this function, use operator()(Index,Index) instead. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRefByOuterInner (Index outer, Index inner)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index row, Index col)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	coeffRef (Index index)
	Short version: don't use this function, use operator[](Index) instead. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator[] (Index index)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	operator() (Index index)

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	x ()
	equivalent to operator[](0). More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	y ()
	equivalent to operator[](1). More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	z ()
	equivalent to operator[](2). More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar &	w ()
	equivalent to operator[](3). More...

Public Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index	rowIndexByOuterInner (Index outer, Index inner) const

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

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index row, Index col) const
	Short version: don't use this function, use operator()(Index,Index) const instead. More...

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

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

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	coeff (Index index) const
	Short version: don't use this function, use operator[](Index) const instead. More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator[] (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	operator() (Index index) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	x () const
	equivalent to operator[](0). More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	y () const
	equivalent to operator[](1). More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	z () const
	equivalent to operator[](2). More...

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE CoeffReturnType	w () const
	equivalent to operator[](3). More...

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

Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC Index	size () const

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

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

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

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

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

Additional Inherited Members
Protected Member Functions inherited from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >
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 Eigen::DenseCoeffsBase< Derived, WriteAccessors >

Base class providing read/write coefficient access to matrices and arrays.

Template Parameters

Derived	Type of the derived class
WriteAccessors	Constant indicating read/write access

This class defines the non-const operator() function and friends, which can be used to write specific entries of a matrix or array. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which defines the const variant for reading specific entries.

See also: DenseCoeffsBase<Derived, DirectAccessors>, The class hierarchy

Member Function Documentation

§ coeffRef() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::coeffRef	(	Index	row,
		Index	col
	)

inline

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

Long version: this function is similar to operator()(Index,Index), 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).

See also: operator()(Index,Index), coeff(Index, Index) const, coeffRef(Index)

§ coeffRef() [2/2]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::coeffRef ( Index index )

inline

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

Long version: this function is similar to operator[](Index), 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).

See also: operator[](Index), coeff(Index) const, coeffRef(Index,Index)

§ operator()() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator()	(	Index	row,
		Index	col
	)

inline

Returns: a reference to the coefficient at given the given row and column.

See also: operator[](Index)

§ operator()() [2/2]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator() ( Index index )

inline

Returns: a reference to the coefficient at given index.

This is synonymous to operator[](Index).

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

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

§ operator[]()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::operator[] ( Index index )

inline

Returns: a reference to the coefficient at given index.

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

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

§ w()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::w ( )

inline

equivalent to operator[](3).

§ x()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::x ( )

inline

equivalent to operator[](0).

§ y()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::y ( )

inline

equivalent to operator[](1).

§ z()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::z ( )

inline

equivalent to operator[](2).

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

third-party-libs/eigen3/Eigen/src/Core/DenseCoeffsBase.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Function Documentation

§ coeffRef() [1/2]

§ coeffRef() [2/2]

§ operator()() [1/2]

§ operator()() [2/2]

§ operator[]()

§ w()

§ x()

§ y()

§ z()

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