compbio
Public Types | Public Member Functions | Protected Attributes | List of all members
Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime > Class Template Reference
Dense matrix and array manipulation » Reference » Core_Module

Holds strides information for Map. More...

#include <Stride.h>

Public Types

enum  { InnerStrideAtCompileTime = _InnerStrideAtCompileTime, OuterStrideAtCompileTime = _OuterStrideAtCompileTime }
 
typedef Eigen::Index Index
 

Public Member Functions

EIGEN_DEVICE_FUNC Stride ()
 Default constructor, for use when strides are fixed at compile time.
 
EIGEN_DEVICE_FUNC Stride (Index outerStride, Index innerStride)
 Constructor allowing to pass the strides at runtime.
 
EIGEN_DEVICE_FUNC Stride (const Stride &other)
 Copy constructor.
 
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
_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 


Member Typedef Documentation



§ Index








template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime> 

      

        

          typedef Eigen::Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::Index
        

      




Deprecated:
since Eigen 3.3 







Member Function Documentation



§ inner()








template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime> 



  

  
      

        

          EIGEN_DEVICE_FUNC Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::inner 
          (
          )
           const
        

      

  		
  
inline  
  






Returns
the inner stride 








§ outer()








template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime> 



  

  
      

        

          EIGEN_DEVICE_FUNC Index Eigen::Stride< _OuterStrideAtCompileTime, _InnerStrideAtCompileTime >::outer 
          (
          )
           const
        

      

  		
  
inline  
  






Returns
the outer stride 







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





Generated by  
doxygen
 1.8.12