Michael Ernst Peter / Eigen

src/Core/Stride.h@1:3b8049da21b8, 2019-09-24 (annotated)

Committer:
jsoh91
Date:
Tue Sep 24 00:18:23 2019 +0000
Revision:
1:3b8049da21b8
Parent:
0:13a5d365ba16 
ignore and revise some of error parts

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ykuroda 0:13a5d365ba16 1 // This file is part of Eigen, a lightweight C++ template library
ykuroda 0:13a5d365ba16 2 // for linear algebra.
ykuroda 0:13a5d365ba16 3 //
ykuroda 0:13a5d365ba16 4 // Copyright (C) 2010 Benoit Jacob <jacob.benoit.1@gmail.com>
ykuroda 0:13a5d365ba16 5 //
ykuroda 0:13a5d365ba16 6 // This Source Code Form is subject to the terms of the Mozilla
ykuroda 0:13a5d365ba16 7 // Public License v. 2.0. If a copy of the MPL was not distributed
ykuroda 0:13a5d365ba16 8 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
ykuroda 0:13a5d365ba16 9
ykuroda 0:13a5d365ba16 10 #ifndef EIGEN_STRIDE_H
ykuroda 0:13a5d365ba16 11 #define EIGEN_STRIDE_H
ykuroda 0:13a5d365ba16 12
ykuroda 0:13a5d365ba16 13 namespace Eigen {
ykuroda 0:13a5d365ba16 14
ykuroda 0:13a5d365ba16 15 /** \class Stride
ykuroda 0:13a5d365ba16 16 * \ingroup Core_Module
ykuroda 0:13a5d365ba16 17 *
ykuroda 0:13a5d365ba16 18 * \brief Holds strides information for Map
ykuroda 0:13a5d365ba16 19 *
ykuroda 0:13a5d365ba16 20 * This class holds the strides information for mapping arrays with strides with class Map.
ykuroda 0:13a5d365ba16 21 *
ykuroda 0:13a5d365ba16 22 * It holds two values: the inner stride and the outer stride.
ykuroda 0:13a5d365ba16 23 *
ykuroda 0:13a5d365ba16 24 * The inner stride is the pointer increment between two consecutive entries within a given row of a
ykuroda 0:13a5d365ba16 25 * row-major matrix or within a given column of a column-major matrix.
ykuroda 0:13a5d365ba16 26 *
ykuroda 0:13a5d365ba16 27 * The outer stride is the pointer increment between two consecutive rows of a row-major matrix or
ykuroda 0:13a5d365ba16 28 * between two consecutive columns of a column-major matrix.
ykuroda 0:13a5d365ba16 29 *
ykuroda 0:13a5d365ba16 30 * These two values can be passed either at compile-time as template parameters, or at runtime as
ykuroda 0:13a5d365ba16 31 * arguments to the constructor.
ykuroda 0:13a5d365ba16 32 *
ykuroda 0:13a5d365ba16 33 * Indeed, this class takes two template parameters:
ykuroda 0:13a5d365ba16 34 * \param _OuterStrideAtCompileTime the outer stride, or Dynamic if you want to specify it at runtime.
ykuroda 0:13a5d365ba16 35 * \param _InnerStrideAtCompileTime the inner stride, or Dynamic if you want to specify it at runtime.
ykuroda 0:13a5d365ba16 36 *
ykuroda 0:13a5d365ba16 37 * Here is an example:
ykuroda 0:13a5d365ba16 38 * \include Map_general_stride.cpp
ykuroda 0:13a5d365ba16 39 * Output: \verbinclude Map_general_stride.out
ykuroda 0:13a5d365ba16 40 *
ykuroda 0:13a5d365ba16 41 * \sa class InnerStride, class OuterStride, \ref TopicStorageOrders
ykuroda 0:13a5d365ba16 42 */
ykuroda 0:13a5d365ba16 43 template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime>
ykuroda 0:13a5d365ba16 44 class Stride
ykuroda 0:13a5d365ba16 45 {
ykuroda 0:13a5d365ba16 46 public:
ykuroda 0:13a5d365ba16 47 typedef DenseIndex Index;
ykuroda 0:13a5d365ba16 48 enum {
ykuroda 0:13a5d365ba16 49 InnerStrideAtCompileTime = _InnerStrideAtCompileTime,
ykuroda 0:13a5d365ba16 50 OuterStrideAtCompileTime = _OuterStrideAtCompileTime
ykuroda 0:13a5d365ba16 51 };
ykuroda 0:13a5d365ba16 52
ykuroda 0:13a5d365ba16 53 /** Default constructor, for use when strides are fixed at compile time */
ykuroda 0:13a5d365ba16 54 Stride()
ykuroda 0:13a5d365ba16 55 : m_outer(OuterStrideAtCompileTime), m_inner(InnerStrideAtCompileTime)
ykuroda 0:13a5d365ba16 56 {
ykuroda 0:13a5d365ba16 57 eigen_assert(InnerStrideAtCompileTime != Dynamic && OuterStrideAtCompileTime != Dynamic);
ykuroda 0:13a5d365ba16 58 }
ykuroda 0:13a5d365ba16 59
ykuroda 0:13a5d365ba16 60 /** Constructor allowing to pass the strides at runtime */
ykuroda 0:13a5d365ba16 61 Stride(Index outerStride, Index innerStride)
ykuroda 0:13a5d365ba16 62 : m_outer(outerStride), m_inner(innerStride)
ykuroda 0:13a5d365ba16 63 {
ykuroda 0:13a5d365ba16 64 eigen_assert(innerStride>=0 && outerStride>=0);
ykuroda 0:13a5d365ba16 65 }
ykuroda 0:13a5d365ba16 66
ykuroda 0:13a5d365ba16 67 /** Copy constructor */
ykuroda 0:13a5d365ba16 68 Stride(const Stride& other)
ykuroda 0:13a5d365ba16 69 : m_outer(other.outer()), m_inner(other.inner())
ykuroda 0:13a5d365ba16 70 {}
ykuroda 0:13a5d365ba16 71
ykuroda 0:13a5d365ba16 72 /** \returns the outer stride */
ykuroda 0:13a5d365ba16 73 inline Index outer() const { return m_outer.value(); }
ykuroda 0:13a5d365ba16 74 /** \returns the inner stride */
ykuroda 0:13a5d365ba16 75 inline Index inner() const { return m_inner.value(); }
ykuroda 0:13a5d365ba16 76
ykuroda 0:13a5d365ba16 77 protected:
ykuroda 0:13a5d365ba16 78 internal::variable_if_dynamic<Index, OuterStrideAtCompileTime> m_outer;
ykuroda 0:13a5d365ba16 79 internal::variable_if_dynamic<Index, InnerStrideAtCompileTime> m_inner;
ykuroda 0:13a5d365ba16 80 };
ykuroda 0:13a5d365ba16 81
ykuroda 0:13a5d365ba16 82 /** \brief Convenience specialization of Stride to specify only an inner stride
ykuroda 0:13a5d365ba16 83 * See class Map for some examples */
ykuroda 0:13a5d365ba16 84 template<int Value = Dynamic>
ykuroda 0:13a5d365ba16 85 class InnerStride : public Stride<0, Value>
ykuroda 0:13a5d365ba16 86 {
ykuroda 0:13a5d365ba16 87 typedef Stride<0, Value> Base;
ykuroda 0:13a5d365ba16 88 public:
ykuroda 0:13a5d365ba16 89 typedef DenseIndex Index;
ykuroda 0:13a5d365ba16 90 InnerStride() : Base() {}
ykuroda 0:13a5d365ba16 91 InnerStride(Index v) : Base(0, v) {}
ykuroda 0:13a5d365ba16 92 };
ykuroda 0:13a5d365ba16 93
ykuroda 0:13a5d365ba16 94 /** \brief Convenience specialization of Stride to specify only an outer stride
ykuroda 0:13a5d365ba16 95 * See class Map for some examples */
ykuroda 0:13a5d365ba16 96 template<int Value = Dynamic>
ykuroda 0:13a5d365ba16 97 class OuterStride : public Stride<Value, 0>
ykuroda 0:13a5d365ba16 98 {
ykuroda 0:13a5d365ba16 99 typedef Stride<Value, 0> Base;
ykuroda 0:13a5d365ba16 100 public:
ykuroda 0:13a5d365ba16 101 typedef DenseIndex Index;
ykuroda 0:13a5d365ba16 102 OuterStride() : Base() {}
ykuroda 0:13a5d365ba16 103 OuterStride(Index v) : Base(v,0) {}
ykuroda 0:13a5d365ba16 104 };
ykuroda 0:13a5d365ba16 105
ykuroda 0:13a5d365ba16 106 } // end namespace Eigen
ykuroda 0:13a5d365ba16 107
ykuroda 0:13a5d365ba16 108 #endif // EIGEN_STRIDE_H