mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-03-19 18:40:38 +08:00
add snippet for sub/super diagonal
fix a few doc issues
This commit is contained in:
parent
e80f0b6c4e
commit
a4487ef198
Eigen/src/Core
doc
unsupported/Eigen
@ -64,7 +64,7 @@
|
||||
* It is the return type of MatrixBase::cwise()
|
||||
* and most of the time this is the only way it is used.
|
||||
*
|
||||
* Note that some methods are defined in the \ref Array module.
|
||||
* Note that some methods are defined in the \ref Array_Module array module.
|
||||
*
|
||||
* Example: \include MatrixBase_cwise_const.cpp
|
||||
* Output: \verbinclude MatrixBase_cwise_const.out
|
||||
|
@ -49,12 +49,12 @@ struct ei_traits<DiagonalCoeffs<MatrixType,DiagId> >
|
||||
enum {
|
||||
AbsDiagId = DiagId<0 ? -DiagId : DiagId,
|
||||
RowsAtCompileTime = int(MatrixType::SizeAtCompileTime) == Dynamic ? Dynamic
|
||||
: EIGEN_ENUM_MIN(MatrixType::RowsAtCompileTime,
|
||||
MatrixType::ColsAtCompileTime) - AbsDiagId,
|
||||
: (EIGEN_ENUM_MIN(MatrixType::RowsAtCompileTime,
|
||||
MatrixType::ColsAtCompileTime) - AbsDiagId),
|
||||
ColsAtCompileTime = 1,
|
||||
MaxRowsAtCompileTime = int(MatrixType::MaxSizeAtCompileTime) == Dynamic ? Dynamic
|
||||
: EIGEN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime,
|
||||
MatrixType::MaxColsAtCompileTime),
|
||||
: (EIGEN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime,
|
||||
MatrixType::MaxColsAtCompileTime) - AbsDiagId),
|
||||
MaxColsAtCompileTime = 1,
|
||||
Flags = (unsigned int)_MatrixTypeNested::Flags & (HereditaryBits | LinearAccessBit),
|
||||
CoeffReadCost = _MatrixTypeNested::CoeffReadCost
|
||||
@ -135,6 +135,9 @@ MatrixBase<Derived>::diagonal() const
|
||||
* The template parameter \a Id represent a super diagonal if \a Id > 0
|
||||
* and a sub diagonal otherwise. \a Id == 0 is equivalent to the main diagonal.
|
||||
*
|
||||
* Example: \include MatrixBase_diagonal_int.cpp
|
||||
* Output: \verbinclude MatrixBase_diagonal_int.out
|
||||
*
|
||||
* \sa MatrixBase::diagonal(), class DiagonalCoeffs */
|
||||
template<typename Derived>
|
||||
template<int Id>
|
||||
|
@ -34,7 +34,7 @@
|
||||
* types. Most of the Eigen API is contained in this class. Other important classes for
|
||||
* the Eigen API are Matrix, Cwise, and PartialRedux.
|
||||
*
|
||||
* Note that some methods are defined in the \ref Array module.
|
||||
* Note that some methods are defined in the \ref Array_Module array module.
|
||||
*
|
||||
* \param Derived is the derived type, e.g. a matrix type, or an expression, etc.
|
||||
*
|
||||
|
@ -10,7 +10,7 @@ namespace Eigen {
|
||||
| \ref TutorialSparse "Sparse matrix"
|
||||
</div>
|
||||
|
||||
In this tutorial chapter we will shortly introduce the many possibilities offered by the \ref GeometryModule "geometry module",
|
||||
In this tutorial chapter we will shortly introduce the many possibilities offered by the \ref Geometry_Module "geometry module",
|
||||
namely 2D and 3D rotations and affine transformations.
|
||||
|
||||
\b Table \b of \b contents
|
||||
@ -106,7 +106,7 @@ Transform3f m = Translation3f(..); Transform3f m = Matrix3f(..);
|
||||
|
||||
<a href="#" class="top">top</a>\section TutorialGeoCommontransformationAPI Common API across transformation types
|
||||
|
||||
To some extent, Eigen's \ref GeometryModule "geometry module" allows you to write
|
||||
To some extent, Eigen's \ref Geometry_Module "geometry module" allows you to write
|
||||
generic algorithms working on any kind of transformation representations:
|
||||
<table class="tutorial_code">
|
||||
<tr><td>
|
||||
|
5
doc/snippets/MatrixBase_diagonal_int.cpp
Normal file
5
doc/snippets/MatrixBase_diagonal_int.cpp
Normal file
@ -0,0 +1,5 @@
|
||||
Matrix4i m = Matrix4i::Random();
|
||||
cout << "Here is the matrix m:" << endl << m << endl;
|
||||
cout << "Here are the coefficients on the 1st super-diagonal and 2nd sub-diagonal of m:" << endl
|
||||
<< m.diagonal<1>().transpose() << endl
|
||||
<< m.diagonal<-2>().transpose() << endl;
|
@ -79,16 +79,6 @@ namespace unsupported {
|
||||
*/
|
||||
//@{
|
||||
|
||||
/** \class Foo
|
||||
* \brief a foo class
|
||||
*/
|
||||
class Foo : public MatrixBase<Foo> {
|
||||
public:
|
||||
/** a member
|
||||
* \see MatrixBase::sum() */
|
||||
void member() {}
|
||||
};
|
||||
|
||||
} // namespace unsupported
|
||||
|
||||
} // namespace Eigen
|
||||
|
Loading…
x
Reference in New Issue
Block a user