11 #ifndef EIGEN_DENSEBASE_H
12 #define EIGEN_DENSEBASE_H
20 static inline void check_DenseIndex_is_signed() {
21 EIGEN_STATIC_ASSERT(NumTraits<DenseIndex>::IsSigned,THE_INDEX_TYPE_MUST_BE_A_SIGNED_TYPE);
42 #ifndef EIGEN_PARSED_BY_DOXYGEN
43 :
public internal::special_scalar_op_base<Derived,typename internal::traits<Derived>::Scalar,
44 typename NumTraits<typename internal::traits<Derived>::Scalar>::Real>
46 :
public DenseCoeffsBase<Derived>
47 #endif // not EIGEN_PARSED_BY_DOXYGEN
50 using internal::special_scalar_op_base<Derived,typename internal::traits<Derived>::Scalar,
55 typedef typename internal::traits<Derived>::StorageKind StorageKind;
61 typedef typename internal::traits<Derived>::Index
Index;
63 typedef typename internal::traits<Derived>::Scalar Scalar;
64 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
67 typedef DenseCoeffsBase<Derived> Base;
69 using Base::const_cast_derived;
73 using Base::rowIndexByOuterInner;
74 using Base::colIndexByOuterInner;
76 using Base::coeffByOuterInner;
78 using Base::packetByOuterInner;
79 using Base::writePacket;
80 using Base::writePacketByOuterInner;
82 using Base::coeffRefByOuterInner;
83 using Base::copyCoeff;
84 using Base::copyCoeffByOuterInner;
85 using Base::copyPacket;
86 using Base::copyPacketByOuterInner;
87 using Base::operator();
88 using Base::operator[];
94 using Base::innerStride;
95 using Base::outerStride;
96 using Base::rowStride;
97 using Base::colStride;
98 typedef typename Base::CoeffReturnType CoeffReturnType;
115 SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
116 internal::traits<Derived>::ColsAtCompileTime>::ret),
144 internal::traits<Derived>::MaxColsAtCompileTime>::ret),
156 || internal::traits<Derived>::MaxColsAtCompileTime == 1,
162 Flags = internal::traits<Derived>::Flags,
177 InnerStrideAtCompileTime =
internal::inner_stride_at_compile_time<Derived>::ret,
178 OuterStrideAtCompileTime =
internal::outer_stride_at_compile_time<Derived>::ret
181 enum { ThisConstantIsPrivateInPlainObjectBase };
199 : int(
IsRowMajor) ? this->rows() : this->cols();
210 : int(
IsRowMajor) ? this->cols() : this->rows();
219 EIGEN_ONLY_USED_FOR_DEBUG(newSize);
220 eigen_assert(newSize == this->size()
221 &&
"DenseBase::resize() does not actually allow to resize.");
229 EIGEN_ONLY_USED_FOR_DEBUG(nbRows);
230 EIGEN_ONLY_USED_FOR_DEBUG(nbCols);
231 eigen_assert(nbRows == this->rows() && nbCols == this->cols()
232 &&
"DenseBase::resize() does not actually allow to resize.");
235 #ifndef EIGEN_PARSED_BY_DOXYGEN
246 #endif // not EIGEN_PARSED_BY_DOXYGEN
249 template<
typename OtherDerived>
257 template<
typename OtherDerived>
260 template<
typename OtherDerived>
263 template<
typename OtherDerived>
266 template<
typename OtherDerived>
267 Derived&
operator=(
const ReturnByValue<OtherDerived>& func);
270 template<
typename OtherDerived>
274 template<
typename OtherDerived>
275 Derived& lazyAssign(
const ReturnByValue<OtherDerived>& other);
279 template<
unsigned int Added,
unsigned int Removed>
280 const Flagged<Derived, Added, Removed>
flagged()
const;
282 template<
typename OtherDerived>
287 ConstTransposeReturnType
transpose()
const;
289 #ifndef EIGEN_NO_DEBUG
291 template<
typename OtherDerived>
292 void checkTransposeAliasing(
const OtherDerived& other)
const;
297 static const ConstantReturnType
299 static const ConstantReturnType
301 static const ConstantReturnType
304 static const SequentialLinSpacedReturnType
305 LinSpaced(Sequential_t, Index size,
const Scalar& low,
const Scalar& high);
306 static const RandomAccessLinSpacedReturnType
307 LinSpaced(Index size,
const Scalar& low,
const Scalar& high);
308 static const SequentialLinSpacedReturnType
309 LinSpaced(Sequential_t,
const Scalar& low,
const Scalar& high);
310 static const RandomAccessLinSpacedReturnType
311 LinSpaced(
const Scalar& low,
const Scalar& high);
313 template<
typename CustomNullaryOp>
315 NullaryExpr(Index rows, Index cols,
const CustomNullaryOp& func);
316 template<
typename CustomNullaryOp>
318 NullaryExpr(Index size,
const CustomNullaryOp& func);
319 template<
typename CustomNullaryOp>
323 static const ConstantReturnType
Zero(Index rows, Index cols);
324 static const ConstantReturnType
Zero(Index size);
325 static const ConstantReturnType
Zero();
326 static const ConstantReturnType
Ones(Index rows, Index cols);
327 static const ConstantReturnType
Ones(Index size);
328 static const ConstantReturnType
Ones();
332 Derived&
setLinSpaced(Index size,
const Scalar& low,
const Scalar& high);
333 Derived&
setLinSpaced(
const Scalar& low,
const Scalar& high);
338 template<
typename OtherDerived>
341 bool isMuchSmallerThan(
const RealScalar& other,
343 template<
typename OtherDerived>
352 inline bool hasNaN()
const;
355 inline Derived& operator*=(
const Scalar& other);
356 inline Derived& operator/=(
const Scalar& other);
358 typedef typename internal::add_const_on_value_type<typename internal::eval<Derived>::type>::type EvalReturnType;
364 EIGEN_STRONG_INLINE EvalReturnType
eval()
const
369 return typename internal::eval<Derived>::type(derived());
375 template<
typename OtherDerived>
377 int = OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
379 SwapWrapper<Derived>(derived()).lazyAssign(other.derived());
385 template<
typename OtherDerived>
388 SwapWrapper<Derived>(derived()).lazyAssign(other.derived());
395 template<
bool Enable>
inline const typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf()
const;
396 template<
bool Enable>
inline typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf();
400 Scalar trace()
const;
404 typename internal::traits<Derived>::Scalar
minCoeff()
const;
405 typename internal::traits<Derived>::Scalar
maxCoeff()
const;
407 template<
typename IndexType>
408 typename internal::traits<Derived>::Scalar
minCoeff(IndexType*
row, IndexType*
col)
const;
409 template<
typename IndexType>
410 typename internal::traits<Derived>::Scalar
maxCoeff(IndexType*
row, IndexType*
col)
const;
411 template<
typename IndexType>
412 typename internal::traits<Derived>::Scalar
minCoeff(IndexType* index)
const;
413 template<
typename IndexType>
414 typename internal::traits<Derived>::Scalar
maxCoeff(IndexType* index)
const;
416 template<
typename BinaryOp>
417 typename internal::result_of<BinaryOp(typename internal::traits<Derived>::Scalar)>::type
418 redux(
const BinaryOp& func)
const;
420 template<
typename Visitor>
421 void visit(Visitor& func)
const;
428 EIGEN_STATIC_ASSERT_SIZE_1x1(Derived)
429 eigen_assert(this->rows() == 1 && this->cols() == 1);
430 return derived().coeff(0,0);
433 bool all(
void) const;
434 bool any(
void) const;
442 ConstRowwiseReturnType
rowwise() const;
444 ConstColwiseReturnType
colwise() const;
451 template<typename ThenDerived,typename ElseDerived>
452 const
Select<Derived,ThenDerived,ElseDerived>
456 template<typename ThenDerived>
457 inline const
Select<Derived,ThenDerived, typename ThenDerived::ConstantReturnType>
458 select(const
DenseBase<ThenDerived>& thenMatrix, const typename ThenDerived::Scalar& elseScalar) const;
460 template<typename ElseDerived>
461 inline const
Select<Derived, typename ElseDerived::ConstantReturnType, ElseDerived >
462 select(const typename ElseDerived::Scalar& thenScalar, const
DenseBase<ElseDerived>& elseMatrix) const;
464 template<
int p> RealScalar lpNorm() const;
466 template<
int RowFactor,
int ColFactor>
470 inline const ReplicateReturnType
replicate(Index rowFacor,Index colFactor) const;
475 ConstReverseReturnType reverse() const;
478 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::DenseBase
479 # include "../plugins/BlockMethods.h"
480 # ifdef EIGEN_DENSEBASE_PLUGIN
481 # include EIGEN_DENSEBASE_PLUGIN
483 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS
485 #ifdef EIGEN2_SUPPORT
489 template<
int CRows,
int CCols>
491 template<
int CRows,
int CCols>
494 #endif // EIGEN2_SUPPORT
498 template<
typename Dest>
inline void evalTo(Dest& )
const
500 EIGEN_STATIC_ASSERT((internal::is_same<Dest,void>::value),THE_EVAL_EVALTO_FUNCTION_SHOULD_NEVER_BE_CALLED_FOR_DENSE_OBJECTS);
510 #ifdef EIGEN_INTERNAL_DEBUGGING
513 INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION)
525 #endif // EIGEN_DENSEBASE_H
Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:49
void resize(Index newSize)
Definition: DenseBase.h:217
Derived & setRandom()
Definition: Random.h:110
RowXpr row(Index i)
Definition: DenseBase.h:750
static const CwiseNullaryOp< CustomNullaryOp, Derived > NullaryExpr(Index rows, Index cols, const CustomNullaryOp &func)
Definition: CwiseNullaryOp.h:117
const Select< Derived, ThenDerived, ElseDerived > select(const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
Definition: Select.h:124
Enforce aligned packet loads and stores regardless of what is requested.
Definition: ForceAlignedAccess.h:34
Scalar mean() const
Definition: Redux.h:372
ReverseReturnType reverse()
Definition: Reverse.h:191
internal::traits< Derived >::Scalar minCoeff() const
Definition: Redux.h:338
bool isApprox(const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: Fuzzy.h:98
void visit(Visitor &func) const
Definition: Visitor.h:77
Index nonZeros() const
Definition: DenseBase.h:185
Scalar prod() const
Definition: Redux.h:386
void fill(const Scalar &value)
Definition: CwiseNullaryOp.h:322
Expression of the transpose of a matrix.
Definition: Transpose.h:57
Derived & setOnes()
Definition: CwiseNullaryOp.h:625
Derived & operator=(const DenseBase< OtherDerived > &other)
Definition: Assign.h:550
bool hasNaN() const
Definition: BooleanRedux.h:137
bool any(void) const
Definition: BooleanRedux.h:103
CornerType
Definition: Constants.h:201
void resize(Index nbRows, Index nbCols)
Definition: DenseBase.h:227
void swap(const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
Definition: DenseBase.h:376
DenseBase()
Definition: DenseBase.h:505
Derived & setZero()
Definition: CwiseNullaryOp.h:499
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:88
Index count() const
Definition: BooleanRedux.h:127
internal::traits< Derived >::Scalar maxCoeff() const
Definition: Redux.h:348
Pseudo expression providing partial reduction operations.
Definition: ForwardDeclarations.h:212
bool isZero(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:482
ColXpr col(Index i)
Definition: DenseBase.h:733
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:41
Definition: DenseBase.h:162
bool all(void) const
Definition: BooleanRedux.h:79
Definition: Constants.h:212
bool allFinite() const
Definition: BooleanRedux.h:147
Helper class used by the comma initializer operator.
Definition: CommaInitializer.h:28
Definition: EigenBase.h:26
void swap(PlainObjectBase< OtherDerived > &other)
Definition: DenseBase.h:386
void reverseInPlace()
Definition: Reverse.h:217
Definition: DenseBase.h:172
bool isApproxToConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:298
Definition: DenseBase.h:155
Derived & setLinSpaced(Index size, const Scalar &low, const Scalar &high)
Sets a linearly space vector.
Definition: CwiseNullaryOp.h:387
Definition: DenseBase.h:108
Derived & setConstant(const Scalar &value)
Definition: CwiseNullaryOp.h:332
CommaInitializer< Derived > operator<<(const Scalar &s)
Definition: CommaInitializer.h:138
Scalar sum() const
Definition: Redux.h:359
static const CwiseNullaryOp< internal::scalar_random_op< Scalar >, Derived > Random()
Definition: Random.h:97
Dense storage base class for matrices and arrays.
Definition: PlainObjectBase.h:85
const NestByValue< Derived > nestByValue() const
Definition: NestByValue.h:104
Expression of the multiple replication of a matrix or vector.
Definition: Replicate.h:62
Index innerSize() const
Definition: DenseBase.h:207
Expression which must be nested by value.
Definition: NestByValue.h:35
Definition: DenseBase.h:167
Definition: Constants.h:209
Definition: DenseBase.h:132
internal::traits< Derived >::Index Index
The type of indices.
Definition: DenseBase.h:61
bool isConstant(const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:312
void transposeInPlace()
Definition: Transpose.h:292
Definition: Eigen_Colamd.h:54
static const ConstantReturnType Ones()
Definition: CwiseNullaryOp.h:597
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:103
bool isOnes(const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
Definition: CwiseNullaryOp.h:612
Definition: DenseBase.h:143
Eigen::Transpose< Derived > transpose()
Definition: Transpose.h:199
static const SequentialLinSpacedReturnType LinSpaced(Sequential_t, Index size, const Scalar &low, const Scalar &high)
Sets a linearly space vector.
Definition: CwiseNullaryOp.h:242
Index outerSize() const
Definition: DenseBase.h:196
static const ConstantReturnType Zero()
Definition: CwiseNullaryOp.h:468
Definition: DenseBase.h:115
const unsigned int RowMajorBit
Definition: Constants.h:53
Definition: Constants.h:215
CoeffReturnType value() const
Definition: DenseBase.h:426
const Flagged< Derived, Added, Removed > flagged() const
Definition: Flagged.h:133
const WithFormat< Derived > format(const IOFormat &fmt) const
Definition: IO.h:117
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:127
Expression of the reverse of a vector or matrix.
Definition: Reverse.h:70
ConstColwiseReturnType colwise() const
Definition: VectorwiseOp.h:599
Definition: DenseBase.h:102
Definition: DenseBase.h:121
ConstRowwiseReturnType rowwise() const
Definition: VectorwiseOp.h:624
static const ConstantReturnType Constant(Index rows, Index cols, const Scalar &value)
Definition: CwiseNullaryOp.h:179
EvalReturnType eval() const
Definition: DenseBase.h:364
Expression of a coefficient wise version of the C++ ternary operator ?:
Definition: Select.h:55
const Replicate< Derived, RowFactor, ColFactor > replicate() const
Definition: Replicate.h:139