// 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; }; /// \internal expression of a block */ typedef Block BlockXpr; typedef const Block ConstBlockXpr; /// \internal expression of a block of fixed sizes */ template struct FixedBlockXpr { typedef Block Type; }; template struct ConstFixedBlockXpr { typedef Block Type; }; typedef VectorBlock SegmentReturnType; typedef const VectorBlock ConstSegmentReturnType; template struct FixedSegmentReturnType { typedef VectorBlock Type; }; template struct ConstFixedSegmentReturnType { typedef const VectorBlock Type; }; /// \internal inner-vector typedef Block InnerVectorReturnType; typedef Block ConstInnerVectorReturnType; /// \internal set of inner-vectors typedef Block InnerVectorsReturnType; typedef Block ConstInnerVectorsReturnType; #endif // not EIGEN_PARSED_BY_DOXYGEN /// \returns an expression of a block in \c *this with either dynamic or fixed sizes. /// /// \param startRow the first row in the block /// \param startCol the first column in the block /// \param blockRows number of rows in the block, specified at either run-time or compile-time /// \param blockCols number of columns in the block, specified at either run-time or compile-time /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example using runtime (aka dynamic) sizes: \include MatrixBase_block_int_int_int_int.cpp /// Output: \verbinclude MatrixBase_block_int_int_int_int.out /// /// \newin{3.4}: /// /// The number of rows \a blockRows and columns \a blockCols can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. In the later case, \c n plays the role of a runtime fallback value in case \c N equals Eigen::Dynamic. /// Here is an example with a fixed number of rows \c NRows and dynamic number of columns \c cols: /// \code /// mat.block(i,j,fix,cols) /// \endcode /// /// This function thus fully covers the features offered by the following overloads block(Index, Index), /// and block(Index, Index, Index, Index) that are thus obsolete. Indeed, this generic version avoids /// redundancy, it preserves the argument order, and prevents the need to rely on the template keyword in templated code. /// /// but with less redundancy and more consistency as it does not modify the argument order /// and seamlessly enable hybrid fixed/dynamic sizes. /// /// \note Even in the case that 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. /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa class Block, fix, fix(int) /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline typename FixedBlockXpr<...,...>::Type #endif block(Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols) { return typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type( derived(), startRow, startCol, internal::get_runtime_value(blockRows), internal::get_runtime_value(blockCols)); } /// This is the const version of block(Index,Index,NRowsType,NColsType) template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline const typename ConstFixedBlockXpr<...,...>::Type #endif block(Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols) const { return typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type( derived(), startRow, startCol, internal::get_runtime_value(blockRows), internal::get_runtime_value(blockCols)); } /// \returns a expression of a top-right corner of \c *this with either dynamic or fixed sizes. /// /// \param cRows the number of rows in the corner /// \param cCols the number of columns in the corner /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example with dynamic sizes: \include MatrixBase_topRightCorner_int_int.cpp /// Output: \verbinclude MatrixBase_topRightCorner_int_int.out /// /// The number of rows \a blockRows and columns \a blockCols can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline typename FixedBlockXpr<...,...>::Type #endif topRightCorner(NRowsType cRows, NColsType cCols) { return typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), 0, cols() - internal::get_runtime_value(cCols), internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// This is the const version of topRightCorner(NRowsType, NColsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline const typename ConstFixedBlockXpr<...,...>::Type #endif topRightCorner(NRowsType cRows, NColsType cCols) const { return typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), 0, cols() - internal::get_runtime_value(cCols), internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// \returns an expression of a fixed-size top-right corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa class Block, block(Index,Index) /// template EIGEN_DEVICE_FUNC inline typename FixedBlockXpr::Type topRightCorner() { return typename FixedBlockXpr::Type(derived(), 0, cols() - CCols); } /// This is the const version of topRightCorner(). template EIGEN_DEVICE_FUNC inline const typename ConstFixedBlockXpr::Type topRightCorner() const { return typename ConstFixedBlockXpr::Type(derived(), 0, cols() - CCols); } /// \returns an expression of a top-right corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa class Block /// template inline typename FixedBlockXpr::Type topRightCorner(Index cRows, Index cCols) { return typename FixedBlockXpr::Type(derived(), 0, cols() - cCols, cRows, cCols); } /// This is the const version of topRightCorner(Index, Index). template inline const typename ConstFixedBlockXpr::Type topRightCorner(Index cRows, Index cCols) const { return typename ConstFixedBlockXpr::Type(derived(), 0, cols() - cCols, cRows, cCols); } /// \returns an expression of a top-left corner of \c *this with either dynamic or fixed sizes. /// /// \param cRows the number of rows in the corner /// \param cCols the number of columns in the corner /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example: \include MatrixBase_topLeftCorner_int_int.cpp /// Output: \verbinclude MatrixBase_topLeftCorner_int_int.out /// /// The number of rows \a blockRows and columns \a blockCols can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline typename FixedBlockXpr<...,...>::Type #endif topLeftCorner(NRowsType cRows, NColsType cCols) { return typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), 0, 0, internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// This is the const version of topLeftCorner(Index, Index). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline const typename ConstFixedBlockXpr<...,...>::Type #endif topLeftCorner(NRowsType cRows, NColsType cCols) const { return typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), 0, 0, internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// \returns an expression of a fixed-size top-left corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC inline typename FixedBlockXpr::Type topLeftCorner() { return typename FixedBlockXpr::Type(derived(), 0, 0); } /// This is the const version of topLeftCorner(). template EIGEN_DEVICE_FUNC inline const typename ConstFixedBlockXpr::Type topLeftCorner() const { return typename ConstFixedBlockXpr::Type(derived(), 0, 0); } /// \returns an expression of a top-left corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa class Block /// template inline typename FixedBlockXpr::Type topLeftCorner(Index cRows, Index cCols) { return typename FixedBlockXpr::Type(derived(), 0, 0, cRows, cCols); } /// This is the const version of topLeftCorner(Index, Index). template inline const typename ConstFixedBlockXpr::Type topLeftCorner(Index cRows, Index cCols) const { return typename ConstFixedBlockXpr::Type(derived(), 0, 0, cRows, cCols); } /// \returns an expression of a bottom-right corner of \c *this with either dynamic or fixed sizes. /// /// \param cRows the number of rows in the corner /// \param cCols the number of columns in the corner /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example: \include MatrixBase_bottomRightCorner_int_int.cpp /// Output: \verbinclude MatrixBase_bottomRightCorner_int_int.out /// /// The number of rows \a blockRows and columns \a blockCols can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline typename FixedBlockXpr<...,...>::Type #endif bottomRightCorner(NRowsType cRows, NColsType cCols) { return typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), rows() - internal::get_runtime_value(cRows), cols() - internal::get_runtime_value(cCols), internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// This is the const version of bottomRightCorner(NRowsType, NColsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline const typename ConstFixedBlockXpr<...,...>::Type #endif bottomRightCorner(NRowsType cRows, NColsType cCols) const { return typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), rows() - internal::get_runtime_value(cRows), cols() - internal::get_runtime_value(cCols), internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// \returns an expression of a fixed-size bottom-right corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC inline typename FixedBlockXpr::Type bottomRightCorner() { return typename FixedBlockXpr::Type(derived(), rows() - CRows, cols() - CCols); } /// This is the const version of bottomRightCorner(). template EIGEN_DEVICE_FUNC inline const typename ConstFixedBlockXpr::Type bottomRightCorner() const { return typename ConstFixedBlockXpr::Type(derived(), rows() - CRows, cols() - CCols); } /// \returns an expression of a bottom-right corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa class Block /// template inline typename FixedBlockXpr::Type bottomRightCorner(Index cRows, Index cCols) { return typename FixedBlockXpr::Type(derived(), rows() - cRows, cols() - cCols, cRows, cCols); } /// This is the const version of bottomRightCorner(Index, Index). template inline const typename ConstFixedBlockXpr::Type bottomRightCorner(Index cRows, Index cCols) const { return typename ConstFixedBlockXpr::Type(derived(), rows() - cRows, cols() - cCols, cRows, cCols); } /// \returns an expression of a bottom-left corner of \c *this with either dynamic or fixed sizes. /// /// \param cRows the number of rows in the corner /// \param cCols the number of columns in the corner /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example: \include MatrixBase_bottomLeftCorner_int_int.cpp /// Output: \verbinclude MatrixBase_bottomLeftCorner_int_int.out /// /// The number of rows \a blockRows and columns \a blockCols can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline typename FixedBlockXpr<...,...>::Type #endif bottomLeftCorner(NRowsType cRows, NColsType cCols) { return typename FixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), rows() - internal::get_runtime_value(cRows), 0, internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// This is the const version of bottomLeftCorner(NRowsType, NColsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type #else inline typename ConstFixedBlockXpr<...,...>::Type #endif bottomLeftCorner(NRowsType cRows, NColsType cCols) const { return typename ConstFixedBlockXpr::value,internal::get_fixed_value::value>::Type (derived(), rows() - internal::get_runtime_value(cRows), 0, internal::get_runtime_value(cRows), internal::get_runtime_value(cCols)); } /// \returns an expression of a fixed-size bottom-left corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC inline typename FixedBlockXpr::Type bottomLeftCorner() { return typename FixedBlockXpr::Type(derived(), rows() - CRows, 0); } /// This is the const version of bottomLeftCorner(). template EIGEN_DEVICE_FUNC inline const typename ConstFixedBlockXpr::Type bottomLeftCorner() const { return typename ConstFixedBlockXpr::Type(derived(), rows() - CRows, 0); } /// \returns an expression of a bottom-left corner of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa class Block /// template inline typename FixedBlockXpr::Type bottomLeftCorner(Index cRows, Index cCols) { return typename FixedBlockXpr::Type(derived(), rows() - cRows, 0, cRows, cCols); } /// This is the const version of bottomLeftCorner(Index, Index). template inline const typename ConstFixedBlockXpr::Type bottomLeftCorner(Index cRows, Index cCols) const { return typename ConstFixedBlockXpr::Type(derived(), rows() - cRows, 0, cRows, cCols); } /// \returns a block consisting of the top rows of \c *this. /// /// \param n the number of rows in the block /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// /// Example: \include MatrixBase_topRows_int.cpp /// Output: \verbinclude MatrixBase_topRows_int.out /// /// The number of rows \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename NRowsBlockXpr::value>::Type #else inline typename NRowsBlockXpr<...>::Type #endif topRows(NRowsType n) { return typename NRowsBlockXpr::value>::Type (derived(), 0, 0, internal::get_runtime_value(n), cols()); } /// This is the const version of topRows(NRowsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstNRowsBlockXpr::value>::Type #else inline const typename ConstNRowsBlockXpr<...>::Type #endif topRows(NRowsType n) const { return typename ConstNRowsBlockXpr::value>::Type (derived(), 0, 0, internal::get_runtime_value(n), cols()); } /// \returns a block consisting of the top rows of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 \c *this. /// /// \param n the number of rows in the block /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// /// Example: \include MatrixBase_bottomRows_int.cpp /// Output: \verbinclude MatrixBase_bottomRows_int.out /// /// The number of rows \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename NRowsBlockXpr::value>::Type #else inline typename NRowsBlockXpr<...>::Type #endif bottomRows(NRowsType n) { return typename NRowsBlockXpr::value>::Type (derived(), rows() - internal::get_runtime_value(n), 0, internal::get_runtime_value(n), cols()); } /// This is the const version of bottomRows(NRowsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstNRowsBlockXpr::value>::Type #else inline const typename ConstNRowsBlockXpr<...>::Type #endif bottomRows(NRowsType n) const { return typename ConstNRowsBlockXpr::value>::Type (derived(), rows() - internal::get_runtime_value(n), 0, internal::get_runtime_value(n), cols()); } /// \returns a block consisting of the bottom rows of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 \c *this. /// /// \param startRow the index of the first row in the block /// \param n the number of rows in the block /// \tparam NRowsType the type of the value handling the number of rows in the block, typically Index. /// /// Example: \include DenseBase_middleRows_int.cpp /// Output: \verbinclude DenseBase_middleRows_int.out /// /// The number of rows \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename NRowsBlockXpr::value>::Type #else inline typename NRowsBlockXpr<...>::Type #endif middleRows(Index startRow, NRowsType n) { return typename NRowsBlockXpr::value>::Type (derived(), startRow, 0, internal::get_runtime_value(n), cols()); } /// This is the const version of middleRows(Index,NRowsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstNRowsBlockXpr::value>::Type #else inline const typename ConstNRowsBlockXpr<...>::Type #endif middleRows(Index startRow, NRowsType n) const { return typename ConstNRowsBlockXpr::value>::Type (derived(), startRow, 0, internal::get_runtime_value(n), cols()); } /// \returns a block consisting of a range of rows of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 \c *this. /// /// \param n the number of columns in the block /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example: \include MatrixBase_leftCols_int.cpp /// Output: \verbinclude MatrixBase_leftCols_int.out /// /// The number of columns \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename NColsBlockXpr::value>::Type #else inline typename NColsBlockXpr<...>::Type #endif leftCols(NColsType n) { return typename NColsBlockXpr::value>::Type (derived(), 0, 0, rows(), internal::get_runtime_value(n)); } /// This is the const version of leftCols(NColsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstNColsBlockXpr::value>::Type #else inline const typename ConstNColsBlockXpr<...>::Type #endif leftCols(NColsType n) const { return typename ConstNColsBlockXpr::value>::Type (derived(), 0, 0, rows(), internal::get_runtime_value(n)); } /// \returns a block consisting of the left columns of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 \c *this. /// /// \param n the number of columns in the block /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example: \include MatrixBase_rightCols_int.cpp /// Output: \verbinclude MatrixBase_rightCols_int.out /// /// The number of columns \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename NColsBlockXpr::value>::Type #else inline typename NColsBlockXpr<...>::Type #endif rightCols(NColsType n) { return typename NColsBlockXpr::value>::Type (derived(), 0, cols() - internal::get_runtime_value(n), rows(), internal::get_runtime_value(n)); } /// This is the const version of rightCols(NColsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstNColsBlockXpr::value>::Type #else inline const typename ConstNColsBlockXpr<...>::Type #endif rightCols(NColsType n) const { return typename ConstNColsBlockXpr::value>::Type (derived(), 0, cols() - internal::get_runtime_value(n), rows(), internal::get_runtime_value(n)); } /// \returns a block consisting of the right columns of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 \c *this. /// /// \param startCol the index of the first column in the block /// \param numCols the number of columns in the block /// \tparam NColsType the type of the value handling the number of columns in the block, typically Index. /// /// Example: \include DenseBase_middleCols_int.cpp /// Output: \verbinclude DenseBase_middleCols_int.out /// /// The number of columns \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename NColsBlockXpr::value>::Type #else inline typename NColsBlockXpr<...>::Type #endif middleCols(Index startCol, NColsType numCols) { return typename NColsBlockXpr::value>::Type (derived(), 0, startCol, rows(), internal::get_runtime_value(numCols)); } /// This is the const version of middleCols(Index,NColsType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstNColsBlockXpr::value>::Type #else inline const typename ConstNColsBlockXpr<...>::Type #endif middleCols(Index startCol, NColsType numCols) const { return typename ConstNColsBlockXpr::value>::Type (derived(), 0, startCol, rows(), internal::get_runtime_value(numCols)); } /// \returns a block consisting of a range of columns of \c *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 /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 of \c *this. /// /// The template parameters \a NRows and \a NCols 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 The usage of of this overload is discouraged from %Eigen 3.4, better used the generic /// block(Index,Index,NRowsType,NColsType), here is the one-to-one equivalence: /// \code /// mat.template block(i,j) <--> mat.block(i,j,fix,fix) /// \endcode /// /// \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 /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template EIGEN_DEVICE_FUNC inline typename FixedBlockXpr::Type block(Index startRow, Index startCol) { return typename FixedBlockXpr::Type(derived(), startRow, startCol); } /// This is the const version of block<>(Index, Index). */ template EIGEN_DEVICE_FUNC inline const typename ConstFixedBlockXpr::Type block(Index startRow, Index startCol) const { return typename ConstFixedBlockXpr::Type(derived(), startRow, startCol); } /// \returns an expression of a block of \c *this. /// /// \tparam NRows number of rows in block as specified at compile-time /// \tparam NCols 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 NRows unless /// \a NRows 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.out /// /// \note The usage of of this overload is discouraged from %Eigen 3.4, better used the generic /// block(Index,Index,NRowsType,NColsType), here is the one-to-one complete equivalence: /// \code /// mat.template block(i,j,rows,cols) <--> mat.block(i,j,fix(rows),fix(cols)) /// \endcode /// If we known that, e.g., NRows==Dynamic and NCols!=Dynamic, then the equivalence becomes: /// \code /// mat.template block(i,j,rows,NCols) <--> mat.block(i,j,rows,fix) /// \endcode /// EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL /// /// \sa block(Index,Index,NRowsType,NColsType), class Block /// template inline typename FixedBlockXpr::Type block(Index startRow, Index startCol, Index blockRows, Index blockCols) { return typename FixedBlockXpr::Type(derived(), startRow, startCol, blockRows, blockCols); } /// This is the const version of block<>(Index, Index, Index, Index). template inline const typename ConstFixedBlockXpr::Type block(Index startRow, Index startCol, Index blockRows, Index blockCols) const { return typename ConstFixedBlockXpr::Type(derived(), startRow, startCol, blockRows, blockCols); } /// \returns an expression of the \a i-th column of \c *this. Note that the numbering starts at 0. /// /// Example: \include MatrixBase_col.cpp /// Output: \verbinclude MatrixBase_col.out /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) /** * \sa row(), class Block */ EIGEN_DEVICE_FUNC inline ColXpr col(Index i) { return ColXpr(derived(), i); } /// This is the const version of col(). EIGEN_DEVICE_FUNC inline ConstColXpr col(Index i) const { return ConstColXpr(derived(), i); } /// \returns an expression of the \a i-th row of \c *this. Note that the numbering starts at 0. /// /// Example: \include MatrixBase_row.cpp /// Output: \verbinclude MatrixBase_row.out /// EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) /** * \sa col(), class Block */ EIGEN_DEVICE_FUNC inline RowXpr row(Index i) { return RowXpr(derived(), i); } /// This is the const version of row(). */ EIGEN_DEVICE_FUNC inline ConstRowXpr row(Index i) const { return ConstRowXpr(derived(), i); } /// \returns an expression of a segment (i.e. a vector block) in \c *this with either dynamic or fixed sizes. /// /// \only_for_vectors /// /// \param start the first coefficient in the segment /// \param n the number of coefficients in the segment /// \tparam NType the type of the value handling the number of coefficients in the segment, typically Index. /// /// Example: \include MatrixBase_segment_int_int.cpp /// Output: \verbinclude MatrixBase_segment_int_int.out /// /// The number of coefficients \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// /// \note Even in the case that 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 block(Index,Index,NRowsType,NColsType), fix, fix(int), class Block /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedSegmentReturnType::value>::Type #else inline typename FixedSegmentReturnType<...>::Type #endif segment(Index start, NType n) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename FixedSegmentReturnType::value>::Type (derived(), start, internal::get_runtime_value(n)); } /// This is the const version of segment(Index,NType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstFixedSegmentReturnType::value>::Type #else inline const typename ConstFixedSegmentReturnType<...>::Type #endif segment(Index start, NType n) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename ConstFixedSegmentReturnType::value>::Type (derived(), start, internal::get_runtime_value(n)); } /// \returns an expression of the first coefficients of \c *this with either dynamic or fixed sizes. /// /// \only_for_vectors /// /// \param n the number of coefficients in the segment /// \tparam NType the type of the value handling the number of coefficients in the segment, typically Index. /// /// Example: \include MatrixBase_start_int.cpp /// Output: \verbinclude MatrixBase_start_int.out /// /// The number of coefficients \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// /// \note Even in the case that 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) /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedSegmentReturnType::value>::Type #else inline typename FixedSegmentReturnType<...>::Type #endif head(NType n) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename FixedSegmentReturnType::value>::Type (derived(), 0, internal::get_runtime_value(n)); } /// This is the const version of head(NType). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstFixedSegmentReturnType::value>::Type #else inline const typename ConstFixedSegmentReturnType<...>::Type #endif head(NType n) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename ConstFixedSegmentReturnType::value>::Type (derived(), 0, internal::get_runtime_value(n)); } /// \returns an expression of a last coefficients of \c *this with either dynamic or fixed sizes. /// /// \only_for_vectors /// /// \param n the number of coefficients in the segment /// \tparam NType the type of the value handling the number of coefficients in the segment, typically Index. /// /// Example: \include MatrixBase_end_int.cpp /// Output: \verbinclude MatrixBase_end_int.out /// /// The number of coefficients \a n can also be specified at compile-time by passing Eigen::fix, /// or Eigen::fix(n) as arguments. /// See \link block(Index,Index,NRowsType,NColsType) block() \endlink for the details. /// /// \note Even in the case that 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) /// template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline typename FixedSegmentReturnType::value>::Type #else inline typename FixedSegmentReturnType<...>::Type #endif tail(NType n) { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename FixedSegmentReturnType::value>::Type (derived(), this->size() - internal::get_runtime_value(n), internal::get_runtime_value(n)); } /// This is the const version of tail(Index). template EIGEN_DEVICE_FUNC #ifndef EIGEN_PARSED_BY_DOXYGEN inline const typename ConstFixedSegmentReturnType::value>::Type #else inline const typename ConstFixedSegmentReturnType<...>::Type #endif tail(NType n) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename ConstFixedSegmentReturnType::value>::Type (derived(), this->size() - internal::get_runtime_value(n), internal::get_runtime_value(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 segment(Index,NType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 \c *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 head(NType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC 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 \c *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 tail(NType), class Block /// template EIGEN_DEVICE_FUNC 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 EIGEN_DEVICE_FUNC inline typename ConstFixedSegmentReturnType::Type tail(Index n = N) const { EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) return typename ConstFixedSegmentReturnType::Type(derived(), size() - n); } /// \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this /// is col-major (resp. row-major). /// InnerVectorReturnType innerVector(Index outer) { return InnerVectorReturnType(derived(), outer); } /// \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this /// is col-major (resp. row-major). Read-only. /// const ConstInnerVectorReturnType innerVector(Index outer) const { return ConstInnerVectorReturnType(derived(), outer); } /// \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this /// is col-major (resp. row-major). /// InnerVectorsReturnType innerVectors(Index outerStart, Index outerSize) { return Block(derived(), IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart, IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize); } /// \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this /// is col-major (resp. row-major). Read-only. /// const ConstInnerVectorsReturnType innerVectors(Index outerStart, Index outerSize) const { return Block(derived(), IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart, IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize); }