Cycles: svn merge -r41225:41232 ^/trunk/blender
[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       private:
58         InnerIterator& operator=(const InnerIterator&);
59     };
60
61     inline SparseInnerVectorSet(const MatrixType& matrix, int outerStart, int outerSize)
62       : m_matrix(matrix), m_outerStart(outerStart), m_outerSize(outerSize)
63     {
64       ei_assert( (outerStart>=0) && ((outerStart+outerSize)<=matrix.outerSize()) );
65     }
66
67     inline SparseInnerVectorSet(const MatrixType& matrix, int outer)
68       : m_matrix(matrix), m_outerStart(outer), m_outerSize(Size)
69     {
70       ei_assert(Size!=Dynamic);
71       ei_assert( (outer>=0) && (outer<matrix.outerSize()) );
72     }
73
74 //     template<typename OtherDerived>
75 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
76 //     {
77 //       return *this;
78 //     }
79
80 //     template<typename Sparse>
81 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
82 //     {
83 //       return *this;
84 //     }
85
86     EIGEN_STRONG_INLINE int rows() const { return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
87     EIGEN_STRONG_INLINE int cols() const { return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
88
89   protected:
90
91     const typename MatrixType::Nested m_matrix;
92     int m_outerStart;
93     const ei_int_if_dynamic<Size> m_outerSize;
94
95 };
96
97 /***************************************************************************
98 * specialisation for DynamicSparseMatrix
99 ***************************************************************************/
100
101 template<typename _Scalar, int _Options, int Size>
102 class SparseInnerVectorSet<DynamicSparseMatrix<_Scalar, _Options>, Size>
103   : public SparseMatrixBase<SparseInnerVectorSet<DynamicSparseMatrix<_Scalar, _Options>, Size> >
104 {
105     typedef DynamicSparseMatrix<_Scalar, _Options> MatrixType;
106     enum { IsRowMajor = ei_traits<SparseInnerVectorSet>::IsRowMajor };
107   public:
108
109     EIGEN_SPARSE_GENERIC_PUBLIC_INTERFACE(SparseInnerVectorSet)
110     class InnerIterator: public MatrixType::InnerIterator
111     {
112       public:
113         inline InnerIterator(const SparseInnerVectorSet& xpr, int outer)
114           : MatrixType::InnerIterator(xpr.m_matrix, xpr.m_outerStart + outer)
115         {}
116       private:
117         InnerIterator& operator=(const InnerIterator&);
118     };
119
120     inline SparseInnerVectorSet(const MatrixType& matrix, int outerStart, int outerSize)
121       : m_matrix(matrix), m_outerStart(outerStart), m_outerSize(outerSize)
122     {
123       ei_assert( (outerStart>=0) && ((outerStart+outerSize)<=matrix.outerSize()) );
124     }
125
126     inline SparseInnerVectorSet(const MatrixType& matrix, int outer)
127       : m_matrix(matrix), m_outerStart(outer), m_outerSize(Size)
128     {
129       ei_assert(Size!=Dynamic);
130       ei_assert( (outer>=0) && (outer<matrix.outerSize()) );
131     }
132
133     template<typename OtherDerived>
134     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
135     {
136       if (IsRowMajor != ((OtherDerived::Flags&RowMajorBit)==RowMajorBit))
137       {
138         // need to transpose => perform a block evaluation followed by a big swap
139         DynamicSparseMatrix<Scalar,IsRowMajor?RowMajorBit:0> aux(other);
140         *this = aux.markAsRValue();
141       }
142       else
143       {
144         // evaluate/copy vector per vector
145         for (int j=0; j<m_outerSize.value(); ++j)
146         {
147           SparseVector<Scalar,IsRowMajor ? RowMajorBit : 0> aux(other.innerVector(j));
148           m_matrix.const_cast_derived()._data()[m_outerStart+j].swap(aux._data());
149         }
150       }
151       return *this;
152     }
153
154     inline SparseInnerVectorSet& operator=(const SparseInnerVectorSet& other)
155     {
156       return operator=<SparseInnerVectorSet>(other);
157     }
158
159 //     template<typename Sparse>
160 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
161 //     {
162 //       return *this;
163 //     }
164
165     EIGEN_STRONG_INLINE int rows() const { return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
166     EIGEN_STRONG_INLINE int cols() const { return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
167
168   protected:
169
170     const typename MatrixType::Nested m_matrix;
171     int m_outerStart;
172     const ei_int_if_dynamic<Size> m_outerSize;
173
174 };
175
176
177 /***************************************************************************
178 * specialisation for SparseMatrix
179 ***************************************************************************/
180 /*
181 template<typename _Scalar, int _Options, int Size>
182 class SparseInnerVectorSet<SparseMatrix<_Scalar, _Options>, Size>
183   : public SparseMatrixBase<SparseInnerVectorSet<SparseMatrix<_Scalar, _Options>, Size> >
184 {
185     typedef DynamicSparseMatrix<_Scalar, _Options> MatrixType;
186     enum { IsRowMajor = ei_traits<SparseInnerVectorSet>::IsRowMajor };
187   public:
188
189     EIGEN_SPARSE_GENERIC_PUBLIC_INTERFACE(SparseInnerVectorSet)
190     class InnerIterator: public MatrixType::InnerIterator
191     {
192       public:
193         inline InnerIterator(const SparseInnerVectorSet& xpr, int outer)
194           : MatrixType::InnerIterator(xpr.m_matrix, xpr.m_outerStart + outer)
195         {}
196     };
197
198     inline SparseInnerVectorSet(const MatrixType& matrix, int outerStart, int outerSize)
199       : m_matrix(matrix), m_outerStart(outerStart), m_outerSize(outerSize)
200     {
201       ei_assert( (outerStart>=0) && ((outerStart+outerSize)<=matrix.outerSize()) );
202     }
203
204     inline SparseInnerVectorSet(const MatrixType& matrix, int outer)
205       : m_matrix(matrix), m_outerStart(outer)
206     {
207       ei_assert(Size==1);
208       ei_assert( (outer>=0) && (outer<matrix.outerSize()) );
209     }
210
211     template<typename OtherDerived>
212     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
213     {
214       if (IsRowMajor != ((OtherDerived::Flags&RowMajorBit)==RowMajorBit))
215       {
216         // need to transpose => perform a block evaluation followed by a big swap
217         DynamicSparseMatrix<Scalar,IsRowMajor?RowMajorBit:0> aux(other);
218         *this = aux.markAsRValue();
219       }
220       else
221       {
222         // evaluate/copy vector per vector
223         for (int j=0; j<m_outerSize.value(); ++j)
224         {
225           SparseVector<Scalar,IsRowMajor ? RowMajorBit : 0> aux(other.innerVector(j));
226           m_matrix.const_cast_derived()._data()[m_outerStart+j].swap(aux._data());
227         }
228       }
229       return *this;
230     }
231
232     inline SparseInnerVectorSet& operator=(const SparseInnerVectorSet& other)
233     {
234       return operator=<SparseInnerVectorSet>(other);
235     }
236
237     inline const Scalar* _valuePtr() const
238     { return m_matrix._valuePtr() + m_matrix._outerIndexPtr()[m_outerStart]; }
239     inline const int* _innerIndexPtr() const
240     { return m_matrix._innerIndexPtr() + m_matrix._outerIndexPtr()[m_outerStart]; }
241     inline const int* _outerIndexPtr() const { return m_matrix._outerIndexPtr() + m_outerStart; }
242
243 //     template<typename Sparse>
244 //     inline SparseInnerVectorSet& operator=(const SparseMatrixBase<OtherDerived>& other)
245 //     {
246 //       return *this;
247 //     }
248
249     EIGEN_STRONG_INLINE int rows() const { return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
250     EIGEN_STRONG_INLINE int cols() const { return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
251
252   protected:
253
254     const typename MatrixType::Nested m_matrix;
255     int m_outerStart;
256     const ei_int_if_dynamic<Size> m_outerSize;
257
258 };
259 */
260 //----------
261
262 /** \returns the i-th row of the matrix \c *this. For row-major matrix only. */
263 template<typename Derived>
264 SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::row(int i)
265 {
266   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
267   return innerVector(i);
268 }
269
270 /** \returns the i-th row of the matrix \c *this. For row-major matrix only.
271   * (read-only version) */
272 template<typename Derived>
273 const SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::row(int i) const
274 {
275   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
276   return innerVector(i);
277 }
278
279 /** \returns the i-th column of the matrix \c *this. For column-major matrix only. */
280 template<typename Derived>
281 SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::col(int i)
282 {
283   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
284   return innerVector(i);
285 }
286
287 /** \returns the i-th column of the matrix \c *this. For column-major matrix only.
288   * (read-only version) */
289 template<typename Derived>
290 const SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::col(int i) const
291 {
292   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
293   return innerVector(i);
294 }
295
296 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
297   * is col-major (resp. row-major).
298   */
299 template<typename Derived>
300 SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::innerVector(int outer)
301 { return SparseInnerVectorSet<Derived,1>(derived(), outer); }
302
303 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
304   * is col-major (resp. row-major). Read-only.
305   */
306 template<typename Derived>
307 const SparseInnerVectorSet<Derived,1> SparseMatrixBase<Derived>::innerVector(int outer) const
308 { return SparseInnerVectorSet<Derived,1>(derived(), outer); }
309
310 //----------
311
312 /** \returns the i-th row of the matrix \c *this. For row-major matrix only. */
313 template<typename Derived>
314 SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subrows(int start, int size)
315 {
316   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
317   return innerVectors(start, size);
318 }
319
320 /** \returns the i-th row of the matrix \c *this. For row-major matrix only.
321   * (read-only version) */
322 template<typename Derived>
323 const SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subrows(int start, int size) const
324 {
325   EIGEN_STATIC_ASSERT(IsRowMajor,THIS_METHOD_IS_ONLY_FOR_ROW_MAJOR_MATRICES);
326   return innerVectors(start, size);
327 }
328
329 /** \returns the i-th column of the matrix \c *this. For column-major matrix only. */
330 template<typename Derived>
331 SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subcols(int start, int size)
332 {
333   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
334   return innerVectors(start, size);
335 }
336
337 /** \returns the i-th column of the matrix \c *this. For column-major matrix only.
338   * (read-only version) */
339 template<typename Derived>
340 const SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::subcols(int start, int size) const
341 {
342   EIGEN_STATIC_ASSERT(!IsRowMajor,THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
343   return innerVectors(start, size);
344 }
345
346 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
347   * is col-major (resp. row-major).
348   */
349 template<typename Derived>
350 SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::innerVectors(int outerStart, int outerSize)
351 { return SparseInnerVectorSet<Derived,Dynamic>(derived(), outerStart, outerSize); }
352
353 /** \returns the \a outer -th column (resp. row) of the matrix \c *this if \c *this
354   * is col-major (resp. row-major). Read-only.
355   */
356 template<typename Derived>
357 const SparseInnerVectorSet<Derived,Dynamic> SparseMatrixBase<Derived>::innerVectors(int outerStart, int outerSize) const
358 { return SparseInnerVectorSet<Derived,Dynamic>(derived(), outerStart, outerSize); }
359
360 # if 0
361 template<typename MatrixType, int BlockRows, int BlockCols, int PacketAccess>
362 class Block<MatrixType,BlockRows,BlockCols,PacketAccess,IsSparse>
363   : public SparseMatrixBase<Block<MatrixType,BlockRows,BlockCols,PacketAccess,IsSparse> >
364 {
365 public:
366
367     _EIGEN_GENERIC_PUBLIC_INTERFACE(Block, SparseMatrixBase<Block>)
368     class InnerIterator;
369
370     /** Column or Row constructor
371       */
372     inline Block(const MatrixType& matrix, int i)
373       : m_matrix(matrix),
374         // It is a row if and only if BlockRows==1 and BlockCols==MatrixType::ColsAtCompileTime,
375         // and it is a column if and only if BlockRows==MatrixType::RowsAtCompileTime and BlockCols==1,
376         // all other cases are invalid.
377         // The case a 1x1 matrix seems ambiguous, but the result is the same anyway.
378         m_startRow( (BlockRows==1) && (BlockCols==MatrixType::ColsAtCompileTime) ? i : 0),
379         m_startCol( (BlockRows==MatrixType::RowsAtCompileTime) && (BlockCols==1) ? i : 0),
380         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
381         m_blockCols(matrix.cols())  // same for m_blockCols
382     {
383       ei_assert( (i>=0) && (
384           ((BlockRows==1) && (BlockCols==MatrixType::ColsAtCompileTime) && i<matrix.rows())
385         ||((BlockRows==MatrixType::RowsAtCompileTime) && (BlockCols==1) && i<matrix.cols())));
386     }
387
388     /** Fixed-size constructor
389       */
390     inline Block(const MatrixType& matrix, int startRow, int startCol)
391       : m_matrix(matrix), m_startRow(startRow), m_startCol(startCol),
392         m_blockRows(matrix.rows()), m_blockCols(matrix.cols())
393     {
394       EIGEN_STATIC_ASSERT(RowsAtCompileTime!=Dynamic && RowsAtCompileTime!=Dynamic,THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE)
395       ei_assert(startRow >= 0 && BlockRows >= 1 && startRow + BlockRows <= matrix.rows()
396           && startCol >= 0 && BlockCols >= 1 && startCol + BlockCols <= matrix.cols());
397     }
398
399     /** Dynamic-size constructor
400       */
401     inline Block(const MatrixType& matrix,
402           int startRow, int startCol,
403           int blockRows, int blockCols)
404       : m_matrix(matrix), m_startRow(startRow), m_startCol(startCol),
405                           m_blockRows(blockRows), m_blockCols(blockCols)
406     {
407       ei_assert((RowsAtCompileTime==Dynamic || RowsAtCompileTime==blockRows)
408           && (ColsAtCompileTime==Dynamic || ColsAtCompileTime==blockCols));
409       ei_assert(startRow >= 0 && blockRows >= 1 && startRow + blockRows <= matrix.rows()
410           && startCol >= 0 && blockCols >= 1 && startCol + blockCols <= matrix.cols());
411     }
412
413     inline int rows() const { return m_blockRows.value(); }
414     inline int cols() const { return m_blockCols.value(); }
415
416     inline int stride(void) const { return m_matrix.stride(); }
417
418     inline Scalar& coeffRef(int row, int col)
419     {
420       return m_matrix.const_cast_derived()
421                .coeffRef(row + m_startRow.value(), col + m_startCol.value());
422     }
423
424     inline const Scalar coeff(int row, int col) const
425     {
426       return m_matrix.coeff(row + m_startRow.value(), col + m_startCol.value());
427     }
428
429     inline Scalar& coeffRef(int index)
430     {
431       return m_matrix.const_cast_derived()
432              .coeffRef(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
433                        m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
434     }
435
436     inline const Scalar coeff(int index) const
437     {
438       return m_matrix
439              .coeff(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
440                     m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
441     }
442
443   protected:
444
445     const typename MatrixType::Nested m_matrix;
446     const ei_int_if_dynamic<MatrixType::RowsAtCompileTime == 1 ? 0 : Dynamic> m_startRow;
447     const ei_int_if_dynamic<MatrixType::ColsAtCompileTime == 1 ? 0 : Dynamic> m_startCol;
448     const ei_int_if_dynamic<RowsAtCompileTime> m_blockRows;
449     const ei_int_if_dynamic<ColsAtCompileTime> m_blockCols;
450
451 };
452 #endif
453
454 #endif // EIGEN_SPARSE_BLOCK_H