Eigen  3.4.1 (git rev 28ded8800c26864e537852658428ab44c8399e87)
 
Loading...
Searching...
No Matches
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
39template<typename T> struct evaluator_traits;
40
41template< typename T> struct evaluator;
42
43} // end namespace internal
44
45template<typename T> struct NumTraits;
46
47template<typename Derived> struct EigenBase;
48template<typename Derived> class DenseBase;
49template<typename Derived> class PlainObjectBase;
50template<typename Derived, int Level> class DenseCoeffsBase;
51
52template<typename _Scalar, int _Rows, int _Cols,
53 int _Options = AutoAlign |
54#if EIGEN_GNUC_AT(3,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) ? Eigen::RowMajor
61 : !(_Cols==1 && _Rows!=1) ? EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION
62 : Eigen::ColMajor ),
63#else
64 ( (_Rows==1 && _Cols!=1) ? Eigen::RowMajor
65 : (_Cols==1 && _Rows!=1) ? Eigen::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> class Block;
82template<typename XprType, typename RowIndices, typename ColIndices> class IndexedView;
83template<typename XprType, int Rows=Dynamic, int Cols=Dynamic, int Order=0> class Reshaped;
84
85template<typename MatrixType, int Size=Dynamic> class VectorBlock;
86template<typename MatrixType> class Transpose;
87template<typename MatrixType> class Conjugate;
88template<typename NullaryOp, typename MatrixType> class CwiseNullaryOp;
89template<typename UnaryOp, typename MatrixType> class CwiseUnaryOp;
90template<typename ViewOp, typename MatrixType> class CwiseUnaryView;
91template<typename BinaryOp, typename Lhs, typename Rhs> class CwiseBinaryOp;
92template<typename TernaryOp, typename Arg1, typename Arg2, typename Arg3> class CwiseTernaryOp;
93template<typename Decomposition, typename Rhstype> class Solve;
94template<typename XprType> class Inverse;
95
96template<typename Lhs, typename Rhs, int Option = DefaultProduct> class Product;
97
98template<typename Derived> class DiagonalBase;
99template<typename _DiagonalVectorType> class DiagonalWrapper;
100template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime=SizeAtCompileTime> class DiagonalMatrix;
101template<typename MatrixType, typename DiagonalType, int ProductOrder> class DiagonalProduct;
102template<typename MatrixType, int Index = 0> class Diagonal;
103template<int SizeAtCompileTime, int MaxSizeAtCompileTime = SizeAtCompileTime, typename IndexType=int> class PermutationMatrix;
104template<int SizeAtCompileTime, int MaxSizeAtCompileTime = SizeAtCompileTime, typename IndexType=int> class Transpositions;
105template<typename Derived> class PermutationBase;
106template<typename Derived> class TranspositionsBase;
107template<typename _IndicesType> class PermutationWrapper;
108template<typename _IndicesType> class TranspositionsWrapper;
109
110template<typename Derived,
111 int Level = internal::accessors_level<Derived>::has_write_access ? WriteAccessors : ReadOnlyAccessors
112> class MapBase;
113template<int OuterStrideAtCompileTime, int InnerStrideAtCompileTime> class Stride;
114template<int Value = Dynamic> class InnerStride;
115template<int Value = Dynamic> class OuterStride;
116template<typename MatrixType, int MapOptions=Unaligned, typename StrideType = Stride<0,0> > class Map;
117template<typename Derived> class RefBase;
118template<typename PlainObjectType, int Options = 0,
119 typename StrideType = typename internal::conditional<PlainObjectType::IsVectorAtCompileTime,InnerStride<1>,OuterStride<> >::type > class Ref;
120
121template<typename Derived> class TriangularBase;
122template<typename MatrixType, unsigned int Mode> class TriangularView;
123template<typename MatrixType, unsigned int Mode> class SelfAdjointView;
124template<typename MatrixType> class SparseView;
125template<typename ExpressionType> class WithFormat;
126template<typename MatrixType> struct CommaInitializer;
127template<typename Derived> class ReturnByValue;
128template<typename ExpressionType> class ArrayWrapper;
129template<typename ExpressionType> class MatrixWrapper;
130template<typename Derived> class SolverBase;
131template<typename XprType> class InnerIterator;
132
133namespace internal {
134template<typename XprType> class generic_randaccess_stl_iterator;
135template<typename XprType> class pointer_based_stl_iterator;
136template<typename XprType, DirectionType Direction> class subvector_stl_iterator;
137template<typename XprType, DirectionType Direction> class subvector_stl_reverse_iterator;
138template<typename DecompositionType> struct kernel_retval_base;
139template<typename DecompositionType> struct kernel_retval;
140template<typename DecompositionType> struct image_retval_base;
141template<typename DecompositionType> struct image_retval;
142} // end namespace internal
143
144namespace internal {
145template<typename _Scalar, int Rows=Dynamic, int Cols=Dynamic, int Supers=Dynamic, int Subs=Dynamic, int Options=0> class BandMatrix;
146}
147
148namespace internal {
149template<typename Lhs, typename Rhs> struct product_type;
150
151template<bool> struct EnableIf;
152
158template< typename T,
159 int ProductTag = internal::product_type<typename T::Lhs,typename T::Rhs>::ret,
160 typename LhsShape = typename evaluator_traits<typename T::Lhs>::Shape,
161 typename RhsShape = typename evaluator_traits<typename T::Rhs>::Shape,
162 typename LhsScalar = typename traits<typename T::Lhs>::Scalar,
163 typename RhsScalar = typename traits<typename T::Rhs>::Scalar
164 > struct product_evaluator;
165}
166
167template<typename Lhs, typename Rhs,
168 int ProductType = internal::product_type<Lhs,Rhs>::value>
169struct ProductReturnType;
170
171// this is a workaround for sun CC
172template<typename Lhs, typename Rhs> struct LazyProductReturnType;
173
174namespace internal {
175
176// Provides scalar/packet-wise product and product with accumulation
177// with optional conjugation of the arguments.
178template<typename LhsScalar, typename RhsScalar, bool ConjLhs=false, bool ConjRhs=false> struct conj_helper;
179
180template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_sum_op;
181template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_difference_op;
182template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_conj_product_op;
183template<typename LhsScalar,typename RhsScalar=LhsScalar, int NaNPropagation=PropagateFast> struct scalar_min_op;
184template<typename LhsScalar,typename RhsScalar=LhsScalar, int NaNPropagation=PropagateFast> struct scalar_max_op;
185template<typename Scalar> struct scalar_opposite_op;
186template<typename Scalar> struct scalar_conjugate_op;
187template<typename Scalar> struct scalar_real_op;
188template<typename Scalar> struct scalar_imag_op;
189template<typename Scalar> struct scalar_abs_op;
190template<typename Scalar> struct scalar_abs2_op;
191template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_absolute_difference_op;
192template<typename Scalar> struct scalar_sqrt_op;
193template<typename Scalar> struct scalar_rsqrt_op;
194template<typename Scalar> struct scalar_exp_op;
195template<typename Scalar> struct scalar_log_op;
196template<typename Scalar> struct scalar_cos_op;
197template<typename Scalar> struct scalar_sin_op;
198template<typename Scalar> struct scalar_acos_op;
199template<typename Scalar> struct scalar_asin_op;
200template<typename Scalar> struct scalar_tan_op;
201template<typename Scalar> struct scalar_inverse_op;
202template<typename Scalar> struct scalar_square_op;
203template<typename Scalar> struct scalar_cube_op;
204template<typename Scalar, typename NewType> struct scalar_cast_op;
205template<typename Scalar> struct scalar_random_op;
206template<typename Scalar> struct scalar_constant_op;
207template<typename Scalar> struct scalar_identity_op;
208template<typename Scalar,bool is_complex, bool is_integer> struct scalar_sign_op;
209template<typename Scalar,typename ScalarExponent> struct scalar_pow_op;
210template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_hypot_op;
211template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_product_op;
212template<typename LhsScalar,typename RhsScalar=LhsScalar> struct scalar_quotient_op;
213
214// SpecialFunctions module
215template<typename Scalar> struct scalar_lgamma_op;
216template<typename Scalar> struct scalar_digamma_op;
217template<typename Scalar> struct scalar_erf_op;
218template<typename Scalar> struct scalar_erfc_op;
219template<typename Scalar> struct scalar_ndtri_op;
220template<typename Scalar> struct scalar_igamma_op;
221template<typename Scalar> struct scalar_igammac_op;
222template<typename Scalar> struct scalar_zeta_op;
223template<typename Scalar> struct scalar_betainc_op;
224
225// Bessel functions in SpecialFunctions module
226template<typename Scalar> struct scalar_bessel_i0_op;
227template<typename Scalar> struct scalar_bessel_i0e_op;
228template<typename Scalar> struct scalar_bessel_i1_op;
229template<typename Scalar> struct scalar_bessel_i1e_op;
230template<typename Scalar> struct scalar_bessel_j0_op;
231template<typename Scalar> struct scalar_bessel_y0_op;
232template<typename Scalar> struct scalar_bessel_j1_op;
233template<typename Scalar> struct scalar_bessel_y1_op;
234template<typename Scalar> struct scalar_bessel_k0_op;
235template<typename Scalar> struct scalar_bessel_k0e_op;
236template<typename Scalar> struct scalar_bessel_k1_op;
237template<typename Scalar> struct scalar_bessel_k1e_op;
238
239
240} // end namespace internal
241
242struct IOFormat;
243
244// Array module
245template<typename _Scalar, int _Rows, int _Cols,
246 int _Options = AutoAlign |
247#if EIGEN_GNUC_AT(3,4)
248 // workaround a bug in at least gcc 3.4.6
249 // the innermost ?: ternary operator is misparsed. We write it slightly
250 // differently and this makes gcc 3.4.6 happy, but it's ugly.
251 // The error would only show up with EIGEN_DEFAULT_TO_ROW_MAJOR is defined
252 // (when EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION is RowMajor)
253 ( (_Rows==1 && _Cols!=1) ? Eigen::RowMajor
254 : !(_Cols==1 && _Rows!=1) ? EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION
255 : Eigen::ColMajor ),
256#else
257 ( (_Rows==1 && _Cols!=1) ? Eigen::RowMajor
258 : (_Cols==1 && _Rows!=1) ? Eigen::ColMajor
259 : EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION ),
260#endif
261 int _MaxRows = _Rows, int _MaxCols = _Cols> class Array;
262template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType> class Select;
263template<typename MatrixType, typename BinaryOp, int Direction> class PartialReduxExpr;
264template<typename ExpressionType, int Direction> class VectorwiseOp;
265template<typename MatrixType,int RowFactor,int ColFactor> class Replicate;
266template<typename MatrixType, int Direction = BothDirections> class Reverse;
267
268template<typename MatrixType> class FullPivLU;
269template<typename MatrixType> class PartialPivLU;
270namespace internal {
271template<typename MatrixType> struct inverse_impl;
272}
273template<typename MatrixType> class HouseholderQR;
274template<typename MatrixType> class ColPivHouseholderQR;
275template<typename MatrixType> class FullPivHouseholderQR;
276template<typename MatrixType> class CompleteOrthogonalDecomposition;
277template<typename MatrixType> class SVDBase;
278template<typename MatrixType, int QRPreconditioner = ColPivHouseholderQRPreconditioner> class JacobiSVD;
279template<typename MatrixType> class BDCSVD;
280template<typename MatrixType, int UpLo = Lower> class LLT;
281template<typename MatrixType, int UpLo = Lower> class LDLT;
282template<typename VectorsType, typename CoeffsType, int Side=OnTheLeft> class HouseholderSequence;
283template<typename Scalar> class JacobiRotation;
284
285// Geometry module:
286template<typename Derived, int _Dim> class RotationBase;
287template<typename Lhs, typename Rhs> class Cross;
288template<typename Derived> class QuaternionBase;
289template<typename Scalar> class Rotation2D;
290template<typename Scalar> class AngleAxis;
291template<typename Scalar,int Dim> class Translation;
292template<typename Scalar,int Dim> class AlignedBox;
293template<typename Scalar, int Options = AutoAlign> class Quaternion;
294template<typename Scalar,int Dim,int Mode,int _Options=AutoAlign> class Transform;
295template <typename _Scalar, int _AmbientDim, int Options=AutoAlign> class ParametrizedLine;
296template <typename _Scalar, int _AmbientDim, int Options=AutoAlign> class Hyperplane;
297template<typename Scalar> class UniformScaling;
298template<typename MatrixType,int Direction> class Homogeneous;
299
300// Sparse module:
301template<typename Derived> class SparseMatrixBase;
302
303// MatrixFunctions module
304template<typename Derived> struct MatrixExponentialReturnValue;
305template<typename Derived> class MatrixFunctionReturnValue;
306template<typename Derived> class MatrixSquareRootReturnValue;
307template<typename Derived> class MatrixLogarithmReturnValue;
308template<typename Derived> class MatrixPowerReturnValue;
309template<typename Derived> class MatrixComplexPowerReturnValue;
310
311namespace internal {
312template <typename Scalar>
313struct stem_function
314{
315 typedef std::complex<typename NumTraits<Scalar>::Real> ComplexScalar;
316 typedef ComplexScalar type(ComplexScalar, int);
317};
318}
319
320} // end namespace Eigen
321
322#endif // EIGEN_FORWARDDECLARATIONS_H
Eigen::DirectAccessors
@ DirectAccessors
Definition Constants.h:380
Eigen::ReadOnlyAccessors
@ ReadOnlyAccessors
Definition Constants.h:376
Eigen::WriteAccessors
@ WriteAccessors
Definition Constants.h:378
Eigen::DirectWriteAccessors
@ DirectWriteAccessors
Definition Constants.h:382
Eigen::ColMajor
@ ColMajor
Definition Constants.h:319
Eigen::RowMajor
@ RowMajor
Definition Constants.h:321
Eigen::AutoAlign
@ AutoAlign
Definition Constants.h:323
Eigen::DirectAccessBit
const unsigned int DirectAccessBit
Definition Constants.h:155
Eigen::LvalueBit
const unsigned int LvalueBit
Definition Constants.h:144
Eigen
Namespace containing all symbols from the Eigen library.
Definition B01_Experimental.dox:1