Block Class Template Reference

Inherits MatrixBase< Eigen::Block< MatrixType, BlockRows, BlockCols, PacketAccess, _DirectAccessStatus > >.

List of all members.


Detailed Description

template<typename MatrixType, int BlockRows, int BlockCols, int PacketAccess, int _DirectAccessStatus>
class Eigen::Block< MatrixType, BlockRows, BlockCols, PacketAccess, _DirectAccessStatus >

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

Parameters:
MatrixType the type of the object in which we are taking a block
BlockRows the number of rows of the block we are taking at compile time (optional)
BlockCols the number of columns of the block we are taking at compile time (optional)
_PacketAccess allows to enforce aligned loads and stores if set to ForceAligned. The default is AsRequested. This parameter is internaly used by Eigen in expressions such as
 mat.block() += other; 
and most of the time this is the only way it is used.
_DirectAccessStatus 

Public Member Functions

 Block (const MatrixType &matrix, int startRow, int startCol, int blockRows, int blockCols)
 Block (const MatrixType &matrix, int startRow, int startCol)
 Block (const MatrixType &matrix, int i)
const Scalar coeff (int index) const
const Scalar coeff (int row, int col) const
Scalar & coeffRef (int index)
Scalar & coeffRef (int row, int col)
int cols () const
template<int LoadMode>
PacketScalar packet (int index) const
template<int LoadMode>
PacketScalar packet (int row, int col) const
int rows () const
template<int LoadMode>
void writePacket (int index, const PacketScalar &x)
template<int LoadMode>
void writePacket (int row, int col, const PacketScalar &x)

Protected Attributes

const ei_int_if_dynamic
< ColsAtCompileTime > 
m_blockCols
const ei_int_if_dynamic
< RowsAtCompileTime > 
m_blockRows
const MatrixType::Nested m_matrix
const ei_int_if_dynamic
< MatrixType::ColsAtCompileTime==1?0:Dynamic > 
m_startCol
const ei_int_if_dynamic
< MatrixType::RowsAtCompileTime==1?0:Dynamic > 
m_startRow

Constructor & Destructor Documentation

Block ( const MatrixType &  matrix,
int  i 
) [inline]

Column or Row constructor

Block ( const MatrixType &  matrix,
int  startRow,
int  startCol 
) [inline]

Fixed-size constructor

Block ( const MatrixType &  matrix,
int  startRow,
int  startCol,
int  blockRows,
int  blockCols 
) [inline]

Dynamic-size constructor


Member Function Documentation

const Scalar coeff ( int  index  )  const [inline]

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

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

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

Reimplemented from MatrixBase.

const Scalar coeff ( int  row,
int  col 
) const [inline]

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

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

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

Reimplemented from MatrixBase.

Scalar& coeffRef ( int  index  )  [inline]

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

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

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

Reimplemented from MatrixBase.

Scalar& coeffRef ( int  row,
int  col 
) [inline]

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

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

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

Reimplemented from MatrixBase.

int cols (  )  const [inline]

Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from MatrixBase.

PacketScalar packet ( int  index  )  const [inline]

Returns:
the packet of coefficients starting at the given index. It is your responsibility to ensure that a packet really starts there. This method is only available on expressions having the PacketAccessBit and the LinearAccessBit.
The LoadMode parameter may have the value Aligned or Unaligned. Its effect is to select the appropriate vectorization instruction. Aligned access is faster, but is only possible for packets starting at an address which is a multiple of the packet size.

Reimplemented from MatrixBase.

PacketScalar packet ( int  row,
int  col 
) const [inline]

Returns:
the packet of coefficients starting at the given row and column. It is your responsibility to ensure that a packet really starts there. This method is only available on expressions having the PacketAccessBit.
The LoadMode parameter may have the value Aligned or Unaligned. Its effect is to select the appropriate vectorization instruction. Aligned access is faster, but is only possible for packets starting at an address which is a multiple of the packet size.

Reimplemented from MatrixBase.

int rows ( void   )  const [inline]

Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from MatrixBase.


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

Generated on Thu Apr 9 10:10:01 2009 for Eigen by  doxygen 1.5.5