// This file is part of Eigen, a lightweight C++ template library // for linear algebra. // // Copyright (C) 2008-2010 Gael Guennebaud // Copyright (C) 2006-2010 Benoit Jacob // // This Source Code Form is subject to the terms of the Mozilla // Public License v. 2.0. If a copy of the MPL was not distributed // with this file, You can obtain one at http://mozilla.org/MPL/2.0/. #ifndef EIGEN_PARSED_BY_DOXYGEN /** \internal expression type of a column */ typedef Block::RowsAtCompileTime, 1, !IsRowMajor> ColXpr; typedef const Block::RowsAtCompileTime, 1, !IsRowMajor> ConstColXpr; /** \internal expression type of a row */ typedef Block::ColsAtCompileTime, IsRowMajor> RowXpr; typedef const Block::ColsAtCompileTime, IsRowMajor> ConstRowXpr; /** \internal expression type of a block of whole columns */ typedef Block::RowsAtCompileTime, Dynamic, !IsRowMajor> ColsBlockXpr; typedef const Block::RowsAtCompileTime, Dynamic, !IsRowMajor> ConstColsBlockXpr; /** \internal expression type of a block of whole rows */ typedef Block::ColsAtCompileTime, IsRowMajor> RowsBlockXpr; typedef const Block::ColsAtCompileTime, IsRowMajor> ConstRowsBlockXpr; /** \internal expression type of a block of whole columns */ template struct NColsBlockXpr { typedef Block::RowsAtCompileTime, N, !IsRowMajor> Type; }; template struct ConstNColsBlockXpr { typedef const Block::RowsAtCompileTime, N, !IsRowMajor> Type; }; /** \internal expression type of a block of whole rows */ template struct NRowsBlockXpr { typedef Block::ColsAtCompileTime, IsRowMajor> Type; }; template struct ConstNRowsBlockXpr { typedef const Block::ColsAtCompileTime, IsRowMajor> Type; }; typedef VectorBlock SegmentReturnType; typedef const VectorBlock ConstSegmentReturnType; template struct FixedSegmentReturnType { typedef VectorBlock Type; }; template struct ConstFixedSegmentReturnType { typedef const VectorBlock Type; }; #endif // not EIGEN_PARSED_BY_DOXYGEN /** \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) */ inline Block block(Index startRow, Index startCol, Index blockRows, Index blockCols) { return Block(derived(), startRow, startCol, blockRows, blockCols); } /** This is the const version of block(Index,Index,Index,Index). */ inline const Block block(Index startRow, Index startCol, Index blockRows, Index blockCols) const { return Block(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) */ inline Block topRightCorner(Index cRows, Index cCols) { return Block(derived(), 0, cols() - cCols, cRows, cCols); } /** This is the const version of topRightCorner(Index, Index).*/ inline const Block topRightCorner(Index cRows, Index cCols) const { return Block(derived(), 0, cols() - cCols, cRows, cCols); } /** \returns an expression of a fixed-size top-right corner of *this. * * \tparam CRows the number of rows in the corner * \tparam CCols the number of 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) */ template inline Block topRightCorner() { return Block(derived(), 0, cols() - CCols); } /** This is the const version of topRightCorner().*/ template inline const Block topRightCorner() const { return Block(derived(), 0, cols() - CCols); } /** \returns an expression of a top-right corner of *this. * * \tparam CRows number of rows in corner as specified at compile-time * \tparam CCols number of columns in corner as specified at compile-time * \param cRows number of rows in corner as specified at run-time * \param cCols number 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, \a cRows should equal \a CRows unless * \a CRows is \a Dynamic, and the same for the number of columns. * * Example: \include MatrixBase_template_int_int_topRightCorner_int_int.cpp * Output: \verbinclude MatrixBase_template_int_int_topRightCorner_int_int.out * * \sa class Block */ template inline Block topRightCorner(Index cRows, Index cCols) { return Block(derived(), 0, cols() - cCols, cRows, cCols); } /** This is the const version of topRightCorner(Index, Index).*/ template inline const Block topRightCorner(Index cRows, Index cCols) const { return Block(derived(), 0, cols() - cCols, cRows, 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) */ inline Block topLeftCorner(Index cRows, Index cCols) { return Block(derived(), 0, 0, cRows, cCols); } /** This is the const version of topLeftCorner(Index, Index).*/ inline const Block topLeftCorner(Index cRows, Index cCols) const { return Block(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 inline Block topLeftCorner() { return Block(derived(), 0, 0); } /** This is the const version of topLeftCorner().*/ template inline const Block topLeftCorner() const { return Block(derived(), 0, 0); } /** \returns an expression of a top-left corner of *this. * * \tparam CRows number of rows in corner as specified at compile-time * \tparam CCols number of columns in corner as specified at compile-time * \param cRows number of rows in corner as specified at run-time * \param cCols number 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, \a cRows should equal \a CRows unless * \a CRows is \a Dynamic, and the same for the number of columns. * * Example: \include MatrixBase_template_int_int_topLeftCorner_int_int.cpp * Output: \verbinclude MatrixBase_template_int_int_topLeftCorner_int_int.out * * \sa class Block */ template inline Block topLeftCorner(Index cRows, Index cCols) { return Block(derived(), 0, 0, cRows, cCols); } /** This is the const version of topLeftCorner(Index, Index).*/ template inline const Block topLeftCorner(Index cRows, Index cCols) const { return Block(derived(), 0, 0, cRows, cCols); } /** \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) */ inline Block bottomRightCorner(Index cRows, Index cCols) { return Block(derived(), rows() - cRows, cols() - cCols, cRows, cCols); } /** This is the const version of bottomRightCorner(Index, Index).*/ inline const Block bottomRightCorner(Index cRows, Index cCols) const { return Block(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 inline Block bottomRightCorner() { return Block(derived(), rows() - CRows, cols() - CCols); } /** This is the const version of bottomRightCorner().*/ template inline const Block bottomRightCorner() const { return Block(derived(), rows() - CRows, cols() - CCols); } /** \returns an expression of a bottom-right corner of *this. * * \tparam CRows number of rows in corner as specified at compile-time * \tparam CCols number of columns in corner as specified at compile-time * \param cRows number of rows in corner as specified at run-time * \param cCols number 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, \a cRows should equal \a CRows unless * \a CRows is \a Dynamic, and the same for the number of columns. * * Example: \include MatrixBase_template_int_int_bottomRightCorner_int_int.cpp * Output: \verbinclude MatrixBase_template_int_int_bottomRightCorner_int_int.out * * \sa class Block */ template inline Block bottomRightCorner(Index cRows, Index cCols) { return Block(derived(), rows() - cRows, cols() - cCols, cRows, cCols); } /** This is the const version of bottomRightCorner(Index, Index).*/ template inline const Block bottomRightCorner(Index cRows, Index cCols) const { return Block(derived(), rows() - cRows, cols() - cCols, cRows, 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) */ inline Block bottomLeftCorner(Index cRows, Index cCols) { return Block(derived(), rows() - cRows, 0, cRows, cCols); } /** This is the const version of bottomLeftCorner(Index, Index).*/ inline const Block bottomLeftCorner(Index cRows, Index cCols) const { return Block(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 inline Block bottomLeftCorner() { return Block(derived(), rows() - CRows, 0); } /** This is the const version of bottomLeftCorner().*/ template inline const Block bottomLeftCorner() const { return Block(derived(), rows() - CRows, 0); } /** \returns an expression of a bottom-left corner of *this. * * \tparam CRows number of rows in corner as specified at compile-time * \tparam CCols number of columns in corner as specified at compile-time * \param cRows number of rows in corner as specified at run-time * \param cCols number 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, \a cRows should equal \a CRows unless * \a CRows is \a Dynamic, and the same for the number of columns. * * Example: \include MatrixBase_template_int_int_bottomLeftCorner_int_int.cpp * Output: \verbinclude MatrixBase_template_int_int_bottomLeftCorner_int_int.out * * \sa class Block */ template inline Block bottomLeftCorner(Index cRows, Index cCols) { return Block(derived(), rows() - cRows, 0, cRows, cCols); } /** This is the const version of bottomLeftCorner(Index, Index).*/ template inline const Block bottomLeftCorner(Index cRows, Index cCols) const { return Block(derived(), rows() - cRows, 0, cRows, cCols); } /** \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) */ inline RowsBlockXpr topRows(Index n) { return RowsBlockXpr(derived(), 0, 0, n, cols()); } /** This is the const version of topRows(Index).*/ inline ConstRowsBlockXpr topRows(Index n) const { return ConstRowsBlockXpr(derived(), 0, 0, n, cols()); } /** \returns a block consisting of the top rows of *this. * * \tparam N the number of rows in the block as specified at compile-time * \param n the number of rows in the block as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include MatrixBase_template_int_topRows.cpp * Output: \verbinclude MatrixBase_template_int_topRows.out * * \sa class Block, block(Index,Index,Index,Index) */ template inline typename NRowsBlockXpr::Type topRows(Index n = N) { return typename NRowsBlockXpr::Type(derived(), 0, 0, n, cols()); } /** This is the const version of topRows().*/ template inline typename ConstNRowsBlockXpr::Type topRows(Index n = N) const { return typename ConstNRowsBlockXpr::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) */ inline RowsBlockXpr bottomRows(Index n) { return RowsBlockXpr(derived(), rows() - n, 0, n, cols()); } /** This is the const version of bottomRows(Index).*/ inline ConstRowsBlockXpr bottomRows(Index n) const { return ConstRowsBlockXpr(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 as specified at compile-time * \param n the number of rows in the block as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include MatrixBase_template_int_bottomRows.cpp * Output: \verbinclude MatrixBase_template_int_bottomRows.out * * \sa class Block, block(Index,Index,Index,Index) */ template inline typename NRowsBlockXpr::Type bottomRows(Index n = N) { return typename NRowsBlockXpr::Type(derived(), rows() - n, 0, n, cols()); } /** This is the const version of bottomRows().*/ template inline typename ConstNRowsBlockXpr::Type bottomRows(Index n = N) const { return typename ConstNRowsBlockXpr::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 n 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) */ inline RowsBlockXpr middleRows(Index startRow, Index n) { return RowsBlockXpr(derived(), startRow, 0, n, cols()); } /** This is the const version of middleRows(Index,Index).*/ inline ConstRowsBlockXpr middleRows(Index startRow, Index n) const { return ConstRowsBlockXpr(derived(), startRow, 0, n, cols()); } /** \returns a block consisting of a range of rows of *this. * * \tparam N the number of rows in the block as specified at compile-time * \param startRow the index of the first row in the block * \param n the number of rows in the block as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include DenseBase_template_int_middleRows.cpp * Output: \verbinclude DenseBase_template_int_middleRows.out * * \sa class Block, block(Index,Index,Index,Index) */ template inline typename NRowsBlockXpr::Type middleRows(Index startRow, Index n = N) { return typename NRowsBlockXpr::Type(derived(), startRow, 0, n, cols()); } /** This is the const version of middleRows().*/ template inline typename ConstNRowsBlockXpr::Type middleRows(Index startRow, Index n = N) const { return typename ConstNRowsBlockXpr::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) */ inline ColsBlockXpr leftCols(Index n) { return ColsBlockXpr(derived(), 0, 0, rows(), n); } /** This is the const version of leftCols(Index).*/ inline ConstColsBlockXpr leftCols(Index n) const { return ConstColsBlockXpr(derived(), 0, 0, rows(), n); } /** \returns a block consisting of the left columns of *this. * * \tparam N the number of columns in the block as specified at compile-time * \param n the number of columns in the block as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include MatrixBase_template_int_leftCols.cpp * Output: \verbinclude MatrixBase_template_int_leftCols.out * * \sa class Block, block(Index,Index,Index,Index) */ template inline typename NColsBlockXpr::Type leftCols(Index n = N) { return typename NColsBlockXpr::Type(derived(), 0, 0, rows(), n); } /** This is the const version of leftCols().*/ template inline typename ConstNColsBlockXpr::Type leftCols(Index n = N) const { return typename ConstNColsBlockXpr::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) */ inline ColsBlockXpr rightCols(Index n) { return ColsBlockXpr(derived(), 0, cols() - n, rows(), n); } /** This is the const version of rightCols(Index).*/ inline ConstColsBlockXpr rightCols(Index n) const { return ConstColsBlockXpr(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 as specified at compile-time * \param n the number of columns in the block as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include MatrixBase_template_int_rightCols.cpp * Output: \verbinclude MatrixBase_template_int_rightCols.out * * \sa class Block, block(Index,Index,Index,Index) */ template inline typename NColsBlockXpr::Type rightCols(Index n = N) { return typename NColsBlockXpr::Type(derived(), 0, cols() - n, rows(), n); } /** This is the const version of rightCols().*/ template inline typename ConstNColsBlockXpr::Type rightCols(Index n = N) const { return typename ConstNColsBlockXpr::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) */ inline ColsBlockXpr middleCols(Index startCol, Index numCols) { return ColsBlockXpr(derived(), 0, startCol, rows(), numCols); } /** This is the const version of middleCols(Index,Index).*/ inline ConstColsBlockXpr middleCols(Index startCol, Index numCols) const { return ConstColsBlockXpr(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 as specified at compile-time * \param startCol the index of the first column in the block * \param n the number of columns in the block as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include DenseBase_template_int_middleCols.cpp * Output: \verbinclude DenseBase_template_int_middleCols.out * * \sa class Block, block(Index,Index,Index,Index) */ template inline typename NColsBlockXpr::Type middleCols(Index startCol, Index n = N) { return typename NColsBlockXpr::Type(derived(), 0, startCol, rows(), n); } /** This is the const version of middleCols().*/ template inline typename ConstNColsBlockXpr::Type middleCols(Index startCol, Index n = N) const { return typename ConstNColsBlockXpr::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 inline Block block(Index startRow, Index startCol) { return Block(derived(), startRow, startCol); } /** This is the const version of block<>(Index, Index). */ template inline const Block block(Index startRow, Index startCol) const { return Block(derived(), startRow, startCol); } /** \returns an expression of a block in *this. * * \tparam BlockRows number of rows in block as specified at compile-time * \tparam BlockCols number of columns in block as specified at compile-time * \param startRow the first row in the block * \param startCol the first column in the block * \param blockRows number of rows in block as specified at run-time * \param blockCols number 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, \a blockRows should equal \a BlockRows unless * \a BlockRows is \a Dynamic, and the same for the number of columns. * * Example: \include MatrixBase_template_int_int_block_int_int_int_int.cpp * Output: \verbinclude MatrixBase_template_int_int_block_int_int_int_int.cpp * * \sa class Block, block(Index,Index,Index,Index) */ template inline Block block(Index startRow, Index startCol, Index blockRows, Index blockCols) { return Block(derived(), startRow, startCol, blockRows, blockCols); } /** This is the const version of block<>(Index, Index, Index, Index). */ template inline const Block block(Index startRow, Index startCol, Index blockRows, Index blockCols) const { return Block(derived(), startRow, startCol, blockRows, blockCols); } /** \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 */ inline ColXpr col(Index i) { return ColXpr(derived(), i); } /** This is the const version of col(). */ inline ConstColXpr col(Index i) const { return ConstColXpr(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 */ inline RowXpr row(Index i) { return RowXpr(derived(), i); } /** This is the const version of row(). */ inline ConstRowXpr row(Index i) const { return ConstRowXpr(derived(), i); } /** \returns a dynamic-size expression of a segment (i.e. a vector block) in *this. * * \only_for_vectors * * \param start the first coefficient in the segment * \param n the number of coefficients in the segment * * Example: \include MatrixBase_segment_int_int.cpp * Output: \verbinclude MatrixBase_segment_int_int.out * * \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. * * \sa class Block, segment(Index) */ inline SegmentReturnType segment(Index start, Index n) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return SegmentReturnType(derived(), start, n); } /** This is the const version of segment(Index,Index).*/ inline ConstSegmentReturnType segment(Index start, Index n) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return ConstSegmentReturnType(derived(), start, n); } /** \returns a dynamic-size expression of the first coefficients of *this. * * \only_for_vectors * * \param n the number of coefficients in the segment * * Example: \include MatrixBase_start_int.cpp * Output: \verbinclude MatrixBase_start_int.out * * \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. * * \sa class Block, block(Index,Index) */ inline SegmentReturnType head(Index n) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return SegmentReturnType(derived(), 0, n); } /** This is the const version of head(Index).*/ inline ConstSegmentReturnType head(Index n) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return ConstSegmentReturnType(derived(), 0, n); } /** \returns a dynamic-size expression of the last coefficients of *this. * * \only_for_vectors * * \param n the number of coefficients in the segment * * Example: \include MatrixBase_end_int.cpp * Output: \verbinclude MatrixBase_end_int.out * * \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. * * \sa class Block, block(Index,Index) */ inline SegmentReturnType tail(Index n) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return SegmentReturnType(derived(), this->size() - n, n); } /** This is the const version of tail(Index).*/ inline ConstSegmentReturnType tail(Index n) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return ConstSegmentReturnType(derived(), this->size() - n, n); } /** \returns a fixed-size expression of a segment (i.e. a vector block) in \c *this * * \only_for_vectors * * \tparam N the number of coefficients in the segment as specified at compile-time * \param start the index of the first element in the segment * \param n the number of coefficients in the segment as specified at compile-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include MatrixBase_template_int_segment.cpp * Output: \verbinclude MatrixBase_template_int_segment.out * * \sa class Block */ template inline typename FixedSegmentReturnType::Type segment(Index start, Index n = N) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename FixedSegmentReturnType::Type(derived(), start, n); } /** This is the const version of segment(Index).*/ template inline typename ConstFixedSegmentReturnType::Type segment(Index start, Index n = N) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename ConstFixedSegmentReturnType::Type(derived(), start, n); } /** \returns a fixed-size expression of the first coefficients of *this. * * \only_for_vectors * * \tparam N the number of coefficients in the segment as specified at compile-time * \param n the number of coefficients in the segment as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include MatrixBase_template_int_start.cpp * Output: \verbinclude MatrixBase_template_int_start.out * * \sa class Block */ template inline typename FixedSegmentReturnType::Type head(Index n = N) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename FixedSegmentReturnType::Type(derived(), 0, n); } /** This is the const version of head().*/ template inline typename ConstFixedSegmentReturnType::Type head(Index n = N) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename ConstFixedSegmentReturnType::Type(derived(), 0, n); } /** \returns a fixed-size expression of the last coefficients of *this. * * \only_for_vectors * * \tparam N the number of coefficients in the segment as specified at compile-time * \param n the number of coefficients in the segment as specified at run-time * * The compile-time and run-time information should not contradict. In other words, * \a n should equal \a N unless \a N is \a Dynamic. * * Example: \include MatrixBase_template_int_end.cpp * Output: \verbinclude MatrixBase_template_int_end.out * * \sa class Block */ template inline typename FixedSegmentReturnType::Type tail(Index n = N) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename FixedSegmentReturnType::Type(derived(), size() - n); } /** This is the const version of tail.*/ template inline typename ConstFixedSegmentReturnType::Type tail(Index n = N) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename ConstFixedSegmentReturnType::Type(derived(), size() - n); }