Included note on inner stride for compile-time vectors. See https://gitlab.com/libeigen/eigen/-/issues/2355#note_711078126

This commit is contained in:
Lennart Steffen 2021-10-22 09:46:43 +00:00
parent b17bcddbca
commit 163f11e24a

View File

@ -40,10 +40,14 @@ namespace Eigen {
* \include Map_general_stride.cpp * \include Map_general_stride.cpp
* Output: \verbinclude Map_general_stride.out * Output: \verbinclude Map_general_stride.out
* *
* Both strides can be negative, however, a negative stride of -1 cannot be specified at compiletime * Both strides can be negative. However, a negative stride of -1 cannot be specified at compile time
* because of the ambiguity with Dynamic which is defined to -1 (historically, negative strides were * because of the ambiguity with Dynamic which is defined to -1 (historically, negative strides were
* not allowed). * not allowed).
* *
* Note that for compile-time vectors (ColsAtCompileTime==1 or RowsAtCompile==1),
* the inner stride is the pointer increment between two consecutive elements,
* regardless of storage layout.
*
* \sa class InnerStride, class OuterStride, \ref TopicStorageOrders * \sa class InnerStride, class OuterStride, \ref TopicStorageOrders
*/ */
template<int OuterStrideAtCompileTime_, int InnerStrideAtCompileTime_> template<int OuterStrideAtCompileTime_, int InnerStrideAtCompileTime_>