Public Types | Public Member Functions | Protected Attributes
Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > Class Template Reference

Holds strides information for Map. More...

#include <Stride.h>

List of all members.

Public Types

enum  { InnerStrideAtCompileTime = _InnerStrideAtCompileTime, OuterStrideAtCompileTime = _OuterStrideAtCompileTime }
typedef DenseIndex Index

Public Member Functions

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

Protected Attributes

internal::variable_if_dynamic
< Index,
InnerStrideAtCompileTime
m_inner
internal::variable_if_dynamic
< Index,
OuterStrideAtCompileTime
m_outer

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.


Member Typedef Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
typedef DenseIndex Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Index

Reimplemented in Eigen::OuterStride< Value >, and Eigen::InnerStride< Value >.

Definition at line 47 of file Stride.h.


Member Enumeration Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
anonymous enum
Enumerator:
InnerStrideAtCompileTime 
OuterStrideAtCompileTime 

Definition at line 48 of file Stride.h.


Constructor & Destructor Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Stride ( ) [inline]

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

Definition at line 54 of file Stride.h.

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Stride ( Index  outerStride,
Index  innerStride 
) [inline]

Constructor allowing to pass the strides at runtime

Definition at line 61 of file Stride.h.

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Stride ( const Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > &  other) [inline]

Copy constructor

Definition at line 68 of file Stride.h.


Member Function Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::inner ( ) const [inline]
Returns:
the inner stride

Definition at line 75 of file Stride.h.

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::outer ( ) const [inline]
Returns:
the outer stride

Definition at line 73 of file Stride.h.


Member Data Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
internal::variable_if_dynamic<Index, InnerStrideAtCompileTime> Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::m_inner [protected]

Definition at line 79 of file Stride.h.

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
internal::variable_if_dynamic<Index, OuterStrideAtCompileTime> Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::m_outer [protected]

Definition at line 78 of file Stride.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 12:02:04