Eigen: Eigen::Stride< OuterStrideAtCompileTime_, InnerStrideAtCompileTime

Searching...

No Matches

#include <Eigen/src/Core/Stride.h>

Detailed Description

template<int OuterStrideAtCompileTime_, int InnerStrideAtCompileTime_>
class Eigen::Stride< OuterStrideAtCompileTime_, InnerStrideAtCompileTime_ >

Holds strides information for Map.

This class holds the strides information for mapping arrays with strides with class Map.

It holds two values: the inner stride and the outer stride.

The inner stride is the pointer increment between two consecutive entries within a given row of a row-major matrix or within a given column of a column-major matrix.

The outer stride is the pointer increment between two consecutive rows of a row-major matrix or between two consecutive columns of a column-major matrix.

These two values can be passed either at compile-time as template parameters, or at runtime as arguments to the constructor.

Indeed, this class takes two template parameters:

Template Parameters

OuterStrideAtCompileTime_	the outer stride, or Dynamic if you want to specify it at runtime.
InnerStrideAtCompileTime_	the inner stride, or Dynamic if you want to specify it at runtime.

Here is an example:

// SPDX-FileCopyrightText: The Eigen Authors
// SPDX-License-Identifier: MPL-2.0
 
int array[24];
for (int i = 0; i < 24; ++i) array[i] = i;
cout << Map<MatrixXi, 0, Stride<Dynamic, 2> >(array, 3, 3, Stride<Dynamic, 2>(8, 2)) << endl;

Output:

 0  8 16
 2 10 18
 4 12 20

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 not allowed).

Note that for compile-time vectors (ColsAtCompileTime==1 or RowsAtCompileTime==1), the inner stride is the pointer increment between two consecutive elements, regardless of storage layout.

See also: class InnerStride, class OuterStride, Storage orders

Public Types
using	Index

Public Member Functions
constexpr Index	inner () const

constexpr Stride &	operator= (const Stride &other)

constexpr Index	outer () const

constexpr	Stride ()

constexpr	Stride (const Stride &other)=default

constexpr	Stride (Index outerStride, Index innerStride)