Another set of UI messages fixes and tweaks! No functional changes.
[blender.git] / extern / Eigen3 / Eigen / src / Core / util / ForwardDeclarations.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2007-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
5 // Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr>
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_FORWARDDECLARATIONS_H
27 #define EIGEN_FORWARDDECLARATIONS_H
28
29 namespace internal {
30
31 template<typename T> struct traits;
32
33 // here we say once and for all that traits<const T> == traits<T>
34 // When constness must affect traits, it has to be constness on template parameters on which T itself depends.
35 // For example, traits<Map<const T> > != traits<Map<T> >, but
36 //              traits<const Map<T> > == traits<Map<T> >
37 template<typename T> struct traits<const T> : traits<T> {};
38
39 template<typename Derived> struct has_direct_access
40 {
41   enum { ret = (traits<Derived>::Flags & DirectAccessBit) ? 1 : 0 };
42 };
43
44 template<typename Derived> struct accessors_level
45 {
46   enum { has_direct_access = (traits<Derived>::Flags & DirectAccessBit) ? 1 : 0,
47          has_write_access = (traits<Derived>::Flags & LvalueBit) ? 1 : 0,
48          value = has_direct_access ? (has_write_access ? DirectWriteAccessors : DirectAccessors)
49                                    : (has_write_access ? WriteAccessors       : ReadOnlyAccessors)
50   };
51 };
52
53 } // end namespace internal
54
55 template<typename T> struct NumTraits;
56
57 template<typename Derived> struct EigenBase;
58 template<typename Derived> class DenseBase;
59 template<typename Derived> class PlainObjectBase;
60
61
62 template<typename Derived,
63          int Level = internal::accessors_level<Derived>::value >
64 class DenseCoeffsBase;
65
66 template<typename _Scalar, int _Rows, int _Cols,
67          int _Options = AutoAlign |
68 #if defined(__GNUC__) && __GNUC__==3 && __GNUC_MINOR__==4
69     // workaround a bug in at least gcc 3.4.6
70     // the innermost ?: ternary operator is misparsed. We write it slightly
71     // differently and this makes gcc 3.4.6 happy, but it's ugly.
72     // The error would only show up with EIGEN_DEFAULT_TO_ROW_MAJOR is defined
73     // (when EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION is RowMajor)
74                           ( (_Rows==1 && _Cols!=1) ? RowMajor
75                           : !(_Cols==1 && _Rows!=1) ?  EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION
76                           : ColMajor ),
77 #else
78                           ( (_Rows==1 && _Cols!=1) ? RowMajor
79                           : (_Cols==1 && _Rows!=1) ? ColMajor
80                           : EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION ),
81 #endif
82          int _MaxRows = _Rows,
83          int _MaxCols = _Cols
84 > class Matrix;
85
86 template<typename Derived> class MatrixBase;
87 template<typename Derived> class ArrayBase;
88
89 template<typename ExpressionType, unsigned int Added, unsigned int Removed> class Flagged;
90 template<typename ExpressionType, template <typename> class StorageBase > class NoAlias;
91 template<typename ExpressionType> class NestByValue;
92 template<typename ExpressionType> class ForceAlignedAccess;
93 template<typename ExpressionType> class SwapWrapper;
94
95 template<typename XprType, int BlockRows=Dynamic, int BlockCols=Dynamic, bool InnerPanel = false,
96          bool HasDirectAccess = internal::has_direct_access<XprType>::ret> class Block;
97
98 template<typename MatrixType, int Size=Dynamic> class VectorBlock;
99 template<typename MatrixType> class Transpose;
100 template<typename MatrixType> class Conjugate;
101 template<typename NullaryOp, typename MatrixType>         class CwiseNullaryOp;
102 template<typename UnaryOp,   typename MatrixType>         class CwiseUnaryOp;
103 template<typename ViewOp,    typename MatrixType>         class CwiseUnaryView;
104 template<typename BinaryOp,  typename Lhs, typename Rhs>  class CwiseBinaryOp;
105 template<typename BinOp,     typename Lhs, typename Rhs>  class SelfCwiseBinaryOp;
106 template<typename Derived,   typename Lhs, typename Rhs>  class ProductBase;
107 template<typename Lhs, typename Rhs, int Mode>            class GeneralProduct;
108 template<typename Lhs, typename Rhs, int NestingFlags>    class CoeffBasedProduct;
109
110 template<typename Derived> class DiagonalBase;
111 template<typename _DiagonalVectorType> class DiagonalWrapper;
112 template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime=SizeAtCompileTime> class DiagonalMatrix;
113 template<typename MatrixType, typename DiagonalType, int ProductOrder> class DiagonalProduct;
114 template<typename MatrixType, int Index = 0> class Diagonal;
115 template<int SizeAtCompileTime, int MaxSizeAtCompileTime = SizeAtCompileTime, typename IndexType=int> class PermutationMatrix;
116 template<int SizeAtCompileTime, int MaxSizeAtCompileTime = SizeAtCompileTime, typename IndexType=int> class Transpositions;
117 template<typename Derived> class PermutationBase;
118 template<typename Derived> class TranspositionsBase;
119 template<typename _IndicesType> class PermutationWrapper;
120 template<typename _IndicesType> class TranspositionsWrapper;
121
122 template<typename Derived,
123          int Level = internal::accessors_level<Derived>::has_write_access ? WriteAccessors : ReadOnlyAccessors
124 > class MapBase;
125 template<int InnerStrideAtCompileTime, int OuterStrideAtCompileTime> class Stride;
126 template<typename MatrixType, int MapOptions=Unaligned, typename StrideType = Stride<0,0> > class Map;
127
128 template<typename Derived> class TriangularBase;
129 template<typename MatrixType, unsigned int Mode> class TriangularView;
130 template<typename MatrixType, unsigned int Mode> class SelfAdjointView;
131 template<typename MatrixType> class SparseView;
132 template<typename ExpressionType> class WithFormat;
133 template<typename MatrixType> struct CommaInitializer;
134 template<typename Derived> class ReturnByValue;
135 template<typename ExpressionType> class ArrayWrapper;
136
137 namespace internal {
138 template<typename DecompositionType, typename Rhs> struct solve_retval_base;
139 template<typename DecompositionType, typename Rhs> struct solve_retval;
140 template<typename DecompositionType> struct kernel_retval_base;
141 template<typename DecompositionType> struct kernel_retval;
142 template<typename DecompositionType> struct image_retval_base;
143 template<typename DecompositionType> struct image_retval;
144 } // end namespace internal
145
146 namespace internal {
147 template<typename _Scalar, int Rows=Dynamic, int Cols=Dynamic, int Supers=Dynamic, int Subs=Dynamic, int Options=0> class BandMatrix;
148 }
149
150 namespace internal {
151 template<typename Lhs, typename Rhs> struct product_type;
152 }
153
154 template<typename Lhs, typename Rhs,
155          int ProductType = internal::product_type<Lhs,Rhs>::value>
156 struct ProductReturnType;
157
158 // this is a workaround for sun CC
159 template<typename Lhs, typename Rhs> struct LazyProductReturnType;
160
161 namespace internal {
162
163 // Provides scalar/packet-wise product and product with accumulation
164 // with optional conjugation of the arguments.
165 template<typename LhsScalar, typename RhsScalar, bool ConjLhs=false, bool ConjRhs=false> struct conj_helper;
166
167 template<typename Scalar> struct scalar_sum_op;
168 template<typename Scalar> struct scalar_difference_op;
169 template<typename LhsScalar,typename RhsScalar> struct scalar_conj_product_op;
170 template<typename Scalar> struct scalar_quotient_op;
171 template<typename Scalar> struct scalar_opposite_op;
172 template<typename Scalar> struct scalar_conjugate_op;
173 template<typename Scalar> struct scalar_real_op;
174 template<typename Scalar> struct scalar_imag_op;
175 template<typename Scalar> struct scalar_abs_op;
176 template<typename Scalar> struct scalar_abs2_op;
177 template<typename Scalar> struct scalar_sqrt_op;
178 template<typename Scalar> struct scalar_exp_op;
179 template<typename Scalar> struct scalar_log_op;
180 template<typename Scalar> struct scalar_cos_op;
181 template<typename Scalar> struct scalar_sin_op;
182 template<typename Scalar> struct scalar_acos_op;
183 template<typename Scalar> struct scalar_asin_op;
184 template<typename Scalar> struct scalar_tan_op;
185 template<typename Scalar> struct scalar_pow_op;
186 template<typename Scalar> struct scalar_inverse_op;
187 template<typename Scalar> struct scalar_square_op;
188 template<typename Scalar> struct scalar_cube_op;
189 template<typename Scalar, typename NewType> struct scalar_cast_op;
190 template<typename Scalar> struct scalar_multiple_op;
191 template<typename Scalar> struct scalar_quotient1_op;
192 template<typename Scalar> struct scalar_min_op;
193 template<typename Scalar> struct scalar_max_op;
194 template<typename Scalar> struct scalar_random_op;
195 template<typename Scalar> struct scalar_add_op;
196 template<typename Scalar> struct scalar_constant_op;
197 template<typename Scalar> struct scalar_identity_op;
198
199 template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_product_op;
200 template<typename LhsScalar,typename RhsScalar> struct scalar_multiple2_op;
201
202 } // end namespace internal
203
204 struct IOFormat;
205
206 // Array module
207 template<typename _Scalar, int _Rows, int _Cols,
208          int _Options = AutoAlign |
209 #if defined(__GNUC__) && __GNUC__==3 && __GNUC_MINOR__==4
210     // workaround a bug in at least gcc 3.4.6
211     // the innermost ?: ternary operator is misparsed. We write it slightly
212     // differently and this makes gcc 3.4.6 happy, but it's ugly.
213     // The error would only show up with EIGEN_DEFAULT_TO_ROW_MAJOR is defined
214     // (when EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION is RowMajor)
215                           ( (_Rows==1 && _Cols!=1) ? RowMajor
216                           : !(_Cols==1 && _Rows!=1) ?  EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION
217                           : ColMajor ),
218 #else
219                           ( (_Rows==1 && _Cols!=1) ? RowMajor
220                           : (_Cols==1 && _Rows!=1) ? ColMajor
221                           : EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION ),
222 #endif
223          int _MaxRows = _Rows, int _MaxCols = _Cols> class Array;
224 template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType> class Select;
225 template<typename MatrixType, typename BinaryOp, int Direction> class PartialReduxExpr;
226 template<typename ExpressionType, int Direction> class VectorwiseOp;
227 template<typename MatrixType,int RowFactor,int ColFactor> class Replicate;
228 template<typename MatrixType, int Direction = BothDirections> class Reverse;
229
230 template<typename MatrixType> class FullPivLU;
231 template<typename MatrixType> class PartialPivLU;
232 namespace internal {
233 template<typename MatrixType> struct inverse_impl;
234 }
235 template<typename MatrixType> class HouseholderQR;
236 template<typename MatrixType> class ColPivHouseholderQR;
237 template<typename MatrixType> class FullPivHouseholderQR;
238 template<typename MatrixType, int QRPreconditioner = ColPivHouseholderQRPreconditioner> class JacobiSVD;
239 template<typename MatrixType, int UpLo = Lower> class LLT;
240 template<typename MatrixType, int UpLo = Lower> class LDLT;
241 template<typename VectorsType, typename CoeffsType, int Side=OnTheLeft> class HouseholderSequence;
242 template<typename Scalar>     class JacobiRotation;
243
244 // Geometry module:
245 template<typename Derived, int _Dim> class RotationBase;
246 template<typename Lhs, typename Rhs> class Cross;
247 template<typename Derived> class QuaternionBase;
248 template<typename Scalar> class Rotation2D;
249 template<typename Scalar> class AngleAxis;
250 template<typename Scalar,int Dim> class Translation;
251
252 #ifdef EIGEN2_SUPPORT
253 template<typename Derived, int _Dim> class eigen2_RotationBase;
254 template<typename Lhs, typename Rhs> class eigen2_Cross;
255 template<typename Scalar> class eigen2_Quaternion;
256 template<typename Scalar> class eigen2_Rotation2D;
257 template<typename Scalar> class eigen2_AngleAxis;
258 template<typename Scalar,int Dim> class eigen2_Transform;
259 template <typename _Scalar, int _AmbientDim> class eigen2_ParametrizedLine;
260 template <typename _Scalar, int _AmbientDim> class eigen2_Hyperplane;
261 template<typename Scalar,int Dim> class eigen2_Translation;
262 template<typename Scalar,int Dim> class eigen2_Scaling;
263 #endif
264
265 #if EIGEN2_SUPPORT_STAGE < STAGE20_RESOLVE_API_CONFLICTS
266 template<typename Scalar> class Quaternion;
267 template<typename Scalar,int Dim> class Transform;
268 template <typename _Scalar, int _AmbientDim> class ParametrizedLine;
269 template <typename _Scalar, int _AmbientDim> class Hyperplane;
270 template<typename Scalar,int Dim> class Scaling;
271 #endif
272
273 #if EIGEN2_SUPPORT_STAGE > STAGE20_RESOLVE_API_CONFLICTS
274 template<typename Scalar, int Options = AutoAlign> class Quaternion;
275 template<typename Scalar,int Dim,int Mode,int _Options=AutoAlign> class Transform;
276 template <typename _Scalar, int _AmbientDim, int Options=AutoAlign> class ParametrizedLine;
277 template <typename _Scalar, int _AmbientDim, int Options=AutoAlign> class Hyperplane;
278 template<typename Scalar> class UniformScaling;
279 template<typename MatrixType,int Direction> class Homogeneous;
280 #endif
281
282 // MatrixFunctions module
283 template<typename Derived> struct MatrixExponentialReturnValue;
284 template<typename Derived> class MatrixFunctionReturnValue;
285
286 namespace internal {
287 template <typename Scalar>
288 struct stem_function
289 {
290   typedef std::complex<typename NumTraits<Scalar>::Real> ComplexScalar;
291   typedef ComplexScalar type(ComplexScalar, int);
292 };
293 }
294
295
296 #ifdef EIGEN2_SUPPORT
297 template<typename ExpressionType> class Cwise;
298 template<typename MatrixType> class Minor;
299 template<typename MatrixType> class LU;
300 template<typename MatrixType> class QR;
301 template<typename MatrixType> class SVD;
302 namespace internal {
303 template<typename MatrixType, unsigned int Mode> struct eigen2_part_return_type;
304 }
305 #endif
306
307 #endif // EIGEN_FORWARDDECLARATIONS_H