Holds strides information for Map. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/Stride.h>

Public Types
enum	{ InnerStrideAtCompileTime = _InnerStrideAtCompileTime , OuterStrideAtCompileTime = _OuterStrideAtCompileTime }

typedef Eigen::Index	Index

Public Member Functions
EIGEN_DEVICE_FUNC	Stride ()
	Default constructor, for use when strides are fixed at compile time. More...

EIGEN_DEVICE_FUNC	Stride (Index outerStride, Index innerStride)
	Constructor allowing to pass the strides at runtime. More...

EIGEN_DEVICE_FUNC	Stride (const Stride &other)
	Copy constructor. More...

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outer () const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	inner () const

Protected Attributes
internal::variable_if_dynamic< Index, OuterStrideAtCompileTime >	m_outer

internal::variable_if_dynamic< Index, InnerStrideAtCompileTime >	m_inner

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:

Output:

Both strides can be negative, however, a negative stride of -1 cannot be specified at compiletime because of the ambiguity with Dynamic which is defined to -1 (historically, negative strides were not allowed).

See also: class InnerStride, class OuterStride, TopicStorageOrders