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  ConstFixedSegmentReturnType< Size >
struct  ConstNColsBlockXpr< N >
struct  ConstNRowsBlockXpr< N >
struct  FixedSegmentReturnType< Size >
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 const VectorBlock
< const Derived > 		ConstSegmentReturnType
typedef Block< Derived,
Dynamic, internal::traits
< Derived >::ColsAtCompileTime,
IsRowMajor > 		RowsBlockXpr
typedef Block< Derived,
1, internal::traits< Derived >
::ColsAtCompileTime,
IsRowMajor > 		RowXpr
typedef VectorBlock< Derived > SegmentReturnType

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)
ColXpr col (Index i)
SegmentReturnType head (Index n)
ColsBlockXpr leftCols (Index n)
ColsBlockXpr middleCols (Index startCol, Index numCols)
RowsBlockXpr middleRows (Index startRow, Index n)
ColsBlockXpr rightCols (Index n)
RowXpr row (Index i)
SegmentReturnType segment (Index start, Index n)
SegmentReturnType tail (Index n)
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)

Typedef Documentation

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

Definition at line 21 of file BlockMethods.h.

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

Definition at line 15 of file BlockMethods.h.

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

Definition at line 22 of file BlockMethods.h.

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

Definition at line 16 of file BlockMethods.h.

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

Definition at line 25 of file BlockMethods.h.

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

Definition at line 19 of file BlockMethods.h.

typedef const VectorBlock<const Derived> ConstSegmentReturnType

Definition at line 34 of file BlockMethods.h.

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

Definition at line 24 of file BlockMethods.h.

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

Definition at line 18 of file BlockMethods.h.

typedef VectorBlock<Derived> SegmentReturnType

Definition at line 33 of file BlockMethods.h.

Function Documentation

const Block< const Derived, BlockRows, BlockCols > 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).


Returns:
an expression of a block in *this.


Template Parameters:

  

    
BlockRowsnumber of rows in block as specified at compile-time 

    
BlockColsnumber of columns in block as specified at compile-time 

  

  




Parameters:

  

    
startRowthe first row in the block 

    
startColthe first column in the block 

    
blockRowsnumber of rows in block as specified at run-time 

    
blockColsnumber of columns in block as specified at run-time

  

  




This function is mainly useful for blocks where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, blockRows should equal BlockRows unless BlockRows is Dynamic, and the same for the number of columns.


Example: 


 Output: 


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


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



Definition at line 56 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 680 of file BlockMethods.h.











      

        

          const Block< const Derived, CRows, CCols > 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).


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


Template Parameters:

  

    
CRowsnumber of rows in corner as specified at compile-time 

    
CColsnumber of columns in corner as specified at compile-time 

  

  




Parameters:

  

    
cRowsnumber of rows in corner as specified at run-time 

    
cColsnumber of columns in corner as specified at run-time

  

  




This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.


Example: 


 Output: 


See also:
class Block


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



Definition at line 306 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 327 of file BlockMethods.h.











      

        

          const Block< const Derived, CRows, CCols > 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).


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


Template Parameters:

  

    
CRowsnumber of rows in corner as specified at compile-time 

    
CColsnumber of columns in corner as specified at compile-time 

  

  




Parameters:

  

    
cRowsnumber of rows in corner as specified at run-time 

    
cColsnumber of columns in corner as specified at run-time

  

  




This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.


Example: 


 Output: 


See also:
class Block


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



Definition at line 231 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 252 of file BlockMethods.h.











      

        

          ConstNRowsBlockXpr< N >::Type bottomRows 
          (
          Index 
          n = 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).


Returns:
a block consisting of the bottom rows of *this.


Template Parameters:

  

    
Nthe number of rows in the block as specified at compile-time 

  

  




Parameters:

  

    
nthe number of rows in the block as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


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


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



Definition at line 428 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 732 of file BlockMethods.h.











      

        

          ConstFixedSegmentReturnType< N >::Type head 
          (
          Index 
          n = N)
           [inline]
        

      






Returns:
a dynamic-size expression of the first coefficients of *this.


Parameters:

  

    
nthe number of coefficients in the segment

  

  




Example: 


 Output: 


Note:
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, 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 head(Index).


Returns:
a fixed-size expression of the first coefficients of *this.


Template Parameters:

  

    
Nthe number of coefficients in the segment as specified at compile-time 

  

  




Parameters:

  

    
nthe number of coefficients in the segment as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


See also:
class Block


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



Definition at line 805 of file BlockMethods.h.











      

        

          ConstNColsBlockXpr< N >::Type leftCols 
          (
          Index 
          n = 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).


Returns:
a block consisting of the left columns of *this.


Template Parameters:

  

    
Nthe number of columns in the block as specified at compile-time 

  

  




Parameters:

  

    
nthe number of columns in the block as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


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


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



Definition at line 526 of file BlockMethods.h.











      

        

          ConstNColsBlockXpr< N >::Type middleCols 
          (
          Index 
          startCol, 
        

        

          
          
          Index 
          n = N 
        

        

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


Returns:
a block consisting of a range of columns of *this.


Template Parameters:

  

    
Nthe number of columns in the block as specified at compile-time 

  

  




Parameters:

  

    
startColthe index of the first column in the block 

    
nthe number of columns in the block as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


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


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



Definition at line 623 of file BlockMethods.h.











      

        

          ConstNRowsBlockXpr< N >::Type middleRows 
          (
          Index 
          startRow, 
        

        

          
          
          Index 
          n = N 
        

        

          
          )
           [inline]
        

      






Returns:
a block consisting of a range of rows of *this.


Parameters:

  

    
startRowthe index of the first row in the block 

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


Returns:
a block consisting of a range of rows of *this.


Template Parameters:

  

    
Nthe number of rows in the block as specified at compile-time 

  

  




Parameters:

  

    
startRowthe index of the first row in the block 

    
nthe number of rows in the block as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


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


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



Definition at line 477 of file BlockMethods.h.











      

        

          ConstNColsBlockXpr< N >::Type rightCols 
          (
          Index 
          n = 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).


Returns:
a block consisting of the right columns of *this.


Template Parameters:

  

    
Nthe number of columns in the block as specified at compile-time 

  

  




Parameters:

  

    
nthe number of columns in the block as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


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


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



Definition at line 574 of file BlockMethods.h.











      

        

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



Definition at line 749 of file BlockMethods.h.











      

        

          ConstFixedSegmentReturnType< N >::Type segment 
          (
          Index 
          start, 
        

        

          
          
          Index 
          n = N 
        

        

          
          )
           [inline]
        

      






Returns:
a dynamic-size expression of a segment (i.e. a vector block) in *this.


Parameters:

  

    
startthe first coefficient in the segment 

    
nthe number of coefficients in the segment

  

  




Example: 


 Output: 


Note:
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.


See also:
class Block, segment(Index)


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


Returns:
a fixed-size expression of a segment (i.e. a vector block) in *this 


Template Parameters:

  

    
Nthe number of coefficients in the segment as specified at compile-time 

  

  




Parameters:

  

    
startthe index of the first element in the segment 

    
nthe number of coefficients in the segment as specified at compile-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


See also:
class Block


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



Definition at line 776 of file BlockMethods.h.











      

        

          ConstFixedSegmentReturnType< N >::Type tail 
          (
          Index 
          n = N)
           [inline]
        

      






Returns:
a dynamic-size expression of the last coefficients of *this.


Parameters:

  

    
nthe number of coefficients in the segment

  

  




Example: 


 Output: 


Note:
Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, 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 tail(Index).


Returns:
a fixed-size expression of the last coefficients of *this.


Template Parameters:

  

    
Nthe number of coefficients in the segment as specified at compile-time 

  

  




Parameters:

  

    
nthe number of coefficients in the segment as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


See also:
class Block


This is the const version of tail<int>. 



Definition at line 833 of file BlockMethods.h.











      

        

          const Block< const Derived, CRows, CCols > 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).


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


Template Parameters:

  

    
CRowsnumber of rows in corner as specified at compile-time 

    
CColsnumber of columns in corner as specified at compile-time 

  

  




Parameters:

  

    
cRowsnumber of rows in corner as specified at run-time 

    
cColsnumber of columns in corner as specified at run-time

  

  




This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.


Example: 


 Output: 


See also:
class Block


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



Definition at line 156 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 177 of file BlockMethods.h.











      

        

          const Block< const Derived, CRows, CCols > 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).


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


Template Parameters:

  

    
CRowsnumber of rows in corner as specified at compile-time 

    
CColsnumber of columns in corner as specified at compile-time 

  

  




Parameters:

  

    
cRowsnumber of rows in corner as specified at run-time 

    
cColsnumber of columns in corner as specified at run-time

  

  




This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.


Example: 


 Output: 


See also:
class Block


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



Definition at line 80 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.


Template Parameters:

  

    
CRowsthe number of rows in the corner 

    
CColsthe number of columns in the corner

  

  




Example: 


 Output: 


See also:
class Block, block<int,int>(Index,Index)


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



Definition at line 102 of file BlockMethods.h.











      

        

          ConstNRowsBlockXpr< N >::Type topRows 
          (
          Index 
          n = 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).


Returns:
a block consisting of the top rows of *this.


Template Parameters:

  

    
Nthe number of rows in the block as specified at compile-time 

  

  




Parameters:

  

    
nthe number of rows in the block as specified at run-time

  

  




The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.


Example: 


 Output: 


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


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



Definition at line 380 of file BlockMethods.h.













turtlebot_exploration_3d

Author(s): Bona , Shawn 

autogenerated on Thu Jun 6 2019 21:00:37