diff options
author | Gael Guennebaud <g.gael@free.fr> | 2010-08-25 13:09:56 +0200 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2010-08-25 13:09:56 +0200 |
commit | cb7a72d5b0e2b83b14bc54be62603267f8a2d4f5 (patch) | |
tree | 30cdb81cf7292f679b19c549c52c5e2976d55248 /Eigen/src/Core/Block.h | |
parent | e17d17cea3ab1e01a7fa754b9c8d9c857f5c7a50 (diff) |
Fix Sun CC parsing of Eigen/Core. In particular,
I moved all the block related methods to a plugin file. This also
significantly reduce code verbosity.
Diffstat (limited to 'Eigen/src/Core/Block.h')
-rw-r--r-- | Eigen/src/Core/Block.h | 649 |
1 files changed, 0 insertions, 649 deletions
diff --git a/Eigen/src/Core/Block.h b/Eigen/src/Core/Block.h index 2a28ea7cd..a770b9721 100644 --- a/Eigen/src/Core/Block.h +++ b/Eigen/src/Core/Block.h @@ -323,654 +323,5 @@ class Block<XprType,BlockRows,BlockCols, InnerPanel,true> int m_outerStride; }; -/** \returns a dynamic-size expression of a block in *this. - * - * \param startRow the first row in the block - * \param startCol the first column in the block - * \param blockRows the number of rows in the block - * \param blockCols the number of columns in the block - * - * Example: \include MatrixBase_block_int_int_int_int.cpp - * Output: \verbinclude MatrixBase_block_int_int_int_int.out - * - * \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. - * - * \sa class Block, block(Index,Index) - */ -template<typename Derived> -inline Block<Derived> DenseBase<Derived> - ::block(Index startRow, Index startCol, Index blockRows, Index blockCols) -{ - return Block<Derived>(derived(), startRow, startCol, blockRows, blockCols); -} - -/** This is the const version of block(Index,Index,Index,Index). */ -template<typename Derived> -inline const Block<Derived> DenseBase<Derived> - ::block(Index startRow, Index startCol, Index blockRows, Index blockCols) const -{ - return Block<Derived>(derived(), startRow, startCol, blockRows, blockCols); -} - - - - -/** \returns a dynamic-size expression of a top-right corner of *this. - * - * \param cRows the number of rows in the corner - * \param cCols the number of columns in the corner - * - * Example: \include MatrixBase_topRightCorner_int_int.cpp - * Output: \verbinclude MatrixBase_topRightCorner_int_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline Block<Derived> DenseBase<Derived> - ::topRightCorner(Index cRows, Index cCols) -{ - return Block<Derived>(derived(), 0, cols() - cCols, cRows, cCols); -} - -/** This is the const version of topRightCorner(Index, Index).*/ -template<typename Derived> -inline const Block<Derived> -DenseBase<Derived>::topRightCorner(Index cRows, Index cCols) const -{ - return Block<Derived>(derived(), 0, cols() - cCols, cRows, cCols); -} - -/** \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: \include MatrixBase_template_int_int_topRightCorner.cpp - * Output: \verbinclude MatrixBase_template_int_int_topRightCorner.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int CRows, int CCols> -inline Block<Derived, CRows, CCols> -DenseBase<Derived>::topRightCorner() -{ - return Block<Derived, CRows, CCols>(derived(), 0, cols() - CCols); -} - -/** This is the const version of topRightCorner<int, int>().*/ -template<typename Derived> -template<int CRows, int CCols> -inline const Block<Derived, CRows, CCols> -DenseBase<Derived>::topRightCorner() const -{ - return Block<Derived, CRows, CCols>(derived(), 0, cols() - CCols); -} - - - - -/** \returns a dynamic-size expression of a top-left corner of *this. - * - * \param cRows the number of rows in the corner - * \param cCols the number of columns in the corner - * - * Example: \include MatrixBase_topLeftCorner_int_int.cpp - * Output: \verbinclude MatrixBase_topLeftCorner_int_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline Block<Derived> DenseBase<Derived> - ::topLeftCorner(Index cRows, Index cCols) -{ - return Block<Derived>(derived(), 0, 0, cRows, cCols); -} - -/** This is the const version of topLeftCorner(Index, Index).*/ -template<typename Derived> -inline const Block<Derived> -DenseBase<Derived>::topLeftCorner(Index cRows, Index cCols) const -{ - return Block<Derived>(derived(), 0, 0, cRows, cCols); -} - -/** \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: \include MatrixBase_template_int_int_topLeftCorner.cpp - * Output: \verbinclude MatrixBase_template_int_int_topLeftCorner.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int CRows, int CCols> -inline Block<Derived, CRows, CCols> -DenseBase<Derived>::topLeftCorner() -{ - return Block<Derived, CRows, CCols>(derived(), 0, 0); -} - -/** This is the const version of topLeftCorner<int, int>().*/ -template<typename Derived> -template<int CRows, int CCols> -inline const Block<Derived, CRows, CCols> -DenseBase<Derived>::topLeftCorner() const -{ - return Block<Derived, CRows, CCols>(derived(), 0, 0); -} - - - - - - -/** \returns a dynamic-size expression of a bottom-right corner of *this. - * - * \param cRows the number of rows in the corner - * \param cCols the number of columns in the corner - * - * Example: \include MatrixBase_bottomRightCorner_int_int.cpp - * Output: \verbinclude MatrixBase_bottomRightCorner_int_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline Block<Derived> DenseBase<Derived> - ::bottomRightCorner(Index cRows, Index cCols) -{ - return Block<Derived>(derived(), rows() - cRows, cols() - cCols, cRows, cCols); -} - -/** This is the const version of bottomRightCorner(Index, Index).*/ -template<typename Derived> -inline const Block<Derived> -DenseBase<Derived>::bottomRightCorner(Index cRows, Index cCols) const -{ - return Block<Derived>(derived(), rows() - cRows, cols() - cCols, cRows, cCols); -} - -/** \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: \include MatrixBase_template_int_int_bottomRightCorner.cpp - * Output: \verbinclude MatrixBase_template_int_int_bottomRightCorner.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int CRows, int CCols> -inline Block<Derived, CRows, CCols> -DenseBase<Derived>::bottomRightCorner() -{ - return Block<Derived, CRows, CCols>(derived(), rows() - CRows, cols() - CCols); -} - -/** This is the const version of bottomRightCorner<int, int>().*/ -template<typename Derived> -template<int CRows, int CCols> -inline const Block<Derived, CRows, CCols> -DenseBase<Derived>::bottomRightCorner() const -{ - return Block<Derived, CRows, CCols>(derived(), rows() - CRows, cols() - CCols); -} - - - - -/** \returns a dynamic-size expression of a bottom-left corner of *this. - * - * \param cRows the number of rows in the corner - * \param cCols the number of columns in the corner - * - * Example: \include MatrixBase_bottomLeftCorner_int_int.cpp - * Output: \verbinclude MatrixBase_bottomLeftCorner_int_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline Block<Derived> DenseBase<Derived> - ::bottomLeftCorner(Index cRows, Index cCols) -{ - return Block<Derived>(derived(), rows() - cRows, 0, cRows, cCols); -} - -/** This is the const version of bottomLeftCorner(Index, Index).*/ -template<typename Derived> -inline const Block<Derived> -DenseBase<Derived>::bottomLeftCorner(Index cRows, Index cCols) const -{ - return Block<Derived>(derived(), rows() - cRows, 0, cRows, cCols); -} - -/** \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: \include MatrixBase_template_int_int_bottomLeftCorner.cpp - * Output: \verbinclude MatrixBase_template_int_int_bottomLeftCorner.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int CRows, int CCols> -inline Block<Derived, CRows, CCols> -DenseBase<Derived>::bottomLeftCorner() -{ - return Block<Derived, CRows, CCols>(derived(), rows() - CRows, 0); -} - -/** This is the const version of bottomLeftCorner<int, int>().*/ -template<typename Derived> -template<int CRows, int CCols> -inline const Block<Derived, CRows, CCols> -DenseBase<Derived>::bottomLeftCorner() const -{ - return Block<Derived, CRows, CCols>(derived(), rows() - CRows, 0); -} - - - -/** \returns a block consisting of the top rows of *this. - * - * \param n the number of rows in the block - * - * Example: \include MatrixBase_topRows_int.cpp - * Output: \verbinclude MatrixBase_topRows_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline typename DenseBase<Derived>::RowsBlockXpr DenseBase<Derived> - ::topRows(Index n) -{ - return RowsBlockXpr(derived(), 0, 0, n, cols()); -} - -/** This is the const version of topRows(Index).*/ -template<typename Derived> -inline const typename DenseBase<Derived>::RowsBlockXpr -DenseBase<Derived>::topRows(Index n) const -{ - return RowsBlockXpr(derived(), 0, 0, n, cols()); -} - -/** \returns a block consisting of the top rows of *this. - * - * \tparam N the number of rows in the block - * - * Example: \include MatrixBase_template_int_topRows.cpp - * Output: \verbinclude MatrixBase_template_int_topRows.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int N> -inline typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type -DenseBase<Derived>::topRows() -{ - return typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type(derived(), 0, 0, N, cols()); -} - -/** This is the const version of topRows<int>().*/ -template<typename Derived> -template<int N> -inline const typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type -DenseBase<Derived>::topRows() const -{ - return typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type(derived(), 0, 0, N, cols()); -} - - - - - -/** \returns a block consisting of the bottom rows of *this. - * - * \param n the number of rows in the block - * - * Example: \include MatrixBase_bottomRows_int.cpp - * Output: \verbinclude MatrixBase_bottomRows_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline typename DenseBase<Derived>::RowsBlockXpr DenseBase<Derived> - ::bottomRows(Index n) -{ - return RowsBlockXpr(derived(), rows() - n, 0, n, cols()); -} - -/** This is the const version of bottomRows(Index).*/ -template<typename Derived> -inline const typename DenseBase<Derived>::RowsBlockXpr -DenseBase<Derived>::bottomRows(Index n) const -{ - return RowsBlockXpr(derived(), rows() - n, 0, n, cols()); -} - -/** \returns a block consisting of the bottom rows of *this. - * - * \tparam N the number of rows in the block - * - * Example: \include MatrixBase_template_int_bottomRows.cpp - * Output: \verbinclude MatrixBase_template_int_bottomRows.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int N> -inline typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type -DenseBase<Derived>::bottomRows() -{ - return typename NRowsBlockXpr<N>::Type(derived(), rows() - N, 0, N, cols()); -} - -/** This is the const version of bottomRows<int>().*/ -template<typename Derived> -template<int N> -inline const typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type -DenseBase<Derived>::bottomRows() const -{ - return typename NRowsBlockXpr<N>::Type(derived(), rows() - N, 0, N, cols()); -} - - - -/** \returns a block consisting of a range of rows of *this. - * - * \param startRow the index of the first row in the block - * \param numRows the number of rows in the block - * - * Example: \include DenseBase_middleRows_int.cpp - * Output: \verbinclude DenseBase_middleRows_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline typename DenseBase<Derived>::RowsBlockXpr DenseBase<Derived> - ::middleRows(Index startRow, Index numRows) -{ - return RowsBlockXpr(derived(), startRow, 0, numRows, cols()); -} - -/** This is the const version of middleRows(Index,Index).*/ -template<typename Derived> -inline const typename DenseBase<Derived>::RowsBlockXpr -DenseBase<Derived>::middleRows(Index startRow, Index numRows) const -{ - return RowsBlockXpr(derived(), startRow, 0, numRows, cols()); -} - -/** \returns a block consisting of a range of rows of *this. - * - * \tparam N the number of rows in the block - * \param startRow the index of the first row in the block - * - * Example: \include DenseBase_template_int_middleRows.cpp - * Output: \verbinclude DenseBase_template_int_middleRows.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int N> -inline typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type -DenseBase<Derived>::middleRows(Index startRow) -{ - return typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type(derived(), startRow, 0, N, cols()); -} - -/** This is the const version of middleRows<int>().*/ -template<typename Derived> -template<int N> -inline const typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type -DenseBase<Derived>::middleRows(Index startRow) const -{ - return typename DenseBase<Derived>::template NRowsBlockXpr<N>::Type(derived(), startRow, 0, N, cols()); -} - - - - -/** \returns a block consisting of the left columns of *this. - * - * \param n the number of columns in the block - * - * Example: \include MatrixBase_leftCols_int.cpp - * Output: \verbinclude MatrixBase_leftCols_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline typename DenseBase<Derived>::ColsBlockXpr DenseBase<Derived> - ::leftCols(Index n) -{ - return ColsBlockXpr(derived(), 0, 0, rows(), n); -} - -/** This is the const version of leftCols(Index).*/ -template<typename Derived> -inline const typename DenseBase<Derived>::ColsBlockXpr -DenseBase<Derived>::leftCols(Index n) const -{ - return ColsBlockXpr(derived(), 0, 0, rows(), n); -} - -/** \returns a block consisting of the left columns of *this. - * - * \tparam N the number of columns in the block - * - * Example: \include MatrixBase_template_int_leftCols.cpp - * Output: \verbinclude MatrixBase_template_int_leftCols.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int N> -inline typename DenseBase<Derived>::template NColsBlockXpr<N>::Type -DenseBase<Derived>::leftCols() -{ - return typename NColsBlockXpr<N>::Type(derived(), 0, 0, rows(), N); -} - -/** This is the const version of leftCols<int>().*/ -template<typename Derived> -template<int N> -inline const typename DenseBase<Derived>::template NColsBlockXpr<N>::Type -DenseBase<Derived>::leftCols() const -{ - return typename NColsBlockXpr<N>::Type(derived(), 0, 0, rows(), N); -} - - - - - -/** \returns a block consisting of the right columns of *this. - * - * \param n the number of columns in the block - * - * Example: \include MatrixBase_rightCols_int.cpp - * Output: \verbinclude MatrixBase_rightCols_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline typename DenseBase<Derived>::ColsBlockXpr DenseBase<Derived> - ::rightCols(Index n) -{ - return ColsBlockXpr(derived(), 0, cols() - n, rows(), n); -} - -/** This is the const version of rightCols(Index).*/ -template<typename Derived> -inline const typename DenseBase<Derived>::ColsBlockXpr -DenseBase<Derived>::rightCols(Index n) const -{ - return ColsBlockXpr(derived(), 0, cols() - n, rows(), n); -} - -/** \returns a block consisting of the right columns of *this. - * - * \tparam N the number of columns in the block - * - * Example: \include MatrixBase_template_int_rightCols.cpp - * Output: \verbinclude MatrixBase_template_int_rightCols.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int N> -inline typename DenseBase<Derived>::template NColsBlockXpr<N>::Type -DenseBase<Derived>::rightCols() -{ - return typename DenseBase<Derived>::template NColsBlockXpr<N>::Type(derived(), 0, cols() - N, rows(), N); -} - -/** This is the const version of rightCols<int>().*/ -template<typename Derived> -template<int N> -inline const typename DenseBase<Derived>::template NColsBlockXpr<N>::Type -DenseBase<Derived>::rightCols() const -{ - return typename DenseBase<Derived>::template NColsBlockXpr<N>::Type(derived(), 0, cols() - N, rows(), N); -} - - - - -/** \returns a block consisting of a range of columns of *this. - * - * \param startCol the index of the first column in the block - * \param numCols the number of columns in the block - * - * Example: \include DenseBase_middleCols_int.cpp - * Output: \verbinclude DenseBase_middleCols_int.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -inline typename DenseBase<Derived>::ColsBlockXpr DenseBase<Derived> - ::middleCols(Index startCol, Index numCols) -{ - return ColsBlockXpr(derived(), 0, startCol, rows(), numCols); -} - -/** This is the const version of middleCols(Index,Index).*/ -template<typename Derived> -inline const typename DenseBase<Derived>::ColsBlockXpr -DenseBase<Derived>::middleCols(Index startCol, Index numCols) const -{ - return ColsBlockXpr(derived(), 0, startCol, rows(), numCols); -} - -/** \returns a block consisting of a range of columns of *this. - * - * \tparam N the number of columns in the block - * \param startCol the index of the first column in the block - * - * Example: \include DenseBase_template_int_middleCols.cpp - * Output: \verbinclude DenseBase_template_int_middleCols.out - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int N> -inline typename DenseBase<Derived>::template NColsBlockXpr<N>::Type -DenseBase<Derived>::middleCols(Index startCol) -{ - return typename NColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), N); -} - -/** This is the const version of middleCols<int>().*/ -template<typename Derived> -template<int N> -inline const typename DenseBase<Derived>::template NColsBlockXpr<N>::Type -DenseBase<Derived>::middleCols(Index startCol) const -{ - return typename NColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), N); -} - - - - - -/** \returns a fixed-size expression of a block in *this. - * - * The template parameters \a BlockRows and \a BlockCols are the number of - * rows and columns in the block. - * - * \param startRow the first row in the block - * \param startCol the first column in the block - * - * Example: \include MatrixBase_block_int_int.cpp - * Output: \verbinclude MatrixBase_block_int_int.out - * - * \note since block is a templated member, the keyword template has to be used - * if the matrix type is also a template parameter: \code m.template block<3,3>(1,1); \endcode - * - * \sa class Block, block(Index,Index,Index,Index) - */ -template<typename Derived> -template<int BlockRows, int BlockCols> -inline Block<Derived, BlockRows, BlockCols> -DenseBase<Derived>::block(Index startRow, Index startCol) -{ - return Block<Derived, BlockRows, BlockCols>(derived(), startRow, startCol); -} - -/** This is the const version of block<>(Index, Index). */ -template<typename Derived> -template<int BlockRows, int BlockCols> -inline const Block<Derived, BlockRows, BlockCols> -DenseBase<Derived>::block(Index startRow, Index startCol) const -{ - return Block<Derived, BlockRows, BlockCols>(derived(), startRow, startCol); -} - -/** \returns an expression of the \a i-th column of *this. Note that the numbering starts at 0. - * - * Example: \include MatrixBase_col.cpp - * Output: \verbinclude MatrixBase_col.out - * - * \sa row(), class Block */ -template<typename Derived> -inline typename DenseBase<Derived>::ColXpr -DenseBase<Derived>::col(Index i) -{ - return ColXpr(derived(), i); -} - -/** This is the const version of col(). */ -template<typename Derived> -inline const typename DenseBase<Derived>::ColXpr -DenseBase<Derived>::col(Index i) const -{ - return ColXpr(derived(), i); -} - -/** \returns an expression of the \a i-th row of *this. Note that the numbering starts at 0. - * - * Example: \include MatrixBase_row.cpp - * Output: \verbinclude MatrixBase_row.out - * - * \sa col(), class Block */ -template<typename Derived> -inline typename DenseBase<Derived>::RowXpr -DenseBase<Derived>::row(Index i) -{ - return RowXpr(derived(), i); -} - -/** This is the const version of row(). */ -template<typename Derived> -inline const typename DenseBase<Derived>::RowXpr -DenseBase<Derived>::row(Index i) const -{ - return RowXpr(derived(), i); -} #endif // EIGEN_BLOCK_H |