mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-04-20 08:39:37 +08:00
2ee68a074e
Finally the importing macro is named EIGEN_BASIC_PUBLIC_INTERFACE because it does not only import the ei_traits, it also makes the base class a friend, etc.
120 lines
3.4 KiB
C++
120 lines
3.4 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-2008 Benoit Jacob <jacob@math.jussieu.fr>
|
|
//
|
|
// Eigen is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 3 of the License, or (at your option) any later version.
|
|
//
|
|
// Alternatively, 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 of
|
|
// the License, 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 Lesser General Public License or the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License and a copy of the GNU General Public License along with
|
|
// Eigen. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
#ifndef EIGEN_COLUMN_H
|
|
#define EIGEN_COLUMN_H
|
|
|
|
/** \class Column
|
|
*
|
|
* \brief Expression of a column
|
|
*
|
|
* \param MatrixType the type of the object in which we are taking a column
|
|
*
|
|
* This class represents an expression of a column. It is the return
|
|
* type of MatrixBase::col() and most of the time this is the only way it
|
|
* is used.
|
|
*
|
|
* However, if you want to directly maniputate column 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_Column.cpp
|
|
* Output: \verbinclude class_Column.out
|
|
*
|
|
* \sa MatrixBase::col()
|
|
*/
|
|
template<typename MatrixType>
|
|
struct ei_traits<Column<MatrixType> >
|
|
{
|
|
typedef typename MatrixType::Scalar Scalar;
|
|
enum {
|
|
RowsAtCompileTime = MatrixType::RowsAtCompileTime,
|
|
ColsAtCompileTime = 1,
|
|
MaxRowsAtCompileTime = MatrixType::MaxRowsAtCompileTime,
|
|
MaxColsAtCompileTime = 1
|
|
};
|
|
};
|
|
|
|
template<typename MatrixType> class Column
|
|
: public MatrixBase<Column<MatrixType> >
|
|
{
|
|
public:
|
|
|
|
EIGEN_BASIC_PUBLIC_INTERFACE(Column)
|
|
|
|
typedef typename MatrixType::AsArg MatRef;
|
|
|
|
Column(const MatRef& matrix, int col)
|
|
: m_matrix(matrix), m_col(col)
|
|
{
|
|
assert(col >= 0 && col < matrix.cols());
|
|
}
|
|
|
|
EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Column)
|
|
|
|
private:
|
|
|
|
const Column& _asArg() const { return *this; }
|
|
int _rows() const { return m_matrix.rows(); }
|
|
int _cols() const { return 1; }
|
|
|
|
Scalar& _coeffRef(int row, int)
|
|
{
|
|
return m_matrix.coeffRef(row, m_col);
|
|
}
|
|
|
|
Scalar _coeff(int row, int) const
|
|
{
|
|
return m_matrix.coeff(row, m_col);
|
|
}
|
|
|
|
protected:
|
|
MatRef m_matrix;
|
|
const int m_col;
|
|
};
|
|
|
|
/** \returns an expression of the \a i-th column of *this. Note that the numbering starts at 0.
|
|
*
|
|
* Example: \include MatrixBase_col.cpp
|
|
* Output: \verbinclude MatrixBase_col.out
|
|
*
|
|
* \sa row(), class Column */
|
|
template<typename Derived>
|
|
Column<Derived>
|
|
MatrixBase<Derived>::col(int i)
|
|
{
|
|
return Column<Derived>(asArg(), i);
|
|
}
|
|
|
|
/** This is the const version of col(). */
|
|
template<typename Derived>
|
|
const Column<Derived>
|
|
MatrixBase<Derived>::col(int i) const
|
|
{
|
|
return Column<Derived>(asArg(), i);
|
|
}
|
|
|
|
#endif // EIGEN_COLUMN_H
|