Eigne Matrix Class Library

Dependents:   Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more

Embed: (wiki syntax)

« Back to documentation index

Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > Class Template Reference

Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > Class Template Reference
[Core module]

Holds strides information for Map. More...

#include <Stride.h>

Public Member Functions

 Stride ()
 Default constructor, for use when strides are fixed at compile time.
 Stride (Index outerStride, Index innerStride)
 Constructor allowing to pass the strides at runtime.
 Stride (const Stride &other)
 Copy constructor.
Index outer () const
Index inner () const

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:

Output:

See also:
class InnerStride, class OuterStride, TopicStorageOrders

Definition at line 44 of file Stride.h.


Constructor & Destructor Documentation

Stride (  )

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

Definition at line 54 of file Stride.h.

Stride ( Index  outerStride,
Index  innerStride 
)

Constructor allowing to pass the strides at runtime.

Definition at line 61 of file Stride.h.

Stride ( const Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > &  other )

Copy constructor.

Definition at line 68 of file Stride.h.


Member Function Documentation

Index inner (  ) const
Returns:
the inner stride

Definition at line 75 of file Stride.h.

Index outer (  ) const
Returns:
the outer stride

Definition at line 73 of file Stride.h.