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:
startRow the first row in the block
startCol the first column in the block
blockRows the number of rows in the block
blockCols the 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 75 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:
startRow the first row in the block
startCol the 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 556 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 257 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:
cRows the number of rows in the corner
cCols the number of columns in the corner

Example:

Output:

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

Definition at line 235 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:
cRows the number of rows in the corner
cCols the number of columns in the corner

Example:

Output:

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

Definition at line 190 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 212 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:
n the number of rows in the block

Example:

Output:

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

Definition at line 323 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:
N the number of rows in the block

Example:

Output:

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

Definition at line 345 of file BlockMethods.h.

ConstColXpr col ( Index  i  )  [inline]
ConstColsBlockXpr leftCols ( Index  n  )  [inline]

This is the const version of leftCols(Index).

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

Example:

Output:

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

Definition at line 413 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:
N the number of columns in the block

Example:

Output:

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

Definition at line 435 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:
N the number of columns in the block
Parameters:
startCol the index of the first column in the block

Example:

Output:

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

Definition at line 525 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:
startCol the index of the first column in the block
numCols the number of columns in the block

Example:

Output:

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

Definition at line 502 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:
startRow the index of the first row in the block
numRows the number of rows in the block

Example:

Output:

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

Definition at line 368 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:
N the number of rows in the block
Parameters:
startRow the index of the first row in the block

Example:

Output:

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

Definition at line 391 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:
n the number of columns in the block

Example:

Output:

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

Definition at line 457 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:
N the number of columns in the block

Example:

Output:

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

Definition at line 479 of file BlockMethods.h.

ConstRowXpr row ( Index  i  )  [inline]
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 167 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:
cRows the number of rows in the corner
cCols the number of columns in the corner

Example:

Output:

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

Definition at line 145 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:
cRows the number of rows in the corner
cCols the number of columns in the corner

Example:

Output:

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

Definition at line 99 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 121 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:
n the number of rows in the block

Example:

Output:

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

Definition at line 279 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:
N the number of rows in the block

Example:

Output:

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

Definition at line 301 of file BlockMethods.h.




Page generated by Doxygen 1.7.1 for MRPT 0.9.4 SVN: at Mon Jan 10 23:33:19 UTC 2011