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 DenseCoeffsBase<Derived>
45 :
public DenseCoeffsBase<Derived,DirectWriteAccessors>
46 #endif // not EIGEN_PARSED_BY_DOXYGEN 53 typedef Eigen::InnerIterator<Derived> InnerIterator;
55 typedef typename internal::traits<Derived>::StorageKind StorageKind;
63 typedef typename internal::traits<Derived>::StorageIndex
StorageIndex;
66 typedef typename internal::traits<Derived>::Scalar
Scalar;
74 typedef DenseCoeffsBase<Derived> Base;
77 using Base::const_cast_derived;
81 using Base::rowIndexByOuterInner;
82 using Base::colIndexByOuterInner;
84 using Base::coeffByOuterInner;
85 using Base::operator();
86 using Base::operator[];
92 using Base::innerStride;
93 using Base::outerStride;
94 using Base::rowStride;
95 using Base::colStride;
96 typedef typename Base::CoeffReturnType CoeffReturnType;
100 RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
106 ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
113 SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
114 internal::traits<Derived>::ColsAtCompileTime>::ret),
119 MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime,
130 MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime,
141 MaxSizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::MaxRowsAtCompileTime,
142 internal::traits<Derived>::MaxColsAtCompileTime>::ret),
153 IsVectorAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime == 1
154 || internal::traits<Derived>::MaxColsAtCompileTime == 1,
160 Flags = internal::traits<Derived>::Flags,
167 InnerSizeAtCompileTime = int(IsVectorAtCompileTime) ? int(SizeAtCompileTime)
168 : int(IsRowMajor) ? int(ColsAtCompileTime) : int(RowsAtCompileTime),
170 InnerStrideAtCompileTime =
internal::inner_stride_at_compile_time<Derived>::ret,
171 OuterStrideAtCompileTime =
internal::outer_stride_at_compile_time<Derived>::ret
174 typedef typename internal::find_best_packet<Scalar,SizeAtCompileTime>::type PacketScalar;
176 enum { IsPlainObjectBase = 0 };
181 internal::traits<Derived>::RowsAtCompileTime,
182 internal::traits<Derived>::ColsAtCompileTime,
184 internal::traits<Derived>::MaxRowsAtCompileTime,
185 internal::traits<Derived>::MaxColsAtCompileTime
191 internal::traits<Derived>::RowsAtCompileTime,
192 internal::traits<Derived>::ColsAtCompileTime,
194 internal::traits<Derived>::MaxRowsAtCompileTime,
195 internal::traits<Derived>::MaxColsAtCompileTime
204 typedef typename internal::conditional<internal::is_same<typename internal::traits<Derived>::XprKind,
MatrixXpr >::value,
220 return IsVectorAtCompileTime ? 1
221 : int(IsRowMajor) ? this->rows() : this->cols();
232 return IsVectorAtCompileTime ? this->size()
233 : int(IsRowMajor) ? this->cols() : this->rows();
243 EIGEN_ONLY_USED_FOR_DEBUG(newSize);
244 eigen_assert(newSize == this->size()
245 &&
"DenseBase::resize() does not actually allow one to resize.");
254 EIGEN_ONLY_USED_FOR_DEBUG(rows);
255 EIGEN_ONLY_USED_FOR_DEBUG(cols);
256 eigen_assert(rows == this->rows() && cols == this->cols()
257 &&
"DenseBase::resize() does not actually allow one to resize.");
260 #ifndef EIGEN_PARSED_BY_DOXYGEN 266 typedef CwiseNullaryOp<internal::linspaced_op<Scalar,PacketScalar>,PlainObject> RandomAccessLinSpacedReturnType;
270 #endif // not EIGEN_PARSED_BY_DOXYGEN 273 template<
typename OtherDerived>
274 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
280 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
281 Derived& operator=(
const DenseBase& other);
283 template<
typename OtherDerived>
287 template<
typename OtherDerived>
291 template<
typename OtherDerived>
295 template<
typename OtherDerived>
297 Derived& operator=(
const ReturnByValue<OtherDerived>& func);
302 template<
typename OtherDerived>
310 template<
unsigned int Added,
unsigned int Removed>
313 {
return derived(); }
315 template<
typename OtherDerived>
321 TransposeReturnType transpose();
324 ConstTransposeReturnType transpose()
const;
326 void transposeInPlace();
328 EIGEN_DEVICE_FUNC
static const ConstantReturnType
330 EIGEN_DEVICE_FUNC
static const ConstantReturnType
331 Constant(
Index size,
const Scalar& value);
332 EIGEN_DEVICE_FUNC
static const ConstantReturnType
333 Constant(
const Scalar& value);
335 EIGEN_DEVICE_FUNC
static const SequentialLinSpacedReturnType
336 LinSpaced(Sequential_t,
Index size,
const Scalar& low,
const Scalar& high);
337 EIGEN_DEVICE_FUNC
static const RandomAccessLinSpacedReturnType
338 LinSpaced(
Index size,
const Scalar& low,
const Scalar& high);
339 EIGEN_DEVICE_FUNC
static const SequentialLinSpacedReturnType
340 LinSpaced(Sequential_t,
const Scalar& low,
const Scalar& high);
341 EIGEN_DEVICE_FUNC
static const RandomAccessLinSpacedReturnType
342 LinSpaced(
const Scalar& low,
const Scalar& high);
344 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
346 NullaryExpr(
Index rows,
Index cols,
const CustomNullaryOp& func);
347 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
349 NullaryExpr(
Index size,
const CustomNullaryOp& func);
350 template<
typename CustomNullaryOp> EIGEN_DEVICE_FUNC
352 NullaryExpr(
const CustomNullaryOp& func);
354 EIGEN_DEVICE_FUNC
static const ConstantReturnType Zero(
Index rows,
Index cols);
355 EIGEN_DEVICE_FUNC
static const ConstantReturnType Zero(
Index size);
356 EIGEN_DEVICE_FUNC
static const ConstantReturnType Zero();
357 EIGEN_DEVICE_FUNC
static const ConstantReturnType Ones(
Index rows,
Index cols);
358 EIGEN_DEVICE_FUNC
static const ConstantReturnType Ones(
Index size);
359 EIGEN_DEVICE_FUNC
static const ConstantReturnType Ones();
361 EIGEN_DEVICE_FUNC
void fill(
const Scalar& value);
362 EIGEN_DEVICE_FUNC Derived& setConstant(
const Scalar& value);
363 EIGEN_DEVICE_FUNC Derived& setLinSpaced(
Index size,
const Scalar& low,
const Scalar& high);
364 EIGEN_DEVICE_FUNC Derived& setLinSpaced(
const Scalar& low,
const Scalar& high);
365 EIGEN_DEVICE_FUNC Derived& setZero();
366 EIGEN_DEVICE_FUNC Derived& setOnes();
367 EIGEN_DEVICE_FUNC Derived& setRandom();
369 template<
typename OtherDerived> EIGEN_DEVICE_FUNC
373 bool isMuchSmallerThan(
const RealScalar& other,
375 template<
typename OtherDerived> EIGEN_DEVICE_FUNC
384 inline bool hasNaN()
const;
385 inline bool allFinite()
const;
387 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
388 Derived& operator*=(
const Scalar& other);
389 EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE
390 Derived& operator/=(
const Scalar& other);
392 typedef typename internal::add_const_on_value_type<typename internal::eval<Derived>::type>::type EvalReturnType;
401 EIGEN_STRONG_INLINE EvalReturnType
eval()
const 406 return typename internal::eval<Derived>::type(derived());
412 template<
typename OtherDerived>
416 EIGEN_STATIC_ASSERT(!OtherDerived::IsPlainObjectBase,THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY);
417 eigen_assert(rows()==other.
rows() && cols()==other.
cols());
418 call_assignment(derived(), other.const_cast_derived(), internal::swap_assign_op<Scalar>());
424 template<
typename OtherDerived>
428 eigen_assert(rows()==other.rows() && cols()==other.cols());
429 call_assignment(derived(), other.derived(), internal::swap_assign_op<Scalar>());
435 template<
bool Enable> EIGEN_DEVICE_FUNC
436 inline const typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf()
const;
437 template<
bool Enable> EIGEN_DEVICE_FUNC
438 inline typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf();
440 EIGEN_DEVICE_FUNC Scalar sum()
const;
441 EIGEN_DEVICE_FUNC Scalar mean()
const;
442 EIGEN_DEVICE_FUNC Scalar trace()
const;
444 EIGEN_DEVICE_FUNC Scalar prod()
const;
446 EIGEN_DEVICE_FUNC
typename internal::traits<Derived>::Scalar minCoeff()
const;
447 EIGEN_DEVICE_FUNC
typename internal::traits<Derived>::Scalar maxCoeff()
const;
449 template<
typename IndexType> EIGEN_DEVICE_FUNC
450 typename internal::traits<Derived>::Scalar minCoeff(IndexType* row, IndexType* col)
const;
451 template<
typename IndexType> EIGEN_DEVICE_FUNC
452 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* row, IndexType* col)
const;
453 template<
typename IndexType> EIGEN_DEVICE_FUNC
454 typename internal::traits<Derived>::Scalar minCoeff(IndexType* index)
const;
455 template<
typename IndexType> EIGEN_DEVICE_FUNC
456 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* index)
const;
458 template<
typename BinaryOp>
460 Scalar redux(
const BinaryOp& func)
const;
462 template<
typename Visitor>
464 void visit(Visitor& func)
const;
482 EIGEN_STATIC_ASSERT_SIZE_1x1(Derived)
483 eigen_assert(this->rows() == 1 && this->cols() == 1);
484 return derived().coeff(0,0);
487 EIGEN_DEVICE_FUNC
bool all()
const;
488 EIGEN_DEVICE_FUNC
bool any()
const;
489 EIGEN_DEVICE_FUNC
Index count()
const;
504 EIGEN_DEVICE_FUNC
inline ConstRowwiseReturnType
rowwise()
const {
505 return ConstRowwiseReturnType(derived());
507 EIGEN_DEVICE_FUNC RowwiseReturnType rowwise();
516 EIGEN_DEVICE_FUNC
inline ConstColwiseReturnType
colwise()
const {
517 return ConstColwiseReturnType(derived());
519 EIGEN_DEVICE_FUNC ColwiseReturnType colwise();
522 static const RandomReturnType Random(
Index rows,
Index cols);
523 static const RandomReturnType Random(
Index size);
524 static const RandomReturnType Random();
526 template<
typename ThenDerived,
typename ElseDerived>
531 template<
typename ThenDerived>
535 template<
typename ElseDerived>
539 template<
int p> RealScalar lpNorm()
const;
541 template<
int RowFactor,
int ColFactor>
561 EIGEN_DEVICE_FUNC ReverseReturnType reverse();
564 EIGEN_DEVICE_FUNC ConstReverseReturnType
reverse()
const 566 return ConstReverseReturnType(derived());
568 EIGEN_DEVICE_FUNC
void reverseInPlace();
570 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::DenseBase 571 #define EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL 572 #define EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF(COND) 573 # include "../plugins/BlockMethods.h" 574 # ifdef EIGEN_DENSEBASE_PLUGIN 575 # include EIGEN_DENSEBASE_PLUGIN 577 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS 578 #undef EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL 579 #undef EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF 582 template<
typename Dest>
584 inline void evalTo(Dest& )
const 586 EIGEN_STATIC_ASSERT((internal::is_same<Dest,void>::value),THE_EVAL_EVALTO_FUNCTION_SHOULD_NEVER_BE_CALLED_FOR_DENSE_OBJECTS);
596 #ifdef EIGEN_INTERNAL_DEBUGGING 597 EIGEN_STATIC_ASSERT((EIGEN_IMPLIES(MaxRowsAtCompileTime==1 && MaxColsAtCompileTime!=1,
int(IsRowMajor))
598 && EIGEN_IMPLIES(MaxColsAtCompileTime==1 && MaxRowsAtCompileTime!=1,
int(!IsRowMajor))),
599 INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION)
604 EIGEN_DEVICE_FUNC
explicit DenseBase(
int);
611 #endif // EIGEN_DENSEBASE_H Generic expression of a matrix where all coefficients are defined by a functor.
Definition: CwiseNullaryOp.h:60
const Replicate< Derived, Dynamic, Dynamic > replicate(Index rowFactor, Index colFactor) const
Definition: DenseBase.h:554
ConstReverseReturnType reverse() const
Definition: DenseBase.h:564
Index innerSize() const
Definition: DenseBase.h:230
Enforce aligned packet loads and stores regardless of what is requested.
Definition: ForceAlignedAccess.h:34
internal::traits< Derived >::Scalar Scalar
Definition: DenseBase.h:66
Definition: Constants.h:320
Expression of the transpose of a matrix.
Definition: Transpose.h:52
Namespace containing all symbols from the Eigen library.
Definition: Core:287
Scalar value_type
Definition: DenseBase.h:71
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:150
Pseudo expression providing partial reduction operations.
Definition: ForwardDeclarations.h:245
const WithFormat< Derived > format(const IOFormat &fmt) const
Definition: DenseBase.h:473
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:38
const unsigned int RowMajorBit
Definition: Constants.h:61
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:41
void resize(Index newSize)
Definition: DenseBase.h:241
Helper class used by the comma initializer operator.
Definition: CommaInitializer.h:28
internal::traits< Derived >::StorageIndex StorageIndex
The type used to store indices.
Definition: DenseBase.h:63
Definition: EigenBase.h:29
Definition: Constants.h:506
Index nonZeros() const
Definition: DenseBase.h:210
Definition: Constants.h:324
Index rows() const
Definition: EigenBase.h:59
Dense storage base class for matrices and arrays.
Definition: PlainObjectBase.h:95
Expression of the multiple replication of a matrix or vector.
Definition: Replicate.h:61
EIGEN_DEPRECATED const Derived & flagged() const
Definition: DenseBase.h:312
Expression which must be nested by value.
Definition: NestByValue.h:34
void swap(const DenseBase< OtherDerived > &other)
Definition: DenseBase.h:414
ConstColwiseReturnType colwise() const
Definition: DenseBase.h:516
DenseBase()
Definition: DenseBase.h:591
Definition: Eigen_Colamd.h:50
internal::conditional< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type PlainObject
The plain matrix or array type corresponding to this expression.
Definition: DenseBase.h:205
ConstRowwiseReturnType rowwise() const
Definition: DenseBase.h:504
General-purpose arrays with easy API for coefficient-wise operations.
Definition: Array.h:45
Definition: Constants.h:322
CoeffReturnType value() const
Definition: DenseBase.h:480
EvalReturnType eval() const
Definition: DenseBase.h:401
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:178
Index cols() const
Definition: EigenBase.h:62
Expression of the reverse of a vector or matrix.
Definition: Reverse.h:63
Index outerSize() const
Definition: DenseBase.h:218
void resize(Index rows, Index cols)
Definition: DenseBase.h:252
void swap(PlainObjectBase< OtherDerived > &other)
Definition: DenseBase.h:426
Expression of a coefficient wise version of the C++ ternary operator ?:
Definition: Select.h:52