Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Sparse / SparseBlock.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 // Copyright (C) 2008 Daniel Gomez Ferro <dgomezferro@gmail.com>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_SPARSE_BLOCK_H
27 #define EIGEN_SPARSE_BLOCK_H
28
29 template<typename MatrixType, int Size>
30 struct ei_traits<SparseInnerVectorSet<MatrixType, Size> >
31 {
32   typedef typename ei_traits<MatrixType>::Scalar Scalar;
33   enum {
34     IsRowMajor = (int(MatrixType::Flags)&RowMajorBit)==RowMajorBit,
35     Flags = MatrixType::Flags,
36     RowsAtCompileTime = IsRowMajor ? Size : MatrixType::RowsAtCompileTime,
37     ColsAtCompileTime = IsRowMajor ? MatrixType::ColsAtCompileTime : Size,
38     CoeffReadCost = MatrixType::CoeffReadCost
39   };
40 };
41
42 template<typename MatrixType, int Size>
43 class SparseInnerVectorSet : ei_no_assignment_operator,
44   public SparseMatrixBase<SparseInnerVectorSet<MatrixType, Size> >
45 {
46     enum { IsRowMajor = ei_traits<SparseInnerVectorSet>::IsRowMajor };
47   public:
48
49     EIGEN_SPARSE_GENERIC_PUBLIC_INTERFACE(SparseInnerVectorSet)
50     class InnerIterator: public MatrixType::InnerIterator
51     {
52       public:
53         inline InnerIterator(const SparseInnerVectorSet& xpr, int outer)
54           : MatrixType::InnerIterator(xpr.m_matrix, xpr.m_outerStart + outer)
55         {}
56     };
57
58     inline SparseInnerVectorSet(const MatrixType& matrix, int outerStart, int outerSize)
59       : m_matrix(matrix), m_outerStart(outerStart), m_outerSize(outerSize)
60     {
61       ei_assert( (outerStart>=0) && ((outerStart+outerSize)<=matrix.outerSize()) );
62     }
63
64     inline SparseInnerVectorSet(const MatrixType& matrix, int outer)
65       : m_matrix(matrix), m_outerStart(outer), m_outerSize(Size)
66     {
67       ei_assert(Size!=Dynamic);
68       ei_assert( (outer>=0) && (outer<matrix.outerSize()) );
69     }
70
71 //     template<typename OtherDerived>
72 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
73 //     {
74 //       return *this;
75 //     }
76
77 //     template<typename Sparse>
78 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
79 //     {
80 //       return *this;
81 //     }
82
83     EIGEN_STRONG_INLINE int rows() const { return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
84     EIGEN_STRONG_INLINE int cols() const { return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
85
86   protected:
87
88     const typename MatrixType::Nested m_matrix;
89     int m_outerStart;
90     const ei_int_if_dynamic<Size> m_outerSize;
91
92 };
93
94 /***************************************************************************
95 * specialisation for DynamicSparseMatrix
96 ***************************************************************************/
97
98 template<typename _Scalar, int _Options, int Size>
99 class SparseInnerVectorSet<DynamicSparseMatrix<_Scalar, _Options>, Size>
100   : public SparseMatrixBase<SparseInnerVectorSet<DynamicSparseMatrix<_Scalar, _Options>, Size> >
101 {
102     typedef DynamicSparseMatrix<_Scalar, _Options> MatrixType;
103     enum { IsRowMajor = ei_traits<SparseInnerVectorSet>::IsRowMajor };
104   public:
105
106     EIGEN_SPARSE_GENERIC_PUBLIC_INTERFACE(SparseInnerVectorSet)
107     class InnerIterator: public MatrixType::InnerIterator
108     {
109       public:
110         inline InnerIterator(const SparseInnerVectorSet& xpr, int outer)
111           : MatrixType::InnerIterator(xpr.m_matrix, xpr.m_outerStart + outer)
112         {}
113     };
114
115     inline SparseInnerVectorSet(const MatrixType& matrix, int outerStart, int outerSize)
116       : m_matrix(matrix), m_outerStart(outerStart), m_outerSize(outerSize)
117     {
118       ei_assert( (outerStart>=0) && ((outerStart+outerSize)<=matrix.outerSize()) );
119     }
120
121     inline SparseInnerVectorSet(const MatrixType& matrix, int outer)
122       : m_matrix(matrix), m_outerStart(outer), m_outerSize(Size)
123     {
124       ei_assert(Size!=Dynamic);
125       ei_assert( (outer>=0) && (outer<matrix.outerSize()) );
126     }
127
128     template<typename OtherDerived>
129     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
130     {
131       if (IsRowMajor != ((OtherDerived::Flags&RowMajorBit)==RowMajorBit))
132       {
133         // need to transpose => perform a block evaluation followed by a big swap
134         DynamicSparseMatrix<Scalar,IsRowMajor?RowMajorBit:0> aux(other);
135         *this = aux.markAsRValue();
136       }
137       else
138       {
139         // evaluate/copy vector per vector
140         for (int j=0; j<m_outerSize.value(); ++j)
141         {
142           SparseVector<Scalar,IsRowMajor ? RowMajorBit : 0> aux(other.innerVector(j));
143           m_matrix.const_cast_derived()._data()[m_outerStart+j].swap(aux._data());
144         }
145       }
146       return *this;
147     }
148
149     inline SparseInnerVectorSet& operator=(const SparseInnerVectorSet& other)
150     {
151       return operator=<SparseInnerVectorSet>(other);
152     }
153
154 //     template<typename Sparse>
155 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
156 //     {
157 //       return *this;
158 //     }
159
160     EIGEN_STRONG_INLINE int rows() const { return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
161     EIGEN_STRONG_INLINE int cols() const { return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
162
163   protected:
164
165     const typename MatrixType::Nested m_matrix;
166     int m_outerStart;
167     const ei_int_if_dynamic<Size> m_outerSize;
168
169 };
170
171
172 /***************************************************************************
173 * specialisation for SparseMatrix
174 ***************************************************************************/
175 /*
176 template<typename _Scalar, int _Options, int Size>
177 class SparseInnerVectorSet<SparseMatrix<_Scalar, _Options>, Size>
178   : public SparseMatrixBase<SparseInnerVectorSet<SparseMatrix<_Scalar, _Options>, Size> >
179 {
180     typedef DynamicSparseMatrix<_Scalar, _Options> MatrixType;
181     enum { IsRowMajor = ei_traits<SparseInnerVectorSet>::IsRowMajor };
182   public:
183
184     EIGEN_SPARSE_GENERIC_PUBLIC_INTERFACE(SparseInnerVectorSet)
185     class InnerIterator: public MatrixType::InnerIterator
186     {
187       public:
188         inline InnerIterator(const SparseInnerVectorSet& xpr, int outer)
189           : MatrixType::InnerIterator(xpr.m_matrix, xpr.m_outerStart + outer)
190         {}
191     };
192
193     inline SparseInnerVectorSet(const MatrixType& matrix, int outerStart, int outerSize)
194       : m_matrix(matrix), m_outerStart(outerStart), m_outerSize(outerSize)
195     {
196       ei_assert( (outerStart>=0) && ((outerStart+outerSize)<=matrix.outerSize()) );
197     }
198
199     inline SparseInnerVectorSet(const MatrixType& matrix, int outer)
200       : m_matrix(matrix), m_outerStart(outer)
201     {
202       ei_assert(Size==1);
203       ei_assert( (outer>=0) && (outer<matrix.outerSize()) );
204     }
205
206     template<typename OtherDerived>
207     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
208     {
209       if (IsRowMajor != ((OtherDerived::Flags&RowMajorBit)==RowMajorBit))
210       {
211         // need to transpose => perform a block evaluation followed by a big swap
212         DynamicSparseMatrix<Scalar,IsRowMajor?RowMajorBit:0> aux(other);
213         *this = aux.markAsRValue();
214       }
215       else
216       {
217         // evaluate/copy vector per vector
218         for (int j=0; j<m_outerSize.value(); ++j)
219         {
220           SparseVector<Scalar,IsRowMajor ? RowMajorBit : 0> aux(other.innerVector(j));
221           m_matrix.const_cast_derived()._data()[m_outerStart+j].swap(aux._data());
222         }
223       }
224       return *this;
225     }
226
227     inline SparseInnerVectorSet& operator=(const SparseInnerVectorSet& other)
228     {
229       return operator=<SparseInnerVectorSet>(other);
230     }
231
232     inline const Scalar* _valuePtr() const
233     { return m_matrix._valuePtr() + m_matrix._outerIndexPtr()[m_outerStart]; }
234     inline const int* _innerIndexPtr() const
235     { return m_matrix._innerIndexPtr() + m_matrix._outerIndexPtr()[m_outerStart]; }
236     inline const int* _outerIndexPtr() const { return m_matrix._outerIndexPtr() + m_outerStart; }
237
238 //     template<typename Sparse>
239 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
240 //     {
241 //       return *this;
242 //     }
243
244     EIGEN_STRONG_INLINE int rows() const { return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
245     EIGEN_STRONG_INLINE int cols() const { return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
246
247   protected:
248
249     const typename MatrixType::Nested m_matrix;
250     int m_outerStart;
251     const ei_int_if_dynamic<Size> m_outerSize;
252
253 };
254 */
255 //----------
256
257 /** \returns the i-th row of the matrix \c *this. For row-major matrix only. */
258 template<typename Derived>
259 SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::row(int i)
260 {
261   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
262   return innerVector(i);
263 }
264
265 /** \returns the i-th row of the matrix \c *this. For row-major matrix only.
266   * (read-only version) */
267 template<typename Derived>
268 const SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::row(int i) const
269 {
270   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
271   return innerVector(i);
272 }
273
274 /** \returns the i-th column of the matrix \c *this. For column-major matrix only. */
275 template<typename Derived>
276 SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::col(int i)
277 {
278   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
279   return innerVector(i);
280 }
281
282 /** \returns the i-th column of the matrix \c *this. For column-major matrix only.
283   * (read-only version) */
284 template<typename Derived>
285 const SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::col(int i) const
286 {
287   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
288   return innerVector(i);
289 }
290
291 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
292   * is col-major (resp. row-major).
293   */
294 template<typename Derived>
295 SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::innerVector(int outer)
296 { return SparseInnerVectorSet<Derived,1>(derived(), outer); }
297
298 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
299   * is col-major (resp. row-major). Read-only.
300   */
301 template<typename Derived>
302 const SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::innerVector(int outer) const
303 { return SparseInnerVectorSet<Derived,1>(derived(), outer); }
304
305 //----------
306
307 /** \returns the i-th row of the matrix \c *this. For row-major matrix only. */
308 template<typename Derived>
309 SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subrows(int start, int size)
310 {
311   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
312   return innerVectors(start, size);
313 }
314
315 /** \returns the i-th row of the matrix \c *this. For row-major matrix only.
316   * (read-only version) */
317 template<typename Derived>
318 const SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subrows(int start, int size) const
319 {
320   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
321   return innerVectors(start, size);
322 }
323
324 /** \returns the i-th column of the matrix \c *this. For column-major matrix only. */
325 template<typename Derived>
326 SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subcols(int start, int size)
327 {
328   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
329   return innerVectors(start, size);
330 }
331
332 /** \returns the i-th column of the matrix \c *this. For column-major matrix only.
333   * (read-only version) */
334 template<typename Derived>
335 const SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subcols(int start, int size) const
336 {
337   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
338   return innerVectors(start, size);
339 }
340
341 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
342   * is col-major (resp. row-major).
343   */
344 template<typename Derived>
345 SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::innerVectors(int outerStart, int outerSize)
346 { return SparseInnerVectorSet<Derived,Dynamic>(derived(), outerStart, outerSize); }
347
348 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
349   * is col-major (resp. row-major). Read-only.
350   */
351 template<typename Derived>
352 const SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::innerVectors(int outerStart, int outerSize) const
353 { return SparseInnerVectorSet<Derived,Dynamic>(derived(), outerStart, outerSize); }
354
355 # if 0
356 template<typename MatrixType, int BlockRows, int BlockCols, int PacketAccess>
357 class Block<MatrixType,BlockRows,BlockCols,PacketAccess,IsSparse>
358   : public SparseMatrixBase<Block<MatrixType,BlockRows,BlockCols,PacketAccess,IsSparse> >
359 {
360 public:
361
362     _EIGEN_GENERIC_PUBLIC_INTERFACE(Block, SparseMatrixBase<Block>)
363     class InnerIterator;
364
365     /** Column or Row constructor
366       */
367     inline Block(const MatrixType& matrix, int i)
368       : m_matrix(matrix),
369         // It is a row if and only if BlockRows==1 and BlockCols==MatrixType::ColsAtCompileTime,
370         // and it is a column if and only if BlockRows==MatrixType::RowsAtCompileTime and BlockCols==1,
371         // all other cases are invalid.
372         // The case a 1x1 matrix seems ambiguous, but the result is the same anyway.
373         m_startRow( (BlockRows==1) && (BlockCols==MatrixType::ColsAtCompileTime) ? i : 0),
374         m_startCol( (BlockRows==MatrixType::RowsAtCompileTime) && (BlockCols==1) ? i : 0),
375         m_blockRows(matrix.rows()), // if it is a row, then m_blockRows has a fixed-size of 1, so no pb to try to overwrite it
376         m_blockCols(matrix.cols())  // same for m_blockCols
377     {
378       ei_assert( (i>=0) && (
379           ((BlockRows==1) && (BlockCols==MatrixType::ColsAtCompileTime) && i<matrix.rows())
380         ||((BlockRows==MatrixType::RowsAtCompileTime) && (BlockCols==1) && i<matrix.cols())));
381     }
382
383     /** Fixed-size constructor
384       */
385     inline Block(const MatrixType& matrix, int startRow, int startCol)
386       : m_matrix(matrix), m_startRow(startRow), m_startCol(startCol),
387         m_blockRows(matrix.rows()), m_blockCols(matrix.cols())
388     {
389       EIGEN_STATIC_ASSERT(RowsAtCompileTime!=Dynamic && RowsAtCompileTime!=Dynamic,THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE)
390       ei_assert(startRow >= 0 && BlockRows >= 1 && startRow + BlockRows <= matrix.rows()
391           && startCol >= 0 && BlockCols >= 1 && startCol + BlockCols <= matrix.cols());
392     }
393
394     /** Dynamic-size constructor
395       */
396     inline Block(const MatrixType& matrix,
397           int startRow, int startCol,
398           int blockRows, int blockCols)
399       : m_matrix(matrix), m_startRow(startRow), m_startCol(startCol),
400                           m_blockRows(blockRows), m_blockCols(blockCols)
401     {
402       ei_assert((RowsAtCompileTime==Dynamic || RowsAtCompileTime==blockRows)
403           && (ColsAtCompileTime==Dynamic || ColsAtCompileTime==blockCols));
404       ei_assert(startRow >= 0 && blockRows >= 1 && startRow + blockRows <= matrix.rows()
405           && startCol >= 0 && blockCols >= 1 && startCol + blockCols <= matrix.cols());
406     }
407
408     inline int rows() const { return m_blockRows.value(); }
409     inline int cols() const { return m_blockCols.value(); }
410
411     inline int stride(void) const { return m_matrix.stride(); }
412
413     inline Scalar& coeffRef(int row, int col)
414     {
415       return m_matrix.const_cast_derived()
416                .coeffRef(row + m_startRow.value(), col + m_startCol.value());
417     }
418
419     inline const Scalar coeff(int row, int col) const
420     {
421       return m_matrix.coeff(row + m_startRow.value(), col + m_startCol.value());
422     }
423
424     inline Scalar& coeffRef(int index)
425     {
426       return m_matrix.const_cast_derived()
427              .coeffRef(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
428                        m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
429     }
430
431     inline const Scalar coeff(int index) const
432     {
433       return m_matrix
434              .coeff(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
435                     m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
436     }
437
438   protected:
439
440     const typename MatrixType::Nested m_matrix;
441     const ei_int_if_dynamic<MatrixType::RowsAtCompileTime == 1 ? 0 : Dynamic> m_startRow;
442     const ei_int_if_dynamic<MatrixType::ColsAtCompileTime == 1 ? 0 : Dynamic> m_startCol;
443     const ei_int_if_dynamic<RowsAtCompileTime> m_blockRows;
444     const ei_int_if_dynamic<ColsAtCompileTime> m_blockCols;
445
446 };
447 #endif
448
449 #endif // EIGEN_SPARSE_BLOCK_H