add snippet for sub/super diagonal

fix a few doc issues
This commit is contained in:
Gael Guennebaud 2009-02-05 21:19:40 +00:00
parent e80f0b6c4e
commit a4487ef198
6 changed files with 16 additions and 18 deletions

View File

@ -64,7 +64,7 @@
* It is the return type of MatrixBase::cwise() * It is the return type of MatrixBase::cwise()
* and most of the time this is the only way it is used. * 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 * Example: \include MatrixBase_cwise_const.cpp
* Output: \verbinclude MatrixBase_cwise_const.out * Output: \verbinclude MatrixBase_cwise_const.out

View File

@ -49,12 +49,12 @@ struct ei_traits<DiagonalCoeffs<MatrixType,DiagId> >
enum { enum {
AbsDiagId = DiagId<0 ? -DiagId : DiagId, AbsDiagId = DiagId<0 ? -DiagId : DiagId,
RowsAtCompileTime = int(MatrixType::SizeAtCompileTime) == Dynamic ? Dynamic RowsAtCompileTime = int(MatrixType::SizeAtCompileTime) == Dynamic ? Dynamic
: EIGEN_ENUM_MIN(MatrixType::RowsAtCompileTime, : (EIGEN_ENUM_MIN(MatrixType::RowsAtCompileTime,
MatrixType::ColsAtCompileTime) - AbsDiagId, MatrixType::ColsAtCompileTime) - AbsDiagId),
ColsAtCompileTime = 1, ColsAtCompileTime = 1,
MaxRowsAtCompileTime = int(MatrixType::MaxSizeAtCompileTime) == Dynamic ? Dynamic MaxRowsAtCompileTime = int(MatrixType::MaxSizeAtCompileTime) == Dynamic ? Dynamic
: EIGEN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime, : (EIGEN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime,
MatrixType::MaxColsAtCompileTime), MatrixType::MaxColsAtCompileTime) - AbsDiagId),
MaxColsAtCompileTime = 1, MaxColsAtCompileTime = 1,
Flags = (unsigned int)_MatrixTypeNested::Flags & (HereditaryBits | LinearAccessBit), Flags = (unsigned int)_MatrixTypeNested::Flags & (HereditaryBits | LinearAccessBit),
CoeffReadCost = _MatrixTypeNested::CoeffReadCost CoeffReadCost = _MatrixTypeNested::CoeffReadCost
@ -135,6 +135,9 @@ MatrixBase<Derived>::diagonal() const
* The template parameter \a Id represent a super diagonal if \a Id > 0 * 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. * 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 */ * \sa MatrixBase::diagonal(), class DiagonalCoeffs */
template<typename Derived> template<typename Derived>
template<int Id> template<int Id>

View File

@ -34,7 +34,7 @@
* types. Most of the Eigen API is contained in this class. Other important classes for * types. Most of the Eigen API is contained in this class. Other important classes for
* the Eigen API are Matrix, Cwise, and PartialRedux. * 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. * \param Derived is the derived type, e.g. a matrix type, or an expression, etc.
* *

View File

@ -10,7 +10,7 @@ namespace Eigen {
| \ref TutorialSparse "Sparse matrix" | \ref TutorialSparse "Sparse matrix"
</div> </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. namely 2D and 3D rotations and affine transformations.
\b Table \b of \b contents \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 <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: generic algorithms working on any kind of transformation representations:
<table class="tutorial_code"> <table class="tutorial_code">
<tr><td> <tr><td>

View 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;

View File

@ -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 unsupported
} // namespace Eigen } // namespace Eigen