Classes | Typedefs | Functions

/home/hauberg/Dokumenter/Capture/humim-tracker-0.1/src/ntk/geometry/Eigen/src/plugins/BlockMethods.h File Reference

Go to the source code of this file.

Classes

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

Typedefs

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

Functions

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

Typedef Documentation

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

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:
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)

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

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:
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)

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

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>().

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

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

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

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

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>().

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

This is the const version of bottomRows(Index).

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

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

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().

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

This is the const version of leftCols(Index).

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

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

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

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

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

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

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

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

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

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

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

This is the const version of rightCols(Index).

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

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

RowXpr 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().

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>().

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

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

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

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

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>().

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

This is the const version of topRows(Index).

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

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