Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Sparse / CoreIterators.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra. Eigen itself is part of the KDE project.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
5 //
6 // Eigen is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 3 of the License, or (at your option) any later version.
10 //
11 // Alternatively, you can redistribute it and/or
12 // modify it under the terms of the GNU General Public License as
13 // published by the Free Software Foundation; either version 2 of
14 // the License, or (at your option) any later version.
15 //
16 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License and a copy of the GNU General Public License along with
23 // Eigen. If not, see <http://www.gnu.org/licenses/>.
24
25 #ifndef EIGEN_COREITERATORS_H
26 #define EIGEN_COREITERATORS_H
27
28 /* This file contains the respective InnerIterator definition of the expressions defined in Eigen/Core
29  */
30
31 /** \class InnerIterator
32   * \brief An InnerIterator allows to loop over the element of a sparse (or dense) matrix or expression
33   *
34   * todo
35   */
36
37 // generic version for dense matrix and expressions
38 template<typename Derived> class MatrixBase<Derived>::InnerIterator
39 {
40     typedef typename Derived::Scalar Scalar;
41     enum { IsRowMajor = (Derived::Flags&RowMajorBit)==RowMajorBit };
42   public:
43     EIGEN_STRONG_INLINE InnerIterator(const Derived& expr, int outer)
44       : m_expression(expr), m_inner(0), m_outer(outer), m_end(expr.rows())
45     {}
46
47     EIGEN_STRONG_INLINE Scalar value() const
48     {
49       return (IsRowMajor) ? m_expression.coeff(m_outer, m_inner)
50                           : m_expression.coeff(m_inner, m_outer);
51     }
52
53     EIGEN_STRONG_INLINE InnerIterator& operator++() { m_inner++; return *this; }
54
55     EIGEN_STRONG_INLINE int index() const { return m_inner; }
56     inline int row() const { return IsRowMajor ? m_outer : index(); }
57     inline int col() const { return IsRowMajor ? index() : m_outer; }
58
59     EIGEN_STRONG_INLINE operator bool() const { return m_inner < m_end && m_inner>=0; }
60
61   protected:
62     const Derived& m_expression;
63     int m_inner;
64     const int m_outer;
65     const int m_end;
66 };
67
68 #endif // EIGEN_COREITERATORS_H