Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Attributes

Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > Class Template Reference


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:

Output:

See also:
class InnerStride, class OuterStride

Definition at line 57 of file Stride.h.

#include <src/Core/Stride.h>

Inheritance diagram for Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >:
Inheritance graph
[legend]

List of all members.

Public Types

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

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

Protected Attributes

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

Member Typedef Documentation

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

Reimplemented in InnerStride< Value >, and OuterStride< 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.

Referenced by Stride< 0, Value >::inner().

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.

Referenced by Stride< 0, Value >::outer().




Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011