Main MRPT website > C++ reference
MRPT logo
Functions

BlockMethods.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

Block< Derived > block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 This is the const version of block(Index,Index,Index,Index).
Block< Derived > topRightCorner (Index cRows, Index cCols) const
 This is the const version of topRightCorner(Index, Index).
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topRightCorner () const
 This is the const version of topRightCorner<int, int>().
Block< Derived > topLeftCorner (Index cRows, Index cCols) const
 This is the const version of topLeftCorner(Index, Index).
template<int CRows, int CCols>
Block< Derived, CRows, CCols > topLeftCorner () const
 This is the const version of topLeftCorner<int, int>().
Block< Derived > bottomRightCorner (Index cRows, Index cCols) const
 This is the const version of bottomRightCorner(Index, Index).
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomRightCorner () const
 This is the const version of bottomRightCorner<int, int>().
Block< Derived > bottomLeftCorner (Index cRows, Index cCols) const
 This is the const version of bottomLeftCorner(Index, Index).
template<int CRows, int CCols>
Block< Derived, CRows, CCols > bottomLeftCorner () const
 This is the const version of bottomLeftCorner<int, int>().
RowsBlockXpr topRows (Index n) const
 This is the const version of topRows(Index).
template<int N>
NRowsBlockXpr< N >::Type topRows () const
 This is the const version of topRows<int>().
RowsBlockXpr bottomRows (Index n) const
 This is the const version of bottomRows(Index).
template<int N>
NRowsBlockXpr< N >::Type bottomRows () const
 This is the const version of bottomRows<int>().
RowsBlockXpr middleRows (Index startRow, Index numRows) const
 This is the const version of middleRows(Index,Index).
template<int N>
NRowsBlockXpr< N >::Type middleRows (Index startRow) const
 This is the const version of middleRows<int>().
ColsBlockXpr leftCols (Index n) const
 This is the const version of leftCols(Index).
template<int N>
NColsBlockXpr< N >::Type leftCols () const
 This is the const version of leftCols<int>().
ColsBlockXpr rightCols (Index n) const
 This is the const version of rightCols(Index).
template<int N>
NColsBlockXpr< N >::Type rightCols () const
 This is the const version of rightCols<int>().
ColsBlockXpr middleCols (Index startCol, Index numCols) const
 This is the const version of middleCols(Index,Index).
template<int N>
NColsBlockXpr< N >::Type middleCols (Index startCol) const
 This is the const version of middleCols<int>().
template<int BlockRows, int BlockCols>
Block< Derived, BlockRows,
BlockCols > 
block (Index startRow, Index startCol) const
 This is the const version of block<>(Index, Index).
ColXpr col (Index i) const
 This is the const version of col().
RowXpr row (Index i) const
 This is the const version of row().

Function Documentation

const Block< const Derived > block ( Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
) [inline]

This is the const version of block(Index,Index,Index,Index).

Returns:
a dynamic-size expression of a block in *this.
Parameters:
startRowthe first row in the block
startColthe first column in the block
blockRowsthe number of rows in the block
blockColsthe number of columns in the block

Example:

Output:

Note:
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size matrix, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.
See also:
class Block, block(Index,Index)

Definition at line 69 of file BlockMethods.h.

Referenced by internal::kernel_retval< FullPivLU< _MatrixType > >::evalTo(), and CommaInitializer< XprType >::operator,().

template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols > block ( Index  startRow,
Index  startCol 
) [inline]

This is the const version of block<>(Index, Index).

Returns:
a fixed-size expression of a block in *this.

The template parameters BlockRows and BlockCols are the number of rows and columns in the block.

Parameters:
startRowthe first row in the block
startColthe first column in the block

Example:

Output:

Note:
since block is a templated member, the keyword template has to be used if the matrix type is also a template parameter:
 m.template block<3,3>(1,1); 
See also:
class Block, block(Index,Index,Index,Index)

Definition at line 549 of file BlockMethods.h.

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomLeftCorner ( ) [inline]

This is the const version of bottomLeftCorner<int, int>().

Returns:
an expression of a fixed-size bottom-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 250 of file BlockMethods.h.

const Block< const Derived > bottomLeftCorner ( Index  cRows,
Index  cCols 
) [inline]

This is the const version of bottomLeftCorner(Index, Index).

Returns:
a dynamic-size expression of a bottom-left corner of *this.
Parameters:
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 229 of file BlockMethods.h.

const Block< const Derived > bottomRightCorner ( Index  cRows,
Index  cCols 
) [inline]

This is the const version of bottomRightCorner(Index, Index).

Returns:
a dynamic-size expression of a bottom-right corner of *this.
Parameters:
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 184 of file BlockMethods.h.

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomRightCorner ( ) [inline]

This is the const version of bottomRightCorner<int, int>().

Returns:
an expression of a fixed-size bottom-right corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 205 of file BlockMethods.h.

ConstRowsBlockXpr bottomRows ( Index  n) [inline]

This is the const version of bottomRows(Index).

Returns:
a block consisting of the bottom rows of *this.
Parameters:
nthe number of rows in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 317 of file BlockMethods.h.

template<int N>
ConstNRowsBlockXpr< N >::Type bottomRows ( ) [inline]

This is the const version of bottomRows<int>().

Returns:
a block consisting of the bottom rows of *this.
Template Parameters:
Nthe number of rows in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 338 of file BlockMethods.h.

ConstColXpr col ( Index  i) [inline]

This is the const version of col().

Returns:
an expression of the i-th column of *this. Note that the numbering starts at 0.

Example:

Output:

See also:
row(), class Block

Definition at line 567 of file BlockMethods.h.

Referenced by MatrixBase< Derived >::applyHouseholderOnTheRight(), MatrixBase< Derived >::applyOnTheRight(), mrpt::math::CMatrixTemplate< TPoint3D >::CMatrixTemplate(), Reverse< MatrixType, Direction >::coeff(), CoeffBasedProduct< LhsNested, RhsNested, NestingFlags >::coeff(), Reverse< MatrixType, Direction >::coeffRef(), SwapWrapper< ExpressionType >::copyPacket(), SelfCwiseBinaryOp< BinaryOp, Lhs, Rhs >::copyPacket(), internal::solve_retval< FullPivHouseholderQR< _MatrixType >, Rhs >::evalTo(), get_unsafe(), mrpt::math::CMatrixTemplate< TPoint3D >::get_unsafe(), insertCol(), meanAndStd(), internal::gemm_functor< Scalar, Index, Gemm, Lhs, Rhs, Dest, BlockingType >::operator()(), mrpt::math::CMatrixTemplate< TPoint3D >::operator()(), TransposeImpl< MatrixType, Dense >::packet(), Reverse< MatrixType, Direction >::packet(), NestByValue< ExpressionType >::packet(), ForceAlignedAccess< ExpressionType >::packet(), Flagged< ExpressionType, Added, Removed >::packet(), DenseCoeffsBase< Derived, ReadOnlyAccessors >::packet(), CoeffBasedProduct< LhsNested, RhsNested, NestingFlags >::packet(), mrpt::math::CMatrixTemplate< TPoint3D >::realloc(), TransposeImpl< MatrixType, Sparse >::ReverseInnerIterator::row(), TransposeImpl< MatrixType, Sparse >::InnerIterator::row(), internal::sparse_solve_triangular_sparse_selector< Lhs, Rhs, Mode, UpLo, ColMajor >::run(), internal::sparse_solve_triangular_selector< Lhs, Rhs, Mode, Upper, ColMajor >::run(), internal::sparse_solve_triangular_selector< Lhs, Rhs, Mode, Lower, ColMajor >::run(), internal::sparse_solve_triangular_selector< Lhs, Rhs, Mode, Upper, RowMajor >::run(), internal::sparse_solve_triangular_selector< Lhs, Rhs, Mode, Lower, RowMajor >::run(), internal::triangular_assignment_selector< Derived1, Derived2,(SelfAdjoint|Lower), UnrollCount, ClearOpposite >::run(), internal::triangular_assignment_selector< Derived1, Derived2,(SelfAdjoint|Upper), UnrollCount, ClearOpposite >::run(), set_unsafe(), mrpt::math::CMatrixTemplate< TPoint3D >::set_unsafe(), setSize(), swapCols(), TransposeImpl< MatrixType, Dense >::writePacket(), Reverse< MatrixType, Direction >::writePacket(), NestByValue< ExpressionType >::writePacket(), ForceAlignedAccess< ExpressionType >::writePacket(), Flagged< ExpressionType, Added, Removed >::writePacket(), and DenseCoeffsBase< Derived, WriteAccessors >::writePacket().

ConstColsBlockXpr leftCols ( Index  n) [inline]

This is the const version of leftCols(Index).

Returns:
a block consisting of the left columns of *this.
Parameters:
nthe number of columns in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 407 of file BlockMethods.h.

Referenced by internal::solve_retval< HouseholderQR< _MatrixType >, Rhs >::evalTo().

template<int N>
ConstNColsBlockXpr< N >::Type leftCols ( ) [inline]

This is the const version of leftCols<int>().

Returns:
a block consisting of the left columns of *this.
Template Parameters:
Nthe number of columns in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 428 of file BlockMethods.h.

template<int N>
ConstNColsBlockXpr< N >::Type middleCols ( Index  startCol) [inline]

This is the const version of middleCols<int>().

Returns:
a block consisting of a range of columns of *this.
Template Parameters:
Nthe number of columns in the block
Parameters:
startColthe index of the first column in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 518 of file BlockMethods.h.

ConstColsBlockXpr middleCols ( Index  startCol,
Index  numCols 
) [inline]

This is the const version of middleCols(Index,Index).

Returns:
a block consisting of a range of columns of *this.
Parameters:
startColthe index of the first column in the block
numColsthe number of columns in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 496 of file BlockMethods.h.

ConstRowsBlockXpr middleRows ( Index  startRow,
Index  numRows 
) [inline]

This is the const version of middleRows(Index,Index).

Returns:
a block consisting of a range of rows of *this.
Parameters:
startRowthe index of the first row in the block
numRowsthe number of rows in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 362 of file BlockMethods.h.

template<int N>
ConstNRowsBlockXpr< N >::Type middleRows ( Index  startRow) [inline]

This is the const version of middleRows<int>().

Returns:
a block consisting of a range of rows of *this.
Template Parameters:
Nthe number of rows in the block
Parameters:
startRowthe index of the first row in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 384 of file BlockMethods.h.

ConstColsBlockXpr rightCols ( Index  n) [inline]

This is the const version of rightCols(Index).

Returns:
a block consisting of the right columns of *this.
Parameters:
nthe number of columns in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 451 of file BlockMethods.h.

template<int N>
ConstNColsBlockXpr< N >::Type rightCols ( ) [inline]

This is the const version of rightCols<int>().

Returns:
a block consisting of the right columns of *this.
Template Parameters:
Nthe number of columns in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 472 of file BlockMethods.h.

ConstRowXpr row ( Index  i) [inline]

This is the const version of row().

Returns:
an expression of the i-th row of *this. Note that the numbering starts at 0.

Example:

Output:

See also:
col(), class Block

Definition at line 584 of file BlockMethods.h.

Referenced by mrpt::math::CMatrixTemplate< TPoint3D >::appendRow(), MatrixBase< Derived >::applyHouseholderOnTheLeft(), MatrixBase< Derived >::applyOnTheLeft(), mrpt::math::CMatrixTemplate< TPoint3D >::CMatrixTemplate(), Reverse< MatrixType, Direction >::coeff(), CoeffBasedProduct< LhsNested, RhsNested, NestingFlags >::coeff(), Reverse< MatrixType, Direction >::coeffRef(), TransposeImpl< MatrixType, Sparse >::ReverseInnerIterator::col(), TransposeImpl< MatrixType, Sparse >::InnerIterator::col(), SparseDenseOuterProduct< Lhs, Rhs, Tr >::InnerIterator::col(), SwapWrapper< ExpressionType >::copyPacket(), SelfCwiseBinaryOp< BinaryOp, Lhs, Rhs >::copyPacket(), get_unsafe(), mrpt::math::CMatrixTemplate< TPoint3D >::get_unsafe(), mrpt::math::CMatrixTemplate< TPoint3D >::get_unsafe_row(), insertRow(), mrpt::math::CMatrixTemplate< TPoint3D >::operator()(), TransposeImpl< MatrixType, Dense >::packet(), Reverse< MatrixType, Direction >::packet(), NestByValue< ExpressionType >::packet(), ForceAlignedAccess< ExpressionType >::packet(), Flagged< ExpressionType, Added, Removed >::packet(), DenseCoeffsBase< Derived, ReadOnlyAccessors >::packet(), CoeffBasedProduct< LhsNested, RhsNested, NestingFlags >::packet(), mrpt::math::CMatrixTemplate< TPoint3D >::realloc(), SparseDenseOuterProduct< Lhs, Rhs, Tr >::InnerIterator::row(), internal::triangular_assignment_selector< Derived1, Derived2,(SelfAdjoint|Lower), UnrollCount, ClearOpposite >::run(), internal::triangular_assignment_selector< Derived1, Derived2,(SelfAdjoint|Upper), UnrollCount, ClearOpposite >::run(), set_unsafe(), mrpt::math::CMatrixTemplate< TPoint3D >::set_unsafe(), setSize(), swapRows(), mrpt::math::transform_gaussian_unscented(), TransposeImpl< MatrixType, Dense >::writePacket(), Reverse< MatrixType, Direction >::writePacket(), NestByValue< ExpressionType >::writePacket(), ForceAlignedAccess< ExpressionType >::writePacket(), Flagged< ExpressionType, Added, Removed >::writePacket(), and DenseCoeffsBase< Derived, WriteAccessors >::writePacket().

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topLeftCorner ( ) [inline]

This is the const version of topLeftCorner<int, int>().

Returns:
an expression of a fixed-size top-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 160 of file BlockMethods.h.

const Block< const Derived > topLeftCorner ( Index  cRows,
Index  cCols 
) [inline]

This is the const version of topLeftCorner(Index, Index).

Returns:
a dynamic-size expression of a top-left corner of *this.
Parameters:
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 139 of file BlockMethods.h.

const Block< const Derived > topRightCorner ( Index  cRows,
Index  cCols 
) [inline]

This is the const version of topRightCorner(Index, Index).

Returns:
a dynamic-size expression of a top-right corner of *this.
Parameters:
cRowsthe number of rows in the corner
cColsthe number of columns in the corner

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 93 of file BlockMethods.h.

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topRightCorner ( ) [inline]

This is the const version of topRightCorner<int, int>().

Returns:
an expression of a fixed-size top-right corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 114 of file BlockMethods.h.

ConstRowsBlockXpr topRows ( Index  n) [inline]

This is the const version of topRows(Index).

Returns:
a block consisting of the top rows of *this.
Parameters:
nthe number of rows in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 273 of file BlockMethods.h.

template<int N>
ConstNRowsBlockXpr< N >::Type topRows ( ) [inline]

This is the const version of topRows<int>().

Returns:
a block consisting of the top rows of *this.
Template Parameters:
Nthe number of rows in the block

Example:

Output:

See also:
class Block, block(Index,Index,Index,Index)

Definition at line 294 of file BlockMethods.h.




Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011