Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > Class Template Reference

Holds strides information for Map. More...

#include <Stride.h>

Inheritance diagram for Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >:

Collaboration diagram for Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >:

List of all members.

Public Types
enum	{ InnerStrideAtCompileTime = _InnerStrideAtCompileTime, OuterStrideAtCompileTime = _OuterStrideAtCompileTime }
typedef Eigen::Index	Index
Public Member Functions
EIGEN_DEVICE_FUNC	Stride ()
EIGEN_DEVICE_FUNC	Stride (Index outerStride, Index innerStride)
EIGEN_DEVICE_FUNC	Stride (const Stride &other)
EIGEN_DEVICE_FUNC Index	outer () const
EIGEN_DEVICE_FUNC Index	inner () const
Protected Attributes
internal::variable_if_dynamic < Index, OuterStrideAtCompileTime >	m_outer
internal::variable_if_dynamic < Index, InnerStrideAtCompileTime >	m_inner

---

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:

Template Parameters:

_OuterStrideAtCompileTime	the outer stride, or Dynamic if you want to specify it at runtime.
_InnerStrideAtCompileTime	the 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 Eigen::Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Index

Deprecated:

since Eigen 3.3

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.

         {
      InnerStrideAtCompileTime = _InnerStrideAtCompileTime,
      OuterStrideAtCompileTime = _OuterStrideAtCompileTime
    };

---

Constructor & Destructor Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Stride

(

)

[inline]

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

Definition at line 55 of file Stride.h.

      : m_outer(OuterStrideAtCompileTime), m_inner(InnerStrideAtCompileTime)
    {
      eigen_assert(InnerStrideAtCompileTime != Dynamic && OuterStrideAtCompileTime != Dynamic);
    }

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>

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

Constructor allowing to pass the strides at runtime

Definition at line 63 of file Stride.h.

      : m_outer(outerStride), m_inner(innerStride)
    {
      eigen_assert(innerStride>=0 && outerStride>=0);
    }

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Stride

(

const Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > &

other

)

[inline]

Copy constructor

Definition at line 71 of file Stride.h.

      : m_outer(other.outer()), m_inner(other.inner())
    {}

---

Member Function Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>

EIGEN_DEVICE_FUNC Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::inner

(

)

const [inline]

Returns:

the inner stride

Definition at line 80 of file Stride.h.

{ return m_inner.value(); }

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>

EIGEN_DEVICE_FUNC Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::outer

(

)

const [inline]

Returns:

the outer stride

Definition at line 77 of file Stride.h.

{ return m_outer.value(); }

---

Member Data Documentation

template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>

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

Definition at line 84 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 83 of file Stride.h.

---

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

• Stride.h