aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Core/Row.h
blob: 3a50297d38b7f4a270f09197f5d6ba44b84ca66f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
// 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_ROW_H
#define EIGEN_ROW_H

/** \class Row
  *
  * \brief Expression of a row
  *
  * \param MatrixType the type of the object in which we are taking a row
  *
  * This class represents an expression of a row. It is the return
  * type of MatrixBase::row() and most of the time this is the only way it
  * is used.
  *
  * However, if you want to directly maniputate row 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_Row.cpp
  * Output: \verbinclude class_Row.out
  *
  * \sa MatrixBase::row()
  */
template<typename MatrixType>
struct Scalar<Row<MatrixType> >
{ typedef typename Scalar<MatrixType>::Type Type; };

template<typename MatrixType> class Row
  : public MatrixBase<Row<MatrixType> >
{
  public:
    typedef typename Scalar<MatrixType>::Type Scalar;
    typedef typename MatrixType::AsArg MatRef;
    friend class MatrixBase<Row>;
    friend class MatrixBase<Row>::Traits;
    typedef MatrixBase<Row> Base;

    Row(const MatRef& matrix, int row)
      : m_matrix(matrix), m_row(row)
    {
      assert(row >= 0 && row < matrix.rows());
    }

    EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Row)

  private:
    enum {
      RowsAtCompileTime = 1,
      ColsAtCompileTime = MatrixType::Traits::ColsAtCompileTime,
      MaxRowsAtCompileTime = 1,
      MaxColsAtCompileTime = MatrixType::Traits::MaxColsAtCompileTime
    };

    const Row& _asArg() const { return *this; }

    int _rows() const { return 1; }
    int _cols() const { return m_matrix.cols(); }

    Scalar& _coeffRef(int, int col)
    {
      return m_matrix.coeffRef(m_row, col);
    }

    Scalar _coeff(int, int col) const
    {
      return m_matrix.coeff(m_row, col);
    }

  protected:
    MatRef m_matrix;
    const int m_row;
};

/** \returns an expression of the \a i-th row of *this. Note that the numbering starts at 0.
  *
  * Example: \include MatrixBase_row.cpp
  * Output: \verbinclude MatrixBase_row.out
  *
  * \sa col(), class Row */
template<typename Derived>
Row<Derived>
MatrixBase<Derived>::row(int i)
{
  return Row<Derived>(asArg(), i);
}

/** This is the const version of row(). */
template<typename Derived>
const Row<Derived>
MatrixBase<Derived>::row(int i) const
{
  return Row<Derived>(asArg(), i);
}

#endif // EIGEN_ROW_H