File: SparseGridIterator.h

package info (click to toggle)
stopt 5.12%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 8,860 kB
  • sloc: cpp: 70,456; python: 5,950; makefile: 72; sh: 57
file content (190 lines) | stat: -rw-r--r-- 7,164 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// Copyright (C) 2016 EDF
// All Rights Reserved
// This code is published under the GNU Lesser General Public License (GNU LGPL)
#ifndef SPARSEGRIDITERATOR_H
#define SPARSEGRIDITERATOR_H
#include <Eigen/Dense>
#include <StOpt/core/grids/GridIterator.h>
#include "StOpt/core/sparse/sparseGridTypes.h"
#include "StOpt/core/sparse/sparseGridCommon.h"

/**  \file SparseGridIterator.h
 *   \brief Defines an iterator on the points of a  sparse  grid
 *   \author Xavier Warin
 */
namespace StOpt
{

/// \class  SparseGridIterator  SparseGridIterator.h
///    Iterator on a given grid
class SparseGridIterator : public GridIterator
{

protected :

    std::shared_ptr<SparseSet>  m_dataSet; ///< Data structure for sparse grid
    SparseSet::const_iterator m_iterLevelFirst ; ///< Iterator for first level to be treated
    SparseSet::const_iterator m_iterLevelLast  ; ///< Iterator for first level not treated
    SparseSet::const_iterator m_iterLevel ; ///< Iterator for the  level of the grid
    SparseLevel::const_iterator m_iterPosition ; ///< Iterator for the position of the point in the grid
    int m_posIter ; ///< integer for position in the iterator
    int m_firstPosIter ; ///< first point to treat
    int m_lastPosIter ; ///< last point not to treat (default is size of m_dataSet)
    bool m_bValid ; ///< true if the iterator is valid
    int m_jumpInit ; ///< initial jump

    /// \brief number of points
    inline int  getPointNumber() const
    {
        int nbPt = 0;
        for (SparseSet::const_iterator iterLevel =  m_iterLevelFirst; iterLevel !=  m_iterLevelLast; ++iterLevel)
            nbPt += iterLevel->second.size();
        return nbPt ;
    }

    /// \brief Increment iterators
    /// \param p_jump   increment of the iterator
    inline void incrementIterator(const int &p_jump)
    {
        int iJump = 0;
        SparseSet::const_iterator iterLevel;
        SparseLevel::const_iterator iterPosition;
        int bJumpLevel = false;
        for (iterLevel = m_iterLevel; iterLevel != m_iterLevelLast; ++iterLevel, bJumpLevel = true)
        {
            if (bJumpLevel)
                m_iterPosition = iterLevel->second.begin();
            for (iterPosition = m_iterPosition;  iterPosition != iterLevel->second.end(); ++iterPosition)
            {
                iJump += 1;
                if (iJump > p_jump)
                {
                    break;
                }
                else
                    m_posIter += 1 ;

            }
            if (iJump > p_jump)
                break;
        }
        m_iterLevel = iterLevel;
        m_iterPosition = iterPosition;

        if (m_posIter >= m_lastPosIter)
        {
            m_bValid = false;
        }
    }

public :

    /// \brief default constructor
    SparseGridIterator() {}

    /// \brief Constructor
    /// \param p_dataSet    data structure for mesh
    SparseGridIterator(const  std::shared_ptr<SparseSet>   &p_dataSet) : m_dataSet(p_dataSet),  m_iterLevelFirst(m_dataSet->begin()), m_iterLevelLast(m_dataSet->end()),
        m_iterLevel(m_dataSet->begin()), m_iterPosition(m_iterLevel->second.begin()), m_posIter(0),
        m_firstPosIter(0), m_lastPosIter(getPointNumber()),
        m_bValid(true), m_jumpInit(0)
    {}

    /// \brief Constructor with jump
    ///  Permits to iterate jumping some values (parallel mode)
    /// \param p_dataSet    data structure for mesh
    /// \param p_jump              increment jump for iterator
    SparseGridIterator(const  std::shared_ptr<SparseSet>   &p_dataSet, const int &p_jump) :
        m_dataSet(p_dataSet), m_iterLevelFirst(m_dataSet->begin()), m_iterLevelLast(m_dataSet->end()), m_iterLevel(m_dataSet->begin()),
        m_iterPosition(m_iterLevel->second.begin()), m_posIter(0), m_firstPosIter(0), m_lastPosIter(getPointNumber()), m_bValid(true), m_jumpInit(p_jump)
    {
        incrementIterator(p_jump);
    }

    /// \brief Constructor for iterator only for the points of a given multi level
    /// \param p_dataSet    data structure for mesh
    /// \param p_iterLevel  iterator on a multi level in the sparse grid
    SparseGridIterator(const  std::shared_ptr<SparseSet>   &p_dataSet, const SparseSet::const_iterator &p_iterLevel) :
        m_dataSet(p_dataSet), m_iterLevelFirst(p_iterLevel), m_iterLevelLast(p_iterLevel), m_iterLevel(p_iterLevel), m_iterPosition(p_iterLevel->second.begin()), m_posIter(0),
        m_firstPosIter(0), m_lastPosIter(p_iterLevel->second.size()),
        m_bValid(true), m_jumpInit(0)
    {
        m_iterLevelLast++;
    }

    /// \brief Constructor with jumpfor iterator only for the points of a given multi level
    ///  Permits to iterate jumping some values (parallel mode)
    /// \param p_dataSet    data structure for mesh
    /// \param p_iterLevel  iterator on a multi level in the sparse grid
    /// \param p_jump       increment jump for iterator
    SparseGridIterator(const  std::shared_ptr<SparseSet>   &p_dataSet, const SparseSet::const_iterator &p_iterLevel, const int &p_jump) :
        m_dataSet(p_dataSet),  m_iterLevelFirst(p_iterLevel), m_iterLevelLast(p_iterLevel),
        m_iterLevel(p_iterLevel), m_iterPosition(p_iterLevel->second.begin()), m_posIter(0), m_firstPosIter(0), m_lastPosIter(p_iterLevel->second.size()), m_bValid(true),
        m_jumpInit(p_jump)
    {
        m_iterLevelLast++;
        incrementIterator(p_jump);
    }

    /// \brief reset interpolator
    void reset()
    {
        m_iterLevel = m_iterLevelFirst;
        m_iterPosition = m_iterLevelFirst->second.begin();
        m_posIter = 0;
        m_bValid = true;
        incrementIterator(m_jumpInit);
    }

    /// \brief Permits to  jump to a given place given the number of processors (permits to use MPI and openmp)
    /// \param  p_rank    processor rank
    /// \param  p_nbProc  number of processor
    /// \param  p_jump    increment jump for iterator
    void jumpToAndInc(const int &p_rank, const int &p_nbProc, const int &p_jump)
    {
        int nbPoints = m_lastPosIter ;
        int npointPProc = (int)(nbPoints / p_nbProc);
        int nRestPoint = nbPoints % p_nbProc;
        m_firstPosIter = p_rank * npointPProc + (p_rank < nRestPoint ? p_rank : nRestPoint);
        m_lastPosIter = m_firstPosIter + npointPProc + (p_rank < nRestPoint ? 1 : 0);
        incrementIterator(m_firstPosIter + p_jump);
    }

    /// \brief Check if the iterator is valid
    bool isValid(void) const
    {
        return m_bValid ;
    }
    /// \brief iterate on point
    void next()
    {
        incrementIterator(1);
    }
    /// \brief iterate jumping some point
    /// \param p_incr  increment in the jump
    void nextInc(const int &p_incr)
    {
        incrementIterator(p_incr);
    }

    /// \brief get counter
    int getCount() const
    {
        return m_iterPosition->second;
    }

    /// \brief return relative position
    inline int getRelativePosition() const
    {
        return m_posIter -  m_firstPosIter;
    }

    /// \brief return number of points treated
    inline int getNbPointRelative() const
    {
        return  m_lastPosIter -  m_firstPosIter;
    }

};
}
#endif /* SPARSEGRIDITERATOR_H */