Public Types | Public Member Functions | Protected Attributes
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 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:

See also:
class InnerStride, class OuterStride, Storage orders

Definition at line 57 of file Stride.h.


Member Typedef Documentation

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

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

Definition at line 60 of file Stride.h.


Member Enumeration Documentation

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

Definition at line 61 of file Stride.h.


Constructor & Destructor Documentation

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

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

Definition at line 67 of file Stride.h.

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

Constructor allowing to pass the strides at runtime

Definition at line 74 of file Stride.h.

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

Copy constructor

Definition at line 81 of file Stride.h.


Member Function Documentation

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

Definition at line 88 of file Stride.h.

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

Definition at line 86 of file Stride.h.


Member Data Documentation

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

Definition at line 92 of file Stride.h.

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

Definition at line 91 of file Stride.h.


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


re_vision
Author(s): Dorian Galvez-Lopez
autogenerated on Sun Jan 5 2014 11:34:26