11 #ifndef EIGEN_MATRIXBASE_H
12 #define EIGEN_MATRIXBASE_H
52 #ifndef EIGEN_PARSED_BY_DOXYGEN
54 typedef typename internal::traits<Derived>::StorageKind StorageKind;
55 typedef typename internal::traits<Derived>::Index
Index;
56 typedef typename internal::traits<Derived>::Scalar Scalar;
57 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
61 using Base::RowsAtCompileTime;
62 using Base::ColsAtCompileTime;
63 using Base::SizeAtCompileTime;
64 using Base::MaxRowsAtCompileTime;
65 using Base::MaxColsAtCompileTime;
66 using Base::MaxSizeAtCompileTime;
67 using Base::IsVectorAtCompileTime;
69 using Base::CoeffReadCost;
72 using Base::const_cast_derived;
78 using Base::lazyAssign;
80 using Base::operator+=;
81 using Base::operator-=;
82 using Base::operator*=;
83 using Base::operator/=;
85 typedef typename Base::CoeffReturnType CoeffReturnType;
87 typedef typename Base::RowXpr RowXpr;
88 typedef typename Base::ColXpr ColXpr;
89 #endif // not EIGEN_PARSED_BY_DOXYGEN
93 #ifndef EIGEN_PARSED_BY_DOXYGEN
97 #endif // not EIGEN_PARSED_BY_DOXYGEN
110 internal::traits<Derived>::RowsAtCompileTime,
111 internal::traits<Derived>::ColsAtCompileTime,
113 internal::traits<Derived>::MaxRowsAtCompileTime,
114 internal::traits<Derived>::MaxColsAtCompileTime
117 #ifndef EIGEN_PARSED_BY_DOXYGEN
121 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
124 >::type AdjointReturnType;
131 internal::traits<Derived>::RowsAtCompileTime,
132 internal::traits<Derived>::ColsAtCompileTime> BasisReturnType;
133 #endif // not EIGEN_PARSED_BY_DOXYGEN
135 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::MatrixBase
136 # include "../plugins/CommonCwiseUnaryOps.h"
137 # include "../plugins/CommonCwiseBinaryOps.h"
138 # include "../plugins/MatrixCwiseUnaryOps.h"
139 # include "../plugins/MatrixCwiseBinaryOps.h"
140 # ifdef EIGEN_MATRIXBASE_PLUGIN
141 # include EIGEN_MATRIXBASE_PLUGIN
143 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS
153 template <
typename OtherDerived>
156 template <
typename OtherDerived>
159 template<
typename OtherDerived>
160 Derived&
operator=(
const ReturnByValue<OtherDerived>& other);
162 #ifndef EIGEN_PARSED_BY_DOXYGEN
163 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
164 Derived& lazyAssign(
const ProductBase<ProductDerived, Lhs,Rhs>& other);
165 #endif // not EIGEN_PARSED_BY_DOXYGEN
167 template<
typename OtherDerived>
169 template<
typename OtherDerived>
172 template<
typename OtherDerived>
176 template<
typename OtherDerived>
180 template<
typename OtherDerived>
183 template<
typename OtherDerived>
186 template<
typename OtherDerived>
189 template<
typename DiagonalDerived>
190 const DiagonalProduct<Derived, DiagonalDerived, OnTheRight>
193 template<
typename OtherDerived>
194 typename internal::scalar_product_traits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType
197 #ifdef EIGEN2_SUPPORT
198 template<
typename OtherDerived>
203 RealScalar
norm()
const;
210 const AdjointReturnType
adjoint()
const;
221 template<
int Index>
typename DiagonalIndexReturnType<Index>::Type
diagonal();
222 template<
int Index>
typename ConstDiagonalIndexReturnType<Index>::Type
diagonal()
const;
226 #if (defined _MSC_VER) && (_MSC_VER >= 1500) // 2008 or later
227 typename MatrixBase::template DiagonalIndexReturnType<Dynamic>::Type
diagonal(
Index index);
228 typename MatrixBase::template ConstDiagonalIndexReturnType<Dynamic>::Type
diagonal(
Index index)
const;
230 typename DiagonalIndexReturnType<Dynamic>::Type
diagonal(
Index index);
231 typename ConstDiagonalIndexReturnType<Dynamic>::Type
diagonal(
Index index)
const;
234 #ifdef EIGEN2_SUPPORT
235 template<
unsigned int Mode>
typename internal::eigen2_part_return_type<Derived, Mode>::type part();
236 template<
unsigned int Mode>
const typename internal::eigen2_part_return_type<Derived, Mode>::type part()
const;
240 template<
template<
typename T,
int N>
class U>
241 const DiagonalWrapper<ConstDiagonalReturnType> part()
const
243 #endif // EIGEN2_SUPPORT
245 template<
unsigned int Mode>
struct TriangularViewReturnType {
typedef TriangularView<Derived, Mode> Type; };
246 template<
unsigned int Mode>
struct ConstTriangularViewReturnType {
typedef const TriangularView<const Derived, Mode> Type; };
248 template<
unsigned int Mode>
typename TriangularViewReturnType<Mode>::Type triangularView();
249 template<
unsigned int Mode>
typename ConstTriangularViewReturnType<Mode>::Type triangularView()
const;
251 template<
unsigned int UpLo>
struct SelfAdjointViewReturnType {
typedef SelfAdjointView<Derived, UpLo> Type; };
252 template<
unsigned int UpLo>
struct ConstSelfAdjointViewReturnType {
typedef const SelfAdjointView<const Derived, UpLo> Type; };
254 template<
unsigned int UpLo>
typename SelfAdjointViewReturnType<UpLo>::Type selfadjointView();
255 template<
unsigned int UpLo>
typename ConstSelfAdjointViewReturnType<UpLo>::Type selfadjointView()
const;
257 const SparseView<Derived> sparseView(
const Scalar& m_reference = Scalar(0),
258 typename NumTraits<Scalar>::Real m_epsilon = NumTraits<Scalar>::dummy_precision())
const;
259 static const IdentityReturnType
Identity();
262 static const BasisReturnType
Unit(
Index i);
263 static const BasisReturnType
UnitX();
264 static const BasisReturnType
UnitY();
265 static const BasisReturnType
UnitZ();
266 static const BasisReturnType
UnitW();
268 const DiagonalWrapper<const Derived>
asDiagonal()
const;
269 const PermutationWrapper<const Derived> asPermutation()
const;
274 bool isIdentity(RealScalar prec = NumTraits<Scalar>::dummy_precision())
const;
275 bool isDiagonal(RealScalar prec = NumTraits<Scalar>::dummy_precision())
const;
277 bool isUpperTriangular(RealScalar prec = NumTraits<Scalar>::dummy_precision())
const;
278 bool isLowerTriangular(RealScalar prec = NumTraits<Scalar>::dummy_precision())
const;
280 template<
typename OtherDerived>
281 bool isOrthogonal(
const MatrixBase<OtherDerived>& other,
282 RealScalar prec = NumTraits<Scalar>::dummy_precision())
const;
283 bool isUnitary(RealScalar prec = NumTraits<Scalar>::dummy_precision())
const;
289 template<
typename OtherDerived>
297 template<
typename OtherDerived>
305 template<
bool Enable>
inline typename internal::add_const_on_value_type<typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type>::type
forceAlignedAccessIf()
const;
306 template<
bool Enable>
inline typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type
forceAlignedAccessIf();
308 Scalar
trace()
const;
312 template<
int p> RealScalar lpNorm()
const;
315 const MatrixBase<Derived>& matrix()
const {
return *
this; }
324 const FullPivLU<PlainObject>
fullPivLu()
const;
327 #if EIGEN2_SUPPORT_STAGE < STAGE20_RESOLVE_API_CONFLICTS
328 const LU<PlainObject>
lu()
const;
331 #ifdef EIGEN2_SUPPORT
332 const LU<PlainObject> eigen2_lu()
const;
335 #if EIGEN2_SUPPORT_STAGE > STAGE20_RESOLVE_API_CONFLICTS
336 const PartialPivLU<PlainObject>
lu()
const;
339 #ifdef EIGEN2_SUPPORT
340 template<
typename ResultType>
341 void computeInverse(MatrixBase<ResultType> *result)
const {
346 const internal::inverse_impl<Derived>
inverse()
const;
347 template<
typename ResultType>
352 const RealScalar& absDeterminantThreshold = NumTraits<Scalar>::dummy_precision()
354 template<
typename ResultType>
358 const RealScalar& absDeterminantThreshold = NumTraits<Scalar>::dummy_precision()
364 const LLT<PlainObject>
llt()
const;
365 const LDLT<PlainObject>
ldlt()
const;
373 #ifdef EIGEN2_SUPPORT
374 const QR<PlainObject> qr()
const;
382 JacobiSVD<PlainObject>
jacobiSvd(
unsigned int computationOptions = 0)
const;
384 #ifdef EIGEN2_SUPPORT
385 SVD<PlainObject> svd()
const;
390 #ifndef EIGEN_PARSED_BY_DOXYGEN
392 template<
typename OtherDerived>
struct cross_product_return_type {
393 typedef typename internal::scalar_product_traits<typename internal::traits<Derived>::Scalar,
typename internal::traits<OtherDerived>::Scalar>::ReturnType Scalar;
394 typedef Matrix<Scalar,MatrixBase::RowsAtCompileTime,MatrixBase::ColsAtCompileTime> type;
396 #endif // EIGEN_PARSED_BY_DOXYGEN
397 template<
typename OtherDerived>
398 typename cross_product_return_type<OtherDerived>::type
399 cross(
const MatrixBase<OtherDerived>& other)
const;
400 template<
typename OtherDerived>
401 PlainObject cross3(
const MatrixBase<OtherDerived>& other)
const;
405 #if EIGEN2_SUPPORT_STAGE > STAGE20_RESOLVE_API_CONFLICTS
406 ScalarMultipleReturnType
operator*(
const UniformScaling<Scalar>& s)
const;
409 typedef Homogeneous<Derived, HomogeneousReturnTypeDirection> HomogeneousReturnType;
416 typedef Block<
const Derived,
417 internal::traits<Derived>::ColsAtCompileTime==1 ? SizeMinusOne : 1,
418 internal::traits<Derived>::ColsAtCompileTime==1 ? 1 : SizeMinusOne> ConstStartMinusOne;
419 typedef CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>,
420 const ConstStartMinusOne > HNormalizedReturnType;
427 template<
typename EssentialPart>
429 Scalar& tau, RealScalar& beta)
const;
430 template<
typename EssentialPart>
434 template<
typename EssentialPart>
441 template<
typename OtherScalar>
443 template<
typename OtherScalar>
448 typedef typename internal::stem_function<Scalar>::type StemFunction;
449 const MatrixExponentialReturnValue<Derived> exp()
const;
450 const MatrixFunctionReturnValue<Derived> matrixFunction(StemFunction f)
const;
451 const MatrixFunctionReturnValue<Derived> cosh()
const;
452 const MatrixFunctionReturnValue<Derived> sinh()
const;
453 const MatrixFunctionReturnValue<Derived> cos()
const;
454 const MatrixFunctionReturnValue<Derived> sin()
const;
455 const MatrixSquareRootReturnValue<Derived> sqrt()
const;
456 const MatrixLogarithmReturnValue<Derived> log()
const;
458 #ifdef EIGEN2_SUPPORT
459 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
460 Derived&
operator+=(
const Flagged<ProductBase<ProductDerived, Lhs,Rhs>, 0,
463 template<
typename ProductDerived,
typename Lhs,
typename Rhs>
464 Derived&
operator-=(
const Flagged<ProductBase<ProductDerived, Lhs,Rhs>, 0,
469 template<
typename OtherDerived>
470 Derived& lazyAssign(
const Flagged<OtherDerived, 0, EvalBeforeAssigningBit>& other)
471 {
return lazyAssign(other._expression()); }
473 template<
unsigned int Added>
474 const Flagged<Derived, Added, 0> marked()
const;
475 const Flagged<Derived, 0, EvalBeforeAssigningBit> lazy()
const;
477 inline const Cwise<Derived> cwise()
const;
478 inline Cwise<Derived> cwise();
480 VectorBlock<Derived> start(
Index size);
481 const VectorBlock<const Derived> start(
Index size)
const;
482 VectorBlock<Derived> end(
Index size);
483 const VectorBlock<const Derived> end(
Index size)
const;
484 template<
int Size> VectorBlock<Derived,Size> start();
485 template<
int Size>
const VectorBlock<const Derived,Size> start()
const;
486 template<
int Size> VectorBlock<Derived,Size> end();
487 template<
int Size>
const VectorBlock<const Derived,Size> end()
const;
494 MatrixBase() : Base() {}
497 explicit MatrixBase(
int);
499 template<
typename OtherDerived>
explicit MatrixBase(
const MatrixBase<OtherDerived>&);
502 template<
typename OtherDerived> Derived&
operator+=(
const ArrayBase<OtherDerived>& )
503 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
505 template<
typename OtherDerived> Derived&
operator-=(
const ArrayBase<OtherDerived>& )
506 {EIGEN_STATIC_ASSERT(std::ptrdiff_t(
sizeof(
typename OtherDerived::Scalar))==-1,YOU_CANNOT_MIX_ARRAYS_AND_MATRICES);
return *
this;}
511 #endif // EIGEN_MATRIXBASE_H