mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-04-21 17:19:36 +08:00
dad245af56
with minimal code duplication. There now are only two (2) const_cast remaining in the whole source code. - eigen2 now fully allows copying a row-vector into a column-vector. added a unit-test for that. - split unit tests, improve docs, various improvements.
127 lines
4.6 KiB
C++
127 lines
4.6 KiB
C++
// This file is part of Eigen, a lightweight C++ template library
|
|
// for linear algebra. Eigen itself is part of the KDE project.
|
|
//
|
|
// Copyright (C) 2006-2007 Benoit Jacob <jacob@math.jussieu.fr>
|
|
//
|
|
// Eigen is free software; you can redistribute it and/or modify it under the
|
|
// terms of the GNU General Public License as published by the Free Software
|
|
// Foundation; either version 2 or (at your option) any later version.
|
|
//
|
|
// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
// details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License along
|
|
// with Eigen; if not, write to the Free Software Foundation, Inc., 51
|
|
// Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
//
|
|
// As a special exception, if other files instantiate templates or use macros
|
|
// or functions from this file, or you compile this file and link it
|
|
// with other works to produce a work based on this file, this file does not
|
|
// by itself cause the resulting work to be covered by the GNU General Public
|
|
// License. This exception does not invalidate any other reasons why a work
|
|
// based on this file might be covered by the GNU General Public License.
|
|
|
|
#ifndef EIGEN_BLOCK_H
|
|
#define EIGEN_BLOCK_H
|
|
|
|
/** \class Block
|
|
*
|
|
* \brief Expression of a fixed-size block
|
|
*
|
|
* \param MatrixType the type of the object in which we are taking a block
|
|
* \param BlockRows the number of rows of the block we are taking
|
|
* \param BlockCols the number of columns of the block we are taking
|
|
*
|
|
* This class represents an expression of a fixed-size block. It is the return
|
|
* type of MatrixBase::block() and most of the time this is the only way it
|
|
* is used.
|
|
*
|
|
* However, if you want to directly maniputate fixed-size block expressions,
|
|
* for instance if you want to write a function returning such an expression, you
|
|
* will need to use this class.
|
|
*
|
|
* Here is an example illustrating this:
|
|
* \include class_Block.cpp
|
|
* Output: \verbinclude class_Block.out
|
|
*
|
|
* \sa MatrixBase::block(), class DynBlock
|
|
*/
|
|
template<typename MatrixType, int BlockRows, int BlockCols> class Block
|
|
: public MatrixBase<typename MatrixType::Scalar,
|
|
Block<MatrixType, BlockRows, BlockCols> >
|
|
{
|
|
public:
|
|
typedef typename MatrixType::Scalar Scalar;
|
|
typedef typename MatrixType::Ref MatRef;
|
|
friend class MatrixBase<Scalar, Block<MatrixType, BlockRows, BlockCols> >;
|
|
|
|
Block(const MatRef& matrix, int startRow, int startCol)
|
|
: m_matrix(matrix), m_startRow(startRow), m_startCol(startCol)
|
|
{
|
|
assert(startRow >= 0 && BlockRows >= 1 && startRow + BlockRows <= matrix.rows()
|
|
&& startCol >= 0 && BlockCols >= 1 && startCol + BlockCols <= matrix.cols());
|
|
}
|
|
|
|
Block(const Block& other)
|
|
: m_matrix(other.m_matrix),
|
|
m_startRow(other.m_startRow), m_startCol(other.m_startCol) {}
|
|
|
|
EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Block)
|
|
|
|
private:
|
|
static const int _RowsAtCompileTime = BlockRows,
|
|
_ColsAtCompileTime = BlockCols;
|
|
|
|
const Block& _ref() const { return *this; }
|
|
int _rows() const { return BlockRows; }
|
|
int _cols() const { return BlockCols; }
|
|
|
|
Scalar& _coeffRef(int row, int col)
|
|
{
|
|
return m_matrix.coeffRef(row + m_startRow, col + m_startCol);
|
|
}
|
|
|
|
Scalar _coeff(int row, int col) const
|
|
{
|
|
return m_matrix.coeff(row + m_startRow, col + m_startCol);
|
|
}
|
|
|
|
protected:
|
|
MatRef m_matrix;
|
|
const int m_startRow, m_startCol;
|
|
};
|
|
|
|
/** \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.cpp
|
|
* Output: \verbinclude MatrixBase_block.out
|
|
*
|
|
* \sa class Block, dynBlock()
|
|
*/
|
|
template<typename Scalar, typename Derived>
|
|
template<int BlockRows, int BlockCols>
|
|
Block<Derived, BlockRows, BlockCols> MatrixBase<Scalar, Derived>
|
|
::block(int startRow, int startCol)
|
|
{
|
|
return Block<Derived, BlockRows, BlockCols>(ref(), startRow, startCol);
|
|
}
|
|
|
|
/** This is the const version of block(). */
|
|
template<typename Scalar, typename Derived>
|
|
template<int BlockRows, int BlockCols>
|
|
const Block<Derived, BlockRows, BlockCols> MatrixBase<Scalar, Derived>
|
|
::block(int startRow, int startCol) const
|
|
{
|
|
return Block<Derived, BlockRows, BlockCols>(ref(), startRow, startCol);
|
|
}
|
|
|
|
#endif // EIGEN_BLOCK_H
|