Classes | Typedefs | Functions
BlockMethods.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ConstNColsBlockXpr< N >
struct  ConstNRowsBlockXpr< N >
struct  NColsBlockXpr< N >
struct  NRowsBlockXpr< N >

Typedefs

typedef Block< Derived,
internal::traits< Derived >
::RowsAtCompileTime, Dynamic,!IsRowMajor > 
ColsBlockXpr
typedef Block< Derived,
internal::traits< Derived >
::RowsAtCompileTime,
1,!IsRowMajor > 
ColXpr
typedef const Block< const
Derived, internal::traits
< Derived >::RowsAtCompileTime,
Dynamic,!IsRowMajor > 
ConstColsBlockXpr
typedef const Block< const
Derived, internal::traits
< Derived >::RowsAtCompileTime,
1,!IsRowMajor > 
ConstColXpr
typedef const Block< const
Derived, Dynamic,
internal::traits< Derived >
::ColsAtCompileTime,
IsRowMajor > 
ConstRowsBlockXpr
typedef const Block< const
Derived, 1, internal::traits
< Derived >::ColsAtCompileTime,
IsRowMajor > 
ConstRowXpr
typedef Block< Derived,
Dynamic, internal::traits
< Derived >::ColsAtCompileTime,
IsRowMajor > 
RowsBlockXpr
typedef Block< Derived,
1, internal::traits< Derived >
::ColsAtCompileTime,
IsRowMajor > 
RowXpr

Functions

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

Typedef Documentation

typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ColsBlockXpr

Definition at line 23 of file BlockMethods.h.

typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ColXpr

Definition at line 17 of file BlockMethods.h.

typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ConstColsBlockXpr

Definition at line 24 of file BlockMethods.h.

typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ConstColXpr

Definition at line 18 of file BlockMethods.h.

typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowsBlockXpr

Definition at line 27 of file BlockMethods.h.

typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowXpr

Definition at line 21 of file BlockMethods.h.

typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowsBlockXpr

Definition at line 26 of file BlockMethods.h.

typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowXpr

Definition at line 20 of file BlockMethods.h.


Function Documentation

const Block< const Derived > block ( Index  startRow,
Index  startCol,
Index  blockRows,
Index  blockCols 
) [inline]
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)

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

Definition at line 54 of file BlockMethods.h.

template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols > block ( Index  startRow,
Index  startCol 
) [inline]
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)

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

Definition at line 534 of file BlockMethods.h.

const Block< const Derived > bottomLeftCorner ( Index  cRows,
Index  cCols 
) [inline]
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)

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

Definition at line 214 of file BlockMethods.h.

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomLeftCorner ( ) [inline]
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)

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

Definition at line 235 of file BlockMethods.h.

const Block< const Derived > bottomRightCorner ( Index  cRows,
Index  cCols 
) [inline]
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)

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

Definition at line 169 of file BlockMethods.h.

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > bottomRightCorner ( ) [inline]
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)

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

Definition at line 190 of file BlockMethods.h.

ConstRowsBlockXpr bottomRows ( Index  n) [inline]
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)

This is the const version of bottomRows(Index).

Definition at line 302 of file BlockMethods.h.

template<int N>
ConstNRowsBlockXpr< N >::Type bottomRows ( ) [inline]
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)

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

Definition at line 323 of file BlockMethods.h.

ConstColXpr col ( Index  i) [inline]
Returns:
an expression of the i-th column of *this. Note that the numbering starts at 0.

Example:

Output:

See also:
row(), class Block

This is the const version of col().

Definition at line 552 of file BlockMethods.h.

ConstColsBlockXpr leftCols ( Index  n) [inline]
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)

This is the const version of leftCols(Index).

Definition at line 392 of file BlockMethods.h.

template<int N>
ConstNColsBlockXpr< N >::Type leftCols ( ) [inline]
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)

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

Definition at line 413 of file BlockMethods.h.

ConstColsBlockXpr middleCols ( Index  startCol,
Index  numCols 
) [inline]
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)

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

Definition at line 481 of file BlockMethods.h.

template<int N>
ConstNColsBlockXpr< N >::Type middleCols ( Index  startCol) [inline]
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)

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

Definition at line 503 of file BlockMethods.h.

ConstRowsBlockXpr middleRows ( Index  startRow,
Index  numRows 
) [inline]
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)

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

Definition at line 347 of file BlockMethods.h.

template<int N>
ConstNRowsBlockXpr< N >::Type middleRows ( Index  startRow) [inline]
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)

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

Definition at line 369 of file BlockMethods.h.

ConstColsBlockXpr rightCols ( Index  n) [inline]
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)

This is the const version of rightCols(Index).

Definition at line 436 of file BlockMethods.h.

template<int N>
ConstNColsBlockXpr< N >::Type rightCols ( ) [inline]
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)

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

Definition at line 457 of file BlockMethods.h.

ConstRowXpr row ( Index  i) [inline]
Returns:
an expression of the i-th row of *this. Note that the numbering starts at 0.

Example:

Output:

See also:
col(), class Block

This is the const version of row().

Definition at line 569 of file BlockMethods.h.

const Block< const Derived > topLeftCorner ( Index  cRows,
Index  cCols 
) [inline]
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)

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

Definition at line 124 of file BlockMethods.h.

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topLeftCorner ( ) [inline]
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)

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

Definition at line 145 of file BlockMethods.h.

const Block< const Derived > topRightCorner ( Index  cRows,
Index  cCols 
) [inline]
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)

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

Definition at line 78 of file BlockMethods.h.

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols > topRightCorner ( ) [inline]
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)

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

Definition at line 99 of file BlockMethods.h.

ConstRowsBlockXpr topRows ( Index  n) [inline]
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)

This is the const version of topRows(Index).

Definition at line 258 of file BlockMethods.h.

template<int N>
ConstNRowsBlockXpr< N >::Type topRows ( ) [inline]
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)

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

Definition at line 279 of file BlockMethods.h.



win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:26:59