mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-01-30 17:40:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add examples for API documentation of block methods in DenseBase.

Browse Source
This commit is contained in:
Jitse Niesen 2010-07-23 22:20:00 +01:00
parent 2b5a0060b4
commit 425444428c
17 changed files with 113 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Eigen/src/Core/Block.h
View File

@ -600,7 +600,7 @@ DenseBase<Derived>::topRows(Index n) const
/** \returns a block consisting of the top rows of *this.
*
* \param N the number of rows in the block
* \tparam N the number of rows in the block
*
* Example: \include MatrixBase_template_int_topRows.cpp
* Output: \verbinclude MatrixBase_template_int_topRows.out
@ -654,7 +654,7 @@ DenseBase<Derived>::bottomRows(Index n) const
/** \returns a block consisting of the bottom rows of *this.
*
* \param N the number of rows in the block
* \tparam N the number of rows in the block
*
* Example: \include MatrixBase_template_int_bottomRows.cpp
* Output: \verbinclude MatrixBase_template_int_bottomRows.out
@ -685,8 +685,8 @@ DenseBase<Derived>::bottomRows() const
* \param startRow the index of the first row in the block
* \param numRows the number of rows in the block
*
* Example: \include MatrixBase_middleRows_int.cpp
* Output: \verbinclude MatrixBase_middleRows_int.out
* Example: \include DenseBase_middleRows_int.cpp
* Output: \verbinclude DenseBase_middleRows_int.out
*
* \sa class Block, block(Index,Index,Index,Index)
*/
@ -707,11 +707,11 @@ DenseBase<Derived>::middleRows(Index startRow, Index numRows) const
/** \returns a block consisting of a range of rows of *this.
*
* \param N the number of rows in the block
* \tparam N the number of rows in the block
* \param startRow the index of the first row in the block
*
* Example: \include MatrixBase_template_int_middleRows.cpp
* Output: \verbinclude MatrixBase_template_int_middleRows.out
* Example: \include DenseBase_template_int_middleRows.cpp
* Output: \verbinclude DenseBase_template_int_middleRows.out
*
* \sa class Block, block(Index,Index,Index,Index)
*/
@ -759,9 +759,9 @@ DenseBase<Derived>::leftCols(Index n) const
return ColsBlockXpr(derived(), 0, 0, rows(), n);
}
/** \returns a block consisting of the top columns of *this.
/** \returns a block consisting of the left columns of *this.
*
* \param N the number of columns in the block
* \tparam N the number of columns in the block
*
* Example: \include MatrixBase_template_int_leftCols.cpp
* Output: \verbinclude MatrixBase_template_int_leftCols.out
@ -789,7 +789,7 @@ DenseBase<Derived>::leftCols() const
/** \returns a block consisting of the top columns of *this.
/** \returns a block consisting of the right columns of *this.
*
* \param n the number of columns in the block
*
@ -813,9 +813,9 @@ DenseBase<Derived>::rightCols(Index n) const
return ColsBlockXpr(derived(), 0, cols() - n, rows(), n);
}
/** \returns a block consisting of the top columns of *this.
/** \returns a block consisting of the right columns of *this.
*
* \param N the number of columns in the block
* \tparam N the number of columns in the block
*
* Example: \include MatrixBase_template_int_rightCols.cpp
* Output: \verbinclude MatrixBase_template_int_rightCols.out
@ -847,8 +847,8 @@ DenseBase<Derived>::rightCols() const
* \param startCol the index of the first column in the block
* \param numCols the number of columns in the block
*
* Example: \include MatrixBase_middleCols_int.cpp
* Output: \verbinclude MatrixBase_middleCols_int.out
* Example: \include DenseBase_middleCols_int.cpp
* Output: \verbinclude DenseBase_middleCols_int.out
*
* \sa class Block, block(Index,Index,Index,Index)
*/
@ -869,11 +869,11 @@ DenseBase<Derived>::middleCols(Index startCol, Index numCols) const
/** \returns a block consisting of a range of columns of *this.
*
* \param N the number of columns in the block
* \tparam N the number of columns in the block
* \param startCol the index of the first column in the block
*
* Example: \include MatrixBase_template_int_middleCols.cpp
* Output: \verbinclude MatrixBase_template_int_middleCols.out
* Example: \include DenseBase_template_int_middleCols.cpp
* Output: \verbinclude DenseBase_template_int_middleCols.out
*
* \sa class Block, block(Index,Index,Index,Index)
*/

6
doc/snippets/MatrixBase_bottomLeftCorner_int_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomLeftCorner(2, 2):" << endl;
cout << m.bottomLeftCorner(2, 2) << endl;
m.bottomLeftCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_bottomRightCorner_int_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomRightCorner(2, 2):" << endl;
cout << m.bottomRightCorner(2, 2) << endl;
m.bottomRightCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_bottomRows_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.bottomRows(2):" << endl;
cout << a.bottomRows(2) << endl;
a.bottomRows(2).setZero();
cout << "Now the array a is:" << endl << a << endl;

6
doc/snippets/MatrixBase_leftCols_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.leftCols(2):" << endl;
cout << a.leftCols(2) << endl;
a.leftCols(2).setZero();
cout << "Now the array a is:" << endl << a << endl;

6
doc/snippets/MatrixBase_rightCols_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.rightCols(2):" << endl;
cout << a.rightCols(2) << endl;
a.rightCols(2).setZero();
cout << "Now the array a is:" << endl << a << endl;

6
doc/snippets/MatrixBase_template_int_bottomRows.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.bottomRows<2>():" << endl;
cout << a.bottomRows<2>() << endl;
a.bottomRows<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

6
doc/snippets/MatrixBase_template_int_int_bottomLeftCorner.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomLeftCorner<2,2>():" << endl;
cout << m.bottomLeftCorner<2,2>() << endl;
m.bottomLeftCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_template_int_int_bottomRightCorner.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomRightCorner<2,2>():" << endl;
cout << m.bottomRightCorner<2,2>() << endl;
m.bottomRightCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_template_int_int_topLeftCorner.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topLeftCorner<2,2>():" << endl;
cout << m.topLeftCorner<2,2>() << endl;
m.topLeftCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_template_int_int_topRightCorner.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topRightCorner<2,2>():" << endl;
cout << m.topRightCorner<2,2>() << endl;
m.topRightCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_template_int_leftCols.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.leftCols<2>():" << endl;
cout << a.leftCols<2>() << endl;
a.leftCols<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

6
doc/snippets/MatrixBase_template_int_rightCols.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.rightCols<2>():" << endl;
cout << a.rightCols<2>() << endl;
a.rightCols<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

6
doc/snippets/MatrixBase_template_int_topRows.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.topRows<2>():" << endl;
cout << a.topRows<2>() << endl;
a.topRows<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

6
doc/snippets/MatrixBase_topLeftCorner_int_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topLeftCorner(2, 2):" << endl;
cout << m.topLeftCorner(2, 2) << endl;
m.topLeftCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_topRightCorner_int_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topRightCorner(2, 2):" << endl;
cout << m.topRightCorner(2, 2) << endl;
m.topRightCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

6
doc/snippets/MatrixBase_topRows_int.cpp Normal file
View File

@ -0,0 +1,6 @@
Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.topRows(2):" << endl;
cout << a.topRows(2) << endl;
a.topRows(2).setZero();
cout << "Now the array a is:" << endl << a << endl;