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