Another set of UI messages fixes and tweaks! No functional changes.
[blender.git] / extern / Eigen3 / Eigen / src / Core / Block.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5 // Copyright (C) 2006-2010 Benoit Jacob <jacob.benoit.1@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_BLOCK_H
27 #define EIGEN_BLOCK_H
28
29 /** \class Block
30   * \ingroup Core_Module
31   *
32   * \brief Expression of a fixed-size or dynamic-size block
33   *
34   * \param XprType the type of the expression in which we are taking a block
35   * \param BlockRows the number of rows of the block we are taking at compile time (optional)
36   * \param BlockCols the number of columns of the block we are taking at compile time (optional)
37   * \param _DirectAccessStatus \internal used for partial specialization
38   *
39   * This class represents an expression of either a fixed-size or dynamic-size block. It is the return
40   * type of DenseBase::block(Index,Index,Index,Index) and DenseBase::block<int,int>(Index,Index) and
41   * most of the time this is the only way it is used.
42   *
43   * However, if you want to directly maniputate block expressions,
44   * for instance if you want to write a function returning such an expression, you
45   * will need to use this class.
46   *
47   * Here is an example illustrating the dynamic case:
48   * \include class_Block.cpp
49   * Output: \verbinclude class_Block.out
50   *
51   * \note Even though this expression has dynamic size, in the case where \a XprType
52   * has fixed size, this expression inherits a fixed maximal size which means that evaluating
53   * it does not cause a dynamic memory allocation.
54   *
55   * Here is an example illustrating the fixed-size case:
56   * \include class_FixedBlock.cpp
57   * Output: \verbinclude class_FixedBlock.out
58   *
59   * \sa DenseBase::block(Index,Index,Index,Index), DenseBase::block(Index,Index), class VectorBlock
60   */
61
62 namespace internal {
63 template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel, bool HasDirectAccess>
64 struct traits<Block<XprType, BlockRows, BlockCols, InnerPanel, HasDirectAccess> > : traits<XprType>
65 {
66   typedef typename traits<XprType>::Scalar Scalar;
67   typedef typename traits<XprType>::StorageKind StorageKind;
68   typedef typename traits<XprType>::XprKind XprKind;
69   typedef typename nested<XprType>::type XprTypeNested;
70   typedef typename remove_reference<XprTypeNested>::type _XprTypeNested;
71   enum{
72     MatrixRows = traits<XprType>::RowsAtCompileTime,
73     MatrixCols = traits<XprType>::ColsAtCompileTime,
74     RowsAtCompileTime = MatrixRows == 0 ? 0 : BlockRows,
75     ColsAtCompileTime = MatrixCols == 0 ? 0 : BlockCols,
76     MaxRowsAtCompileTime = BlockRows==0 ? 0
77                          : RowsAtCompileTime != Dynamic ? int(RowsAtCompileTime)
78                          : int(traits<XprType>::MaxRowsAtCompileTime),
79     MaxColsAtCompileTime = BlockCols==0 ? 0
80                          : ColsAtCompileTime != Dynamic ? int(ColsAtCompileTime)
81                          : int(traits<XprType>::MaxColsAtCompileTime),
82     XprTypeIsRowMajor = (int(traits<XprType>::Flags)&RowMajorBit) != 0,
83     IsRowMajor = (MaxRowsAtCompileTime==1&&MaxColsAtCompileTime!=1) ? 1
84                : (MaxColsAtCompileTime==1&&MaxRowsAtCompileTime!=1) ? 0
85                : XprTypeIsRowMajor,
86     HasSameStorageOrderAsXprType = (IsRowMajor == XprTypeIsRowMajor),
87     InnerSize = IsRowMajor ? int(ColsAtCompileTime) : int(RowsAtCompileTime),
88     InnerStrideAtCompileTime = HasSameStorageOrderAsXprType
89                              ? int(inner_stride_at_compile_time<XprType>::ret)
90                              : int(outer_stride_at_compile_time<XprType>::ret),
91     OuterStrideAtCompileTime = HasSameStorageOrderAsXprType
92                              ? int(outer_stride_at_compile_time<XprType>::ret)
93                              : int(inner_stride_at_compile_time<XprType>::ret),
94     MaskPacketAccessBit = (InnerSize == Dynamic || (InnerSize % packet_traits<Scalar>::size) == 0)
95                        && (InnerStrideAtCompileTime == 1)
96                         ? PacketAccessBit : 0,
97     MaskAlignedBit = (InnerPanel && (OuterStrideAtCompileTime!=Dynamic) && ((OuterStrideAtCompileTime % packet_traits<Scalar>::size) == 0)) ? AlignedBit : 0,
98     FlagsLinearAccessBit = (RowsAtCompileTime == 1 || ColsAtCompileTime == 1) ? LinearAccessBit : 0,
99     FlagsLvalueBit = is_lvalue<XprType>::value ? LvalueBit : 0,
100     FlagsRowMajorBit = IsRowMajor ? RowMajorBit : 0,
101     Flags0 = traits<XprType>::Flags & ( (HereditaryBits & ~RowMajorBit) |
102                                         DirectAccessBit |
103                                         MaskPacketAccessBit |
104                                         MaskAlignedBit),
105     Flags = Flags0 | FlagsLinearAccessBit | FlagsLvalueBit | FlagsRowMajorBit
106   };
107 };
108 }
109
110 template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel, bool HasDirectAccess> class Block
111   : public internal::dense_xpr_base<Block<XprType, BlockRows, BlockCols, InnerPanel, HasDirectAccess> >::type
112 {
113   public:
114
115     typedef typename internal::dense_xpr_base<Block>::type Base;
116     EIGEN_DENSE_PUBLIC_INTERFACE(Block)
117
118     class InnerIterator;
119
120     /** Column or Row constructor
121       */
122     inline Block(XprType& xpr, Index i)
123       : m_xpr(xpr),
124         // It is a row if and only if BlockRows==1 and BlockCols==XprType::ColsAtCompileTime,
125         // and it is a column if and only if BlockRows==XprType::RowsAtCompileTime and BlockCols==1,
126         // all other cases are invalid.
127         // The case a 1x1 matrix seems ambiguous, but the result is the same anyway.
128         m_startRow( (BlockRows==1) && (BlockCols==XprType::ColsAtCompileTime) ? i : 0),
129         m_startCol( (BlockRows==XprType::RowsAtCompileTime) && (BlockCols==1) ? i : 0),
130         m_blockRows(BlockRows==1 ? 1 : xpr.rows()),
131         m_blockCols(BlockCols==1 ? 1 : xpr.cols())
132     {
133       eigen_assert( (i>=0) && (
134           ((BlockRows==1) && (BlockCols==XprType::ColsAtCompileTime) && i<xpr.rows())
135         ||((BlockRows==XprType::RowsAtCompileTime) && (BlockCols==1) && i<xpr.cols())));
136     }
137
138     /** Fixed-size constructor
139       */
140     inline Block(XprType& xpr, Index startRow, Index startCol)
141       : m_xpr(xpr), m_startRow(startRow), m_startCol(startCol),
142         m_blockRows(BlockRows), m_blockCols(BlockCols)
143     {
144       EIGEN_STATIC_ASSERT(RowsAtCompileTime!=Dynamic && ColsAtCompileTime!=Dynamic,THIS_METHOD_IS_ONLY_FOR_FIXED_SIZE)
145       eigen_assert(startRow >= 0 && BlockRows >= 1 && startRow + BlockRows <= xpr.rows()
146              && startCol >= 0 && BlockCols >= 1 && startCol + BlockCols <= xpr.cols());
147     }
148
149     /** Dynamic-size constructor
150       */
151     inline Block(XprType& xpr,
152           Index startRow, Index startCol,
153           Index blockRows, Index blockCols)
154       : m_xpr(xpr), m_startRow(startRow), m_startCol(startCol),
155                           m_blockRows(blockRows), m_blockCols(blockCols)
156     {
157       eigen_assert((RowsAtCompileTime==Dynamic || RowsAtCompileTime==blockRows)
158           && (ColsAtCompileTime==Dynamic || ColsAtCompileTime==blockCols));
159       eigen_assert(startRow >= 0 && blockRows >= 0 && startRow + blockRows <= xpr.rows()
160           && startCol >= 0 && blockCols >= 0 && startCol + blockCols <= xpr.cols());
161     }
162
163     EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Block)
164
165     inline Index rows() const { return m_blockRows.value(); }
166     inline Index cols() const { return m_blockCols.value(); }
167
168     inline Scalar& coeffRef(Index row, Index col)
169     {
170       EIGEN_STATIC_ASSERT_LVALUE(XprType)
171       return m_xpr.const_cast_derived()
172                .coeffRef(row + m_startRow.value(), col + m_startCol.value());
173     }
174
175     inline const Scalar& coeffRef(Index row, Index col) const
176     {
177       return m_xpr.derived()
178                .coeffRef(row + m_startRow.value(), col + m_startCol.value());
179     }
180
181     EIGEN_STRONG_INLINE const CoeffReturnType coeff(Index row, Index col) const
182     {
183       return m_xpr.coeff(row + m_startRow.value(), col + m_startCol.value());
184     }
185
186     inline Scalar& coeffRef(Index index)
187     {
188       EIGEN_STATIC_ASSERT_LVALUE(XprType)
189       return m_xpr.const_cast_derived()
190              .coeffRef(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
191                        m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
192     }
193
194     inline const Scalar& coeffRef(Index index) const
195     {
196       return m_xpr.const_cast_derived()
197              .coeffRef(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
198                        m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
199     }
200
201     inline const CoeffReturnType coeff(Index index) const
202     {
203       return m_xpr
204              .coeff(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
205                     m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
206     }
207
208     template<int LoadMode>
209     inline PacketScalar packet(Index row, Index col) const
210     {
211       return m_xpr.template packet<Unaligned>
212               (row + m_startRow.value(), col + m_startCol.value());
213     }
214
215     template<int LoadMode>
216     inline void writePacket(Index row, Index col, const PacketScalar& x)
217     {
218       m_xpr.const_cast_derived().template writePacket<Unaligned>
219               (row + m_startRow.value(), col + m_startCol.value(), x);
220     }
221
222     template<int LoadMode>
223     inline PacketScalar packet(Index index) const
224     {
225       return m_xpr.template packet<Unaligned>
226               (m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
227                m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
228     }
229
230     template<int LoadMode>
231     inline void writePacket(Index index, const PacketScalar& x)
232     {
233       m_xpr.const_cast_derived().template writePacket<Unaligned>
234          (m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
235           m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0), x);
236     }
237
238     #ifdef EIGEN_PARSED_BY_DOXYGEN
239     /** \sa MapBase::data() */
240     inline const Scalar* data() const;
241     inline Index innerStride() const;
242     inline Index outerStride() const;
243     #endif
244
245   protected:
246
247     const typename XprType::Nested m_xpr;
248     const internal::variable_if_dynamic<Index, XprType::RowsAtCompileTime == 1 ? 0 : Dynamic> m_startRow;
249     const internal::variable_if_dynamic<Index, XprType::ColsAtCompileTime == 1 ? 0 : Dynamic> m_startCol;
250     const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_blockRows;
251     const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_blockCols;
252 };
253
254 /** \internal */
255 template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel>
256 class Block<XprType,BlockRows,BlockCols, InnerPanel,true>
257   : public MapBase<Block<XprType, BlockRows, BlockCols, InnerPanel, true> >
258 {
259   public:
260
261     typedef MapBase<Block> Base;
262     EIGEN_DENSE_PUBLIC_INTERFACE(Block)
263
264     EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Block)
265
266     /** Column or Row constructor
267       */
268     inline Block(XprType& xpr, Index i)
269       : Base(internal::const_cast_ptr(&xpr.coeffRef(
270               (BlockRows==1) && (BlockCols==XprType::ColsAtCompileTime) ? i : 0,
271               (BlockRows==XprType::RowsAtCompileTime) && (BlockCols==1) ? i : 0)),
272              BlockRows==1 ? 1 : xpr.rows(),
273              BlockCols==1 ? 1 : xpr.cols()),
274         m_xpr(xpr)
275     {
276       eigen_assert( (i>=0) && (
277           ((BlockRows==1) && (BlockCols==XprType::ColsAtCompileTime) && i<xpr.rows())
278         ||((BlockRows==XprType::RowsAtCompileTime) && (BlockCols==1) && i<xpr.cols())));
279       init();
280     }
281
282     /** Fixed-size constructor
283       */
284     inline Block(XprType& xpr, Index startRow, Index startCol)
285       : Base(internal::const_cast_ptr(&xpr.coeffRef(startRow,startCol))), m_xpr(xpr)
286     {
287       eigen_assert(startRow >= 0 && BlockRows >= 1 && startRow + BlockRows <= xpr.rows()
288              && startCol >= 0 && BlockCols >= 1 && startCol + BlockCols <= xpr.cols());
289       init();
290     }
291
292     /** Dynamic-size constructor
293       */
294     inline Block(XprType& xpr,
295           Index startRow, Index startCol,
296           Index blockRows, Index blockCols)
297       : Base(internal::const_cast_ptr(&xpr.coeffRef(startRow,startCol)), blockRows, blockCols),
298         m_xpr(xpr)
299     {
300       eigen_assert((RowsAtCompileTime==Dynamic || RowsAtCompileTime==blockRows)
301              && (ColsAtCompileTime==Dynamic || ColsAtCompileTime==blockCols));
302       eigen_assert(startRow >= 0 && blockRows >= 0 && startRow + blockRows <= xpr.rows()
303              && startCol >= 0 && blockCols >= 0 && startCol + blockCols <= xpr.cols());
304       init();
305     }
306
307     /** \sa MapBase::innerStride() */
308     inline Index innerStride() const
309     {
310       return internal::traits<Block>::HasSameStorageOrderAsXprType
311              ? m_xpr.innerStride()
312              : m_xpr.outerStride();
313     }
314
315     /** \sa MapBase::outerStride() */
316     inline Index outerStride() const
317     {
318       return m_outerStride;
319     }
320
321   #ifndef __SUNPRO_CC
322   // FIXME sunstudio is not friendly with the above friend...
323   // META-FIXME there is no 'friend' keyword around here. Is this obsolete?
324   protected:
325   #endif
326
327     #ifndef EIGEN_PARSED_BY_DOXYGEN
328     /** \internal used by allowAligned() */
329     inline Block(XprType& xpr, const Scalar* data, Index blockRows, Index blockCols)
330       : Base(data, blockRows, blockCols), m_xpr(xpr)
331     {
332       init();
333     }
334     #endif
335
336   protected:
337     void init()
338     {
339       m_outerStride = internal::traits<Block>::HasSameStorageOrderAsXprType
340                     ? m_xpr.outerStride()
341                     : m_xpr.innerStride();
342     }
343
344     const typename XprType::Nested m_xpr;
345     int m_outerStride;
346 };
347
348
349 #endif // EIGEN_BLOCK_H