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,
45 DenseCoeffsBase<Derived> >
47 :
public DenseCoeffsBase<Derived>
48 #endif // not EIGEN_PARSED_BY_DOXYGEN 54 typedef typename internal::traits<Derived>::StorageKind StorageKind;
60 typedef typename internal::traits<Derived>::Index
Index;
62 typedef typename internal::traits<Derived>::Scalar Scalar;
63 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
65 typedef internal::special_scalar_op_base<Derived,Scalar,RealScalar, DenseCoeffsBase<Derived> > Base;
67 using Base::operator*;
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;
102 RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
108 ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
115 SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
116 internal::traits<Derived>::ColsAtCompileTime>::ret),
121 MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime,
132 MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime,
143 MaxSizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::MaxRowsAtCompileTime,
144 internal::traits<Derived>::MaxColsAtCompileTime>::ret),
155 IsVectorAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime == 1
156 || internal::traits<Derived>::MaxColsAtCompileTime == 1,
162 Flags = internal::traits<Derived>::Flags,
169 InnerSizeAtCompileTime = int(IsVectorAtCompileTime) ? int(SizeAtCompileTime)
170 : int(IsRowMajor) ? int(ColsAtCompileTime) : int(RowsAtCompileTime),
172 CoeffReadCost =
internal::traits<Derived>::CoeffReadCost,
177 InnerStrideAtCompileTime =
internal::inner_stride_at_compile_time<Derived>::ret,
178 OuterStrideAtCompileTime =
internal::outer_stride_at_compile_time<Derived>::ret
181 enum { ThisConstantIsPrivateInPlainObjectBase };
185 inline Index nonZeros()
const {
return size(); }
194 return IsVectorAtCompileTime ? 1
195 : int(IsRowMajor) ? this->rows() : this->cols();
205 return IsVectorAtCompileTime ? this->size()
206 : int(IsRowMajor) ? this->cols() : this->rows();
215 EIGEN_ONLY_USED_FOR_DEBUG(newSize);
216 eigen_assert(newSize == this->size()
217 &&
"DenseBase::resize() does not actually allow to resize.");
225 EIGEN_ONLY_USED_FOR_DEBUG(nbRows);
226 EIGEN_ONLY_USED_FOR_DEBUG(nbCols);
227 eigen_assert(nbRows == this->rows() && nbCols == this->cols()
228 &&
"DenseBase::resize() does not actually allow to resize.");
231 #ifndef EIGEN_PARSED_BY_DOXYGEN 242 #endif // not EIGEN_PARSED_BY_DOXYGEN 245 template<
typename OtherDerived>
251 Derived& operator=(
const DenseBase& other);
253 template<
typename OtherDerived>
256 template<
typename OtherDerived>
259 template<
typename OtherDerived>
262 template<
typename OtherDerived>
263 Derived& operator=(
const ReturnByValue<OtherDerived>& func);
266 template<
typename OtherDerived>
270 template<
typename OtherDerived>
271 Derived& lazyAssign(
const ReturnByValue<OtherDerived>& other);
275 template<
unsigned int Added,
unsigned int Removed>
276 const Flagged<Derived, Added, Removed> flagged()
const;
278 template<
typename OtherDerived>
283 ConstTransposeReturnType transpose()
const;
284 void transposeInPlace();
285 #ifndef EIGEN_NO_DEBUG 287 template<
typename OtherDerived>
288 void checkTransposeAliasing(
const OtherDerived& other)
const;
293 static const ConstantReturnType
294 Constant(Index rows, Index cols,
const Scalar& value);
295 static const ConstantReturnType
296 Constant(Index size,
const Scalar& value);
297 static const ConstantReturnType
298 Constant(
const Scalar& value);
300 static const SequentialLinSpacedReturnType
301 LinSpaced(Sequential_t, Index size,
const Scalar& low,
const Scalar& high);
302 static const RandomAccessLinSpacedReturnType
303 LinSpaced(Index size,
const Scalar& low,
const Scalar& high);
304 static const SequentialLinSpacedReturnType
305 LinSpaced(Sequential_t,
const Scalar& low,
const Scalar& high);
306 static const RandomAccessLinSpacedReturnType
307 LinSpaced(
const Scalar& low,
const Scalar& high);
309 template<
typename CustomNullaryOp>
311 NullaryExpr(Index rows, Index cols,
const CustomNullaryOp& func);
312 template<
typename CustomNullaryOp>
314 NullaryExpr(Index size,
const CustomNullaryOp& func);
315 template<
typename CustomNullaryOp>
317 NullaryExpr(
const CustomNullaryOp& func);
319 static const ConstantReturnType Zero(Index rows, Index cols);
320 static const ConstantReturnType Zero(Index size);
321 static const ConstantReturnType Zero();
322 static const ConstantReturnType Ones(Index rows, Index cols);
323 static const ConstantReturnType Ones(Index size);
324 static const ConstantReturnType Ones();
326 void fill(
const Scalar& value);
327 Derived& setConstant(
const Scalar& value);
328 Derived& setLinSpaced(Index size,
const Scalar& low,
const Scalar& high);
329 Derived& setLinSpaced(
const Scalar& low,
const Scalar& high);
332 Derived& setRandom();
334 template<
typename OtherDerived>
337 bool isMuchSmallerThan(
const RealScalar& other,
339 template<
typename OtherDerived>
348 inline bool hasNaN()
const;
349 inline bool allFinite()
const;
351 inline Derived& operator*=(
const Scalar& other);
352 inline Derived& operator/=(
const Scalar& other);
354 typedef typename internal::add_const_on_value_type<typename internal::eval<Derived>::type>::type EvalReturnType;
360 EIGEN_STRONG_INLINE EvalReturnType
eval()
const 365 return typename internal::eval<Derived>::type(derived());
371 template<
typename OtherDerived>
373 int = OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
375 SwapWrapper<Derived>(derived()).lazyAssign(other.derived());
381 template<
typename OtherDerived>
384 SwapWrapper<Derived>(derived()).lazyAssign(other.derived());
391 template<
bool Enable>
inline const typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf()
const;
392 template<
bool Enable>
inline typename internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type forceAlignedAccessIf();
396 Scalar trace()
const;
400 typename internal::traits<Derived>::Scalar minCoeff()
const;
401 typename internal::traits<Derived>::Scalar maxCoeff()
const;
403 template<
typename IndexType>
404 typename internal::traits<Derived>::Scalar minCoeff(IndexType* row, IndexType* col)
const;
405 template<
typename IndexType>
406 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* row, IndexType* col)
const;
407 template<
typename IndexType>
408 typename internal::traits<Derived>::Scalar minCoeff(IndexType* index)
const;
409 template<
typename IndexType>
410 typename internal::traits<Derived>::Scalar maxCoeff(IndexType* index)
const;
412 template<
typename BinaryOp>
413 typename internal::result_of<BinaryOp(typename internal::traits<Derived>::Scalar)>::type
414 redux(
const BinaryOp& func)
const;
416 template<
typename Visitor>
417 void visit(Visitor& func)
const;
424 EIGEN_STATIC_ASSERT_SIZE_1x1(Derived)
425 eigen_assert(this->rows() == 1 && this->cols() == 1);
426 return derived().coeff(0,0);
429 bool all(
void)
const;
430 bool any(
void)
const;
438 ConstRowwiseReturnType rowwise()
const;
439 RowwiseReturnType rowwise();
440 ConstColwiseReturnType colwise()
const;
441 ColwiseReturnType colwise();
447 template<
typename ThenDerived,
typename ElseDerived>
452 template<
typename ThenDerived>
456 template<
typename ElseDerived>
460 template<
int p> RealScalar lpNorm()
const;
462 template<
int RowFactor,
int ColFactor>
466 inline const ReplicateReturnType replicate(Index rowFacor,Index colFactor)
const;
470 ReverseReturnType reverse();
471 ConstReverseReturnType reverse()
const;
472 void reverseInPlace();
474 #define EIGEN_CURRENT_STORAGE_BASE_CLASS Eigen::DenseBase 475 # include "../plugins/BlockMethods.h" 476 # ifdef EIGEN_DENSEBASE_PLUGIN 477 # include EIGEN_DENSEBASE_PLUGIN 479 #undef EIGEN_CURRENT_STORAGE_BASE_CLASS 481 #ifdef EIGEN2_SUPPORT 485 template<
int CRows,
int CCols>
487 template<
int CRows,
int CCols>
490 #endif // EIGEN2_SUPPORT 494 template<
typename Dest>
inline void evalTo(Dest& )
const 496 EIGEN_STATIC_ASSERT((internal::is_same<Dest,void>::value),THE_EVAL_EVALTO_FUNCTION_SHOULD_NEVER_BE_CALLED_FOR_DENSE_OBJECTS);
506 #ifdef EIGEN_INTERNAL_DEBUGGING 507 EIGEN_STATIC_ASSERT((EIGEN_IMPLIES(MaxRowsAtCompileTime==1 && MaxColsAtCompileTime!=1,
int(IsRowMajor))
508 && EIGEN_IMPLIES(MaxColsAtCompileTime==1 && MaxRowsAtCompileTime!=1,
int(!IsRowMajor))),
509 INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION)
521 #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:213
Enforce aligned packet loads and stores regardless of what is requested.
Definition: ForceAlignedAccess.h:34
Expression of the transpose of a matrix.
Definition: Transpose.h:57
CornerType
Definition: Constants.h:201
void resize(Index nbRows, Index nbCols)
Definition: DenseBase.h:223
void swap(const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
Definition: DenseBase.h:372
DenseBase()
Definition: DenseBase.h:501
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:88
Pseudo expression providing partial reduction operations.
Definition: ForwardDeclarations.h:212
Base class for all dense matrices, vectors, and arrays.
Definition: DenseBase.h:41
Helper class used by the comma initializer operator.
Definition: CommaInitializer.h:28
Definition: EigenBase.h:26
void swap(PlainObjectBase< OtherDerived > &other)
Definition: DenseBase.h:382
Dense storage base class for matrices and arrays.
Definition: PlainObjectBase.h:85
Expression of the multiple replication of a matrix or vector.
Definition: Replicate.h:62
Index innerSize() const
Definition: DenseBase.h:203
Expression which must be nested by value.
Definition: NestByValue.h:35
internal::traits< Derived >::Index Index
The type of indices.
Definition: DenseBase.h:60
Definition: Eigen_Colamd.h:50
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:103
Index outerSize() const
Definition: DenseBase.h:192
const unsigned int RowMajorBit
Definition: Constants.h:53
CoeffReturnType value() const
Definition: DenseBase.h:422
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
EvalReturnType eval() const
Definition: DenseBase.h:360
Expression of a coefficient wise version of the C++ ternary operator ?:
Definition: Select.h:55