Public Member Functions
Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > Class Template Reference

Holds strides information for Map. More...

List of all members.

Public Member Functions

Index inner () const
Index outer () const
 Stride ()
 Stride (Index outerStride, Index innerStride)
 Stride (const Stride &other)

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:

Parameters:
_OuterStrideAtCompileTimethe outer stride, or Dynamic if you want to specify it at runtime.
_InnerStrideAtCompileTimethe inner stride, or Dynamic if you want to specify it at runtime.

Here is an example:

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
See also:
class InnerStride, class OuterStride, Storage orders

Constructor & Destructor Documentation

Stride ( ) [inline]

Default constructor, for use when strides are fixed at compile time

Stride ( Index  outerStride,
Index  innerStride 
) [inline]

Constructor allowing to pass the strides at runtime

Stride ( const Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > &  other) [inline]

Copy constructor


Member Function Documentation

Index inner ( ) const [inline]
Returns:
the inner stride
Index outer ( ) const [inline]
Returns:
the outer stride

The documentation for this class was generated from the following file: