Public Types | Public Member Functions | Protected Attributes | List of all members
Block< XprType, BlockRows, BlockCols, InnerPanel, HasDirectAccess > Class Template Reference

Expression of a fixed-size or dynamic-size block. More...

#include <Block.h>

Inherits type< Block< XprType, BlockRows, BlockCols, InnerPanel, HasDirectAccess > >.

Public Types

typedef
internal::dense_xpr_base
< Block >::type 
Base

Public Member Functions

 Block (XprType &xpr, Index i)
 Block (XprType &xpr, Index startRow, Index startCol)
 Block (XprType &xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
const CoeffReturnType coeff (Index row, Index col) const
const CoeffReturnType coeff (Index index) const
Scalar & coeffRef (Index row, Index col)
const Scalar & coeffRef (Index row, Index col) const
Scalar & coeffRef (Index index)
const Scalar & coeffRef (Index index) const
Index cols () const
const Scalar * data () const
Index innerStride () const
const internal::remove_all
< typename XprType::Nested >
::type & 
nestedExpression () const
Index outerStride () const
template<int LoadMode>
PacketScalar packet (Index row, Index col) const
template<int LoadMode>
PacketScalar packet (Index index) const
Index rows () const
Index startCol () const
Index startRow () const
template<int LoadMode>
void writePacket (Index row, Index col, const PacketScalar &x)
template<int LoadMode>
void writePacket (Index index, const PacketScalar &x)

Protected Attributes

const
internal::variable_if_dynamic
< Index, ColsAtCompileTime > 
m_blockCols
const
internal::variable_if_dynamic
< Index, RowsAtCompileTime > 
m_blockRows
const
internal::variable_if_dynamic
< Index,
XprType::ColsAtCompileTime==1?0:Dynamic
m_startCol
const
internal::variable_if_dynamic
< Index,
XprType::RowsAtCompileTime==1?0:Dynamic
m_startRow
const XprType::Nested m_xpr

Detailed Description

template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel, bool HasDirectAccess>
class Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel, HasDirectAccess >

Expression of a fixed-size or dynamic-size block.

Parameters
XprTypethe type of the expression in which we are taking a block
BlockRowsthe number of rows of the block we are taking at compile time (optional)
BlockColsthe number of columns of the block we are taking at compile time (optional)
_DirectAccessStatus

Member Typedef Documentation

typedef internal::dense_xpr_base<Block>::type Base

Constructor & Destructor Documentation

Block ( XprType &  xpr,
Index  i 
)
inline

Column or Row constructor

References eigen_assert.

Block ( XprType &  xpr,
Index  startRow,
Index  startCol 
)
inline

Fixed-size constructor

References Eigen::Dynamic, eigen_assert, and EIGEN_STATIC_ASSERT.

Block ( XprType &  xpr,
Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
)
inline

Dynamic-size constructor

References Eigen::Dynamic, and eigen_assert.

Member Function Documentation

const CoeffReturnType coeff ( Index  row,
Index  col 
) const
inline
const CoeffReturnType coeff ( Index  index) const
inline
Scalar& coeffRef ( Index  row,
Index  col 
)
inline
const Scalar& coeffRef ( Index  row,
Index  col 
) const
inline
Scalar& coeffRef ( Index  index)
inline
const Scalar& coeffRef ( Index  index) const
inline
Index cols ( ) const
inline
const Scalar* data ( ) const
inline
See Also
MapBase::data()
Index innerStride ( ) const
inline
const internal::remove_all<typename XprType::Nested>::type& nestedExpression ( ) const
inline
Index outerStride ( ) const
inline
PacketScalar packet ( Index  row,
Index  col 
) const
inline
PacketScalar packet ( Index  index) const
inline
Index rows ( ) const
inline
Index startCol ( ) const
inline
Index startRow ( ) const
inline
void writePacket ( Index  row,
Index  col,
const PacketScalar &  x 
)
inline
void writePacket ( Index  index,
const PacketScalar &  x 
)
inline

Member Data Documentation

const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_blockCols
protected
const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_blockRows
protected
const internal::variable_if_dynamic<Index, XprType::ColsAtCompileTime == 1 ? 0 : Dynamic> m_startCol
protected
const internal::variable_if_dynamic<Index, XprType::RowsAtCompileTime == 1 ? 0 : Dynamic> m_startRow
protected
const XprType::Nested m_xpr
protected

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