Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Attributes
Eigen::Stride Class Reference

Detailed Description

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
Inheritance diagram for Eigen::Stride:
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

Reimplemented in Eigen::OuterStride, and Eigen::InnerStride.

Definition at line 61 of file Core.


Member Enumeration Documentation

anonymous enum
Enumerator:
InnerStrideAtCompileTime 
OuterStrideAtCompileTime 

Definition at line 62 of file Core.


Constructor & Destructor Documentation

Eigen::Stride::Stride ( ) [inline]

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

Definition at line 68 of file Core.

Eigen::Stride::Stride ( Index  outerStride,
Index  innerStride 
) [inline]

Constructor allowing to pass the strides at runtime.

Definition at line 75 of file Core.

Eigen::Stride::Stride ( const Stride other) [inline]

Copy constructor.

Definition at line 82 of file Core.


Member Function Documentation

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

Definition at line 89 of file Core.

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

Definition at line 87 of file Core.


Member Data Documentation

internal::variable_if_dynamic<Index, InnerStrideAtCompileTime> Eigen::Stride::m_inner [protected]

Definition at line 93 of file Core.

internal::variable_if_dynamic<Index, OuterStrideAtCompileTime> Eigen::Stride::m_outer [protected]

Definition at line 92 of file Core.




Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011