MOAB  4.9.3pre
Public Types | Public Member Functions
Eigen::DenseCoeffsBase< Derived, WriteAccessors > Class Template Reference

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

#include <DenseCoeffsBase.h>

Inheritance diagram for Eigen::DenseCoeffsBase< Derived, WriteAccessors >:
Inheritance graph
[legend]
Collaboration diagram for Eigen::DenseCoeffsBase< Derived, WriteAccessors >:
Collaboration graph
[legend]

List of all members.

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 Member Functions

EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Scalar & 		coeffRef (Index row, Index col)
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)
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 ()
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Scalar & 		y ()
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Scalar & 		z ()
EIGEN_DEVICE_FUNC
EIGEN_STRONG_INLINE Scalar & 		w ()

Detailed Description

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

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

Template Parameters:
DerivedType of the derived class
WriteAccessorsConstant 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>, TopicClassHierarchy

Definition at line 300 of file DenseCoeffsBase.h.

Member Typedef Documentation

template<typename Derived >
typedef DenseCoeffsBase<Derived, ReadOnlyAccessors> Eigen::DenseCoeffsBase< Derived, WriteAccessors >::Base

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

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

Definition at line 304 of file DenseCoeffsBase.h.

template<typename Derived >
typedef internal::packet_traits<Scalar>::type Eigen::DenseCoeffsBase< Derived, WriteAccessors >::PacketScalar

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Definition at line 308 of file DenseCoeffsBase.h.

template<typename Derived >
typedef NumTraits<Scalar>::Real Eigen::DenseCoeffsBase< Derived, WriteAccessors >::RealScalar

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

Definition at line 309 of file DenseCoeffsBase.h.

template<typename Derived >
typedef internal::traits<Derived>::Scalar Eigen::DenseCoeffsBase< Derived, WriteAccessors >::Scalar

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

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

Definition at line 307 of file DenseCoeffsBase.h.

template<typename Derived >
typedef internal::traits<Derived>::StorageKind Eigen::DenseCoeffsBase< Derived, WriteAccessors >::StorageKind

Reimplemented from Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >.

Definition at line 306 of file DenseCoeffsBase.h.

Member Function Documentation

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)

Definition at line 340 of file DenseCoeffsBase.h.

    {
      eigen_internal_assert(row >= 0 && row < rows()
                         && col >= 0 && col < cols());
      return internal::evaluator<Derived>(derived()).coeffRef(row,col);
    }
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)

Definition at line 387 of file DenseCoeffsBase.h.

    {
      EIGEN_STATIC_ASSERT(internal::evaluator<Derived>::Flags & LinearAccessBit,
                          THIS_COEFFICIENT_ACCESSOR_TAKING_ONE_ACCESS_IS_ONLY_FOR_EXPRESSIONS_ALLOWING_LINEAR_ACCESS)
      eigen_internal_assert(index >= 0 && index < size());
      return internal::evaluator<Derived>(derived()).coeffRef(index);
    }
template<typename Derived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::coeffRefByOuterInner ( Index  outer,
Index  inner 
) [inline]

Definition at line 349 of file DenseCoeffsBase.h.

    {
      return coeffRef(rowIndexByOuterInner(outer, inner),
                      colIndexByOuterInner(outer, inner));
    }
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)

Definition at line 362 of file DenseCoeffsBase.h.

    {
      eigen_assert(row >= 0 && row < rows()
          && col >= 0 && col < cols());
      return coeffRef(row, col);
    }
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()

Definition at line 423 of file DenseCoeffsBase.h.

    {
      eigen_assert(index >= 0 && index < size());
      return coeffRef(index);
    }
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()

Definition at line 404 of file DenseCoeffsBase.h.

    {
      EIGEN_STATIC_ASSERT(Derived::IsVectorAtCompileTime,
                          THE_BRACKET_OPERATOR_IS_ONLY_FOR_VECTORS__USE_THE_PARENTHESIS_OPERATOR_INSTEAD)
      eigen_assert(index >= 0 && index < size());
      return coeffRef(index);
    }
template<typename Derived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::w ( ) [inline]

equivalent to operator[](3).

Definition at line 459 of file DenseCoeffsBase.h.

    {
      EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=4, OUT_OF_RANGE_ACCESS);
      return (*this)[3];
    }
template<typename Derived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::x ( ) [inline]

equivalent to operator[](0).

Definition at line 433 of file DenseCoeffsBase.h.

{ return (*this)[0]; }
template<typename Derived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::y ( ) [inline]

equivalent to operator[](1).

Definition at line 439 of file DenseCoeffsBase.h.

    {
      EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=2, OUT_OF_RANGE_ACCESS);
      return (*this)[1];
    }
template<typename Derived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Scalar& Eigen::DenseCoeffsBase< Derived, WriteAccessors >::z ( ) [inline]

equivalent to operator[](2).

Definition at line 449 of file DenseCoeffsBase.h.

    {
      EIGEN_STATIC_ASSERT(Derived::SizeAtCompileTime==-1 || Derived::SizeAtCompileTime>=3, OUT_OF_RANGE_ACCESS);
      return (*this)[2];
    }
The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines