diff options
Diffstat (limited to 'runtimes/nn/depend/external/eigen/Eigen/src/plugins/BlockMethods.h')
| -rw-r--r-- | runtimes/nn/depend/external/eigen/Eigen/src/plugins/BlockMethods.h | 1058 |
1 files changed, 0 insertions, 1058 deletions
diff --git a/runtimes/nn/depend/external/eigen/Eigen/src/plugins/BlockMethods.h b/runtimes/nn/depend/external/eigen/Eigen/src/plugins/BlockMethods.h deleted file mode 100644 index ac35a0086..000000000 --- a/runtimes/nn/depend/external/eigen/Eigen/src/plugins/BlockMethods.h +++ /dev/null @@ -1,1058 +0,0 @@ -// This file is part of Eigen, a lightweight C++ template library -// for linear algebra. -// -// Copyright (C) 2008-2010 Gael Guennebaud <gael.guennebaud@inria.fr> -// Copyright (C) 2006-2010 Benoit Jacob <jacob.benoit.1@gmail.com> -// -// 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<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ColXpr; -typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ConstColXpr; -/// \internal expression type of a row */ -typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowXpr; -typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowXpr; -/// \internal expression type of a block of whole columns */ -typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ColsBlockXpr; -typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ConstColsBlockXpr; -/// \internal expression type of a block of whole rows */ -typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowsBlockXpr; -typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowsBlockXpr; -/// \internal expression type of a block of whole columns */ -template<int N> struct NColsBlockXpr { typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, N, !IsRowMajor> Type; }; -template<int N> struct ConstNColsBlockXpr { typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, N, !IsRowMajor> Type; }; -/// \internal expression type of a block of whole rows */ -template<int N> struct NRowsBlockXpr { typedef Block<Derived, N, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Type; }; -template<int N> struct ConstNRowsBlockXpr { typedef const Block<const Derived, N, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Type; }; -/// \internal expression of a block */ -typedef Block<Derived> BlockXpr; -typedef const Block<const Derived> ConstBlockXpr; -/// \internal expression of a block of fixed sizes */ -template<int Rows, int Cols> struct FixedBlockXpr { typedef Block<Derived,Rows,Cols> Type; }; -template<int Rows, int Cols> struct ConstFixedBlockXpr { typedef Block<const Derived,Rows,Cols> Type; }; - -typedef VectorBlock<Derived> SegmentReturnType; -typedef const VectorBlock<const Derived> ConstSegmentReturnType; -template<int Size> struct FixedSegmentReturnType { typedef VectorBlock<Derived, Size> Type; }; -template<int Size> struct ConstFixedSegmentReturnType { typedef const VectorBlock<const Derived, Size> 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. -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index) -/// -EIGEN_DEVICE_FUNC -inline BlockXpr block(Index startRow, Index startCol, Index blockRows, Index blockCols) -{ - return BlockXpr(derived(), startRow, startCol, blockRows, blockCols); -} - -/// This is the const version of block(Index,Index,Index,Index). */ -EIGEN_DEVICE_FUNC -inline const ConstBlockXpr block(Index startRow, Index startCol, Index blockRows, Index blockCols) const -{ - return ConstBlockXpr(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline BlockXpr topRightCorner(Index cRows, Index cCols) -{ - return BlockXpr(derived(), 0, cols() - cCols, cRows, cCols); -} - -/// This is the const version of topRightCorner(Index, Index). -EIGEN_DEVICE_FUNC -inline const ConstBlockXpr topRightCorner(Index cRows, Index cCols) const -{ - return ConstBlockXpr(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block<int,int>(Index,Index) -/// -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline typename FixedBlockXpr<CRows,CCols>::Type topRightCorner() -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), 0, cols() - CCols); -} - -/// This is the const version of topRightCorner<int, int>(). -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type topRightCorner() const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block -/// -template<int CRows, int CCols> -inline typename FixedBlockXpr<CRows,CCols>::Type topRightCorner(Index cRows, Index cCols) -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), 0, cols() - cCols, cRows, cCols); -} - -/// This is the const version of topRightCorner<int, int>(Index, Index). -template<int CRows, int CCols> -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type topRightCorner(Index cRows, Index cCols) const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline BlockXpr topLeftCorner(Index cRows, Index cCols) -{ - return BlockXpr(derived(), 0, 0, cRows, cCols); -} - -/// This is the const version of topLeftCorner(Index, Index). -EIGEN_DEVICE_FUNC -inline const ConstBlockXpr topLeftCorner(Index cRows, Index cCols) const -{ - return ConstBlockXpr(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline typename FixedBlockXpr<CRows,CCols>::Type topLeftCorner() -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), 0, 0); -} - -/// This is the const version of topLeftCorner<int, int>(). -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type topLeftCorner() const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block -/// -template<int CRows, int CCols> -inline typename FixedBlockXpr<CRows,CCols>::Type topLeftCorner(Index cRows, Index cCols) -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), 0, 0, cRows, cCols); -} - -/// This is the const version of topLeftCorner<int, int>(Index, Index). -template<int CRows, int CCols> -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type topLeftCorner(Index cRows, Index cCols) const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline BlockXpr bottomRightCorner(Index cRows, Index cCols) -{ - return BlockXpr(derived(), rows() - cRows, cols() - cCols, cRows, cCols); -} - -/// This is the const version of bottomRightCorner(Index, Index). -EIGEN_DEVICE_FUNC -inline const ConstBlockXpr bottomRightCorner(Index cRows, Index cCols) const -{ - return ConstBlockXpr(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline typename FixedBlockXpr<CRows,CCols>::Type bottomRightCorner() -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), rows() - CRows, cols() - CCols); -} - -/// This is the const version of bottomRightCorner<int, int>(). -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type bottomRightCorner() const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block -/// -template<int CRows, int CCols> -inline typename FixedBlockXpr<CRows,CCols>::Type bottomRightCorner(Index cRows, Index cCols) -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), rows() - cRows, cols() - cCols, cRows, cCols); -} - -/// This is the const version of bottomRightCorner<int, int>(Index, Index). -template<int CRows, int CCols> -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type bottomRightCorner(Index cRows, Index cCols) const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline BlockXpr bottomLeftCorner(Index cRows, Index cCols) -{ - return BlockXpr(derived(), rows() - cRows, 0, cRows, cCols); -} - -/// This is the const version of bottomLeftCorner(Index, Index). -EIGEN_DEVICE_FUNC -inline const ConstBlockXpr bottomLeftCorner(Index cRows, Index cCols) const -{ - return ConstBlockXpr(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline typename FixedBlockXpr<CRows,CCols>::Type bottomLeftCorner() -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), rows() - CRows, 0); -} - -/// This is the const version of bottomLeftCorner<int, int>(). -template<int CRows, int CCols> -EIGEN_DEVICE_FUNC -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type bottomLeftCorner() const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block -/// -template<int CRows, int CCols> -inline typename FixedBlockXpr<CRows,CCols>::Type bottomLeftCorner(Index cRows, Index cCols) -{ - return typename FixedBlockXpr<CRows,CCols>::Type(derived(), rows() - cRows, 0, cRows, cCols); -} - -/// This is the const version of bottomLeftCorner<int, int>(Index, Index). -template<int CRows, int CCols> -inline const typename ConstFixedBlockXpr<CRows,CCols>::Type bottomLeftCorner(Index cRows, Index cCols) const -{ - return typename ConstFixedBlockXpr<CRows,CCols>::Type(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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline RowsBlockXpr topRows(Index n) -{ - return RowsBlockXpr(derived(), 0, 0, n, cols()); -} - -/// This is the const version of topRows(Index). -EIGEN_DEVICE_FUNC -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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int N> -EIGEN_DEVICE_FUNC -inline typename NRowsBlockXpr<N>::Type topRows(Index n = N) -{ - return typename NRowsBlockXpr<N>::Type(derived(), 0, 0, n, cols()); -} - -/// This is the const version of topRows<int>(). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstNRowsBlockXpr<N>::Type topRows(Index n = N) const -{ - return typename ConstNRowsBlockXpr<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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline RowsBlockXpr bottomRows(Index n) -{ - return RowsBlockXpr(derived(), rows() - n, 0, n, cols()); -} - -/// This is the const version of bottomRows(Index). -EIGEN_DEVICE_FUNC -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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int N> -EIGEN_DEVICE_FUNC -inline typename NRowsBlockXpr<N>::Type bottomRows(Index n = N) -{ - return typename NRowsBlockXpr<N>::Type(derived(), rows() - n, 0, n, cols()); -} - -/// This is the const version of bottomRows<int>(). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstNRowsBlockXpr<N>::Type bottomRows(Index n = N) const -{ - return typename ConstNRowsBlockXpr<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 n the number of rows in the block -/// -/// Example: \include DenseBase_middleRows_int.cpp -/// Output: \verbinclude DenseBase_middleRows_int.out -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline RowsBlockXpr middleRows(Index startRow, Index n) -{ - return RowsBlockXpr(derived(), startRow, 0, n, cols()); -} - -/// This is the const version of middleRows(Index,Index). -EIGEN_DEVICE_FUNC -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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(row-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int N> -EIGEN_DEVICE_FUNC -inline typename NRowsBlockXpr<N>::Type middleRows(Index startRow, Index n = N) -{ - return typename NRowsBlockXpr<N>::Type(derived(), startRow, 0, n, cols()); -} - -/// This is the const version of middleRows<int>(). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstNRowsBlockXpr<N>::Type middleRows(Index startRow, Index n = N) const -{ - return typename ConstNRowsBlockXpr<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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline ColsBlockXpr leftCols(Index n) -{ - return ColsBlockXpr(derived(), 0, 0, rows(), n); -} - -/// This is the const version of leftCols(Index). -EIGEN_DEVICE_FUNC -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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int N> -EIGEN_DEVICE_FUNC -inline typename NColsBlockXpr<N>::Type leftCols(Index n = N) -{ - return typename NColsBlockXpr<N>::Type(derived(), 0, 0, rows(), n); -} - -/// This is the const version of leftCols<int>(). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstNColsBlockXpr<N>::Type leftCols(Index n = N) const -{ - return typename ConstNColsBlockXpr<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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline ColsBlockXpr rightCols(Index n) -{ - return ColsBlockXpr(derived(), 0, cols() - n, rows(), n); -} - -/// This is the const version of rightCols(Index). -EIGEN_DEVICE_FUNC -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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int N> -EIGEN_DEVICE_FUNC -inline typename NColsBlockXpr<N>::Type rightCols(Index n = N) -{ - return typename NColsBlockXpr<N>::Type(derived(), 0, cols() - n, rows(), n); -} - -/// This is the const version of rightCols<int>(). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstNColsBlockXpr<N>::Type rightCols(Index n = N) const -{ - return typename ConstNColsBlockXpr<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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -EIGEN_DEVICE_FUNC -inline ColsBlockXpr middleCols(Index startCol, Index numCols) -{ - return ColsBlockXpr(derived(), 0, startCol, rows(), numCols); -} - -/// This is the const version of middleCols(Index,Index). -EIGEN_DEVICE_FUNC -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 -/// -EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(column-major) -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int N> -EIGEN_DEVICE_FUNC -inline typename NColsBlockXpr<N>::Type middleCols(Index startCol, Index n = N) -{ - return typename NColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), n); -} - -/// This is the const version of middleCols<int>(). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstNColsBlockXpr<N>::Type middleCols(Index startCol, Index n = N) const -{ - return typename ConstNColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), n); -} - - - -/// \returns a fixed-size expression of a block in *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 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 class Block, block(Index,Index,Index,Index) -/// -template<int NRows, int NCols> -EIGEN_DEVICE_FUNC -inline typename FixedBlockXpr<NRows,NCols>::Type block(Index startRow, Index startCol) -{ - return typename FixedBlockXpr<NRows,NCols>::Type(derived(), startRow, startCol); -} - -/// This is the const version of block<>(Index, Index). */ -template<int NRows, int NCols> -EIGEN_DEVICE_FUNC -inline const typename ConstFixedBlockXpr<NRows,NCols>::Type block(Index startRow, Index startCol) const -{ - return typename ConstFixedBlockXpr<NRows,NCols>::Type(derived(), startRow, startCol); -} - -/// \returns an expression of a block in *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.cpp -/// -EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL -/// -/// \sa class Block, block(Index,Index,Index,Index) -/// -template<int NRows, int NCols> -inline typename FixedBlockXpr<NRows,NCols>::Type block(Index startRow, Index startCol, - Index blockRows, Index blockCols) -{ - return typename FixedBlockXpr<NRows,NCols>::Type(derived(), startRow, startCol, blockRows, blockCols); -} - -/// This is the const version of block<>(Index, Index, Index, Index). -template<int NRows, int NCols> -inline const typename ConstFixedBlockXpr<NRows,NCols>::Type block(Index startRow, Index startCol, - Index blockRows, Index blockCols) const -{ - return typename ConstFixedBlockXpr<NRows,NCols>::Type(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 -/// -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 *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 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) -/// -EIGEN_DEVICE_FUNC -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). -EIGEN_DEVICE_FUNC -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) -/// -EIGEN_DEVICE_FUNC -inline SegmentReturnType head(Index n) -{ - EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) - return SegmentReturnType(derived(), 0, n); -} - -/// This is the const version of head(Index). -EIGEN_DEVICE_FUNC -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) -/// -EIGEN_DEVICE_FUNC -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). -EIGEN_DEVICE_FUNC -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<int N> -EIGEN_DEVICE_FUNC -inline typename FixedSegmentReturnType<N>::Type segment(Index start, Index n = N) -{ - EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) - return typename FixedSegmentReturnType<N>::Type(derived(), start, n); -} - -/// This is the const version of segment<int>(Index). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstFixedSegmentReturnType<N>::Type segment(Index start, Index n = N) const -{ - EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) - return typename ConstFixedSegmentReturnType<N>::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<int N> -EIGEN_DEVICE_FUNC -inline typename FixedSegmentReturnType<N>::Type head(Index n = N) -{ - EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) - return typename FixedSegmentReturnType<N>::Type(derived(), 0, n); -} - -/// This is the const version of head<int>(). -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstFixedSegmentReturnType<N>::Type head(Index n = N) const -{ - EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) - return typename ConstFixedSegmentReturnType<N>::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<int N> -EIGEN_DEVICE_FUNC -inline typename FixedSegmentReturnType<N>::Type tail(Index n = N) -{ - EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) - return typename FixedSegmentReturnType<N>::Type(derived(), size() - n); -} - -/// This is the const version of tail<int>. -template<int N> -EIGEN_DEVICE_FUNC -inline typename ConstFixedSegmentReturnType<N>::Type tail(Index n = N) const -{ - EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) - return typename ConstFixedSegmentReturnType<N>::Type(derived(), size() - n); -} |