This file is indexed.

/usr/include/dune/common/parallel/interface.hh is in libdune-common-dev 2.2.1-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
// $Id$
#ifndef DUNE_INTERFACE_HH
#define DUNE_INTERFACE_HH

#if HAVE_MPI

#include"remoteindices.hh"
#include<dune/common/enumset.hh>

namespace Dune
{
 /** @addtogroup Common_Parallel
   *
   * @{
   */
  /**
   * @file
   * @brief Provides classes for building the communication
   * interface between remote indices.
   * @author Markus Blatt
   */

  /** @} */
  /**
   * @brief Base class of all classes representing a communication
   * interface.
   *
   * It provides an generic utility method for building the interface
   * for a set of remote indices.
   */
  class InterfaceBuilder
  {
  public: 
    class RemotexIndicesStateError : public Exception
    {};
        
    virtual ~InterfaceBuilder()
    {}

  protected:
    /**
     * @brief Not for public use.
     */
    InterfaceBuilder()
    {}
    
    /**
     * @brief Builds the interface between remote processes.
     *
     * 
     * The types T1 and T2 are classes representing a set of 
     * enumeration values of type InterfaceBuilder::Attribute. They have to provide
     * a (static) method
     * \code
     * bool contains(Attribute flag) const;
     * \endcode
     * for checking whether the set contains a specfic flag. 
     * This functionality is for example provided the classes
     * EnumItem, EnumRange and Combine.
     *
     * If the template parameter send is true the sending side of
     * the interface will be built, otherwise the information for
     * receiving will be built.
     *
     *
     * If the template parameter send is true we create interface for sending
     * in a forward communication.
     *
     * @param remoteIndices The indices known to remote processes.
     * @param sourceFlags The set of flags marking source indices.
     * @param destFlags The setof flags markig destination indices.
     * @param functor A functor for callbacks. It should provide the
     * following methods:
     * \code
     * // Reserve memory for the interface to processor proc. The interface
     * // has to hold size entries
     * void reserve(int proc, int size);
     * 
     * // Add an entry to the interface
     * // We will send/receive size entries at index local to process proc
     * void add(int proc, int local);
     * \endcode
     */
    template<class R, class T1, class T2, class Op, bool send>
    void buildInterface (const R& remoteIndices, 
			 const T1& sourceFlags, const T2& destFlags,
			 Op& functor) const;
  };
  
  /**
   * @brief Information describing an interface.
   *
   * This class is used for temporary gathering information
   * about the interface needed for actually building it. It
   * is used be class Interface as functor for InterfaceBuilder::build.
   */
  class InterfaceInformation
  {
    
  public:
    
    /**
     * @brief Get the number of entries in the interface.
     */
    size_t size() const
    {
      return size_;
    }
    /**
     * @brief Get the local index for an entry.
     * @param i The  index of the entry.
     */
    std::size_t& operator[](size_t i)
    {
      assert(i<size_);
      return indices_[i];
    }
    /**
     * @brief Get the local index for an entry.
     * @param i The  index of the entry.
     */
    std::size_t operator[](size_t i) const
    {
      assert(i<size_);
      return indices_[i];
    }
    /**
     * @brief Reserve space for a number of entries.
     * @param size The maximum number of entries to hold.
     */
    void reserve(size_t size)
    {
      indices_ = new std::size_t[size];
      maxSize_ = size;
      
    }
    /**
     * brief Frees allocated memory.
     */
    void free()
    {
      if(indices_)
	delete[] indices_;
      maxSize_ = 0;
      size_=0;
      indices_=0;
    }
    /**
     * @brief Add a new index to the interface.
     */
    void add(std::size_t index)
    {
      assert(size_<maxSize_);
      indices_[size_++]=index;
    }
    
    InterfaceInformation() 
      : size_(0), maxSize_(0), indices_(0)
    {}
    
    virtual ~InterfaceInformation()
    {
    }

    bool operator!=(const InterfaceInformation& o) const
    {
      return !operator==(o);
    }
    
    bool operator==(const InterfaceInformation& o) const
    {
      if(size_!=o.size_)
	return false;
      for(std::size_t i=0; i< size_; ++i)
	if(indices_[i]!=o.indices_[i])
	  return false;
      return true;
    }
    
  private:
    /**
     * @brief The number of entries in the interface.
     */
    size_t size_;
    /**
     * @brief The maximum number of indices we can hold.
     */
    size_t maxSize_;
    /**
     * @brief The local indices of the interface.
     */
    std::size_t* indices_;
  };

  /** @addtogroup Common_Parallel
   *
   * @{
   */

  /**
   * @brief Communication interface between remote and local indices.
   *
   * Describes the communication interface between
   * indices on the local process and those on remote processes.
   */
  class Interface : public InterfaceBuilder
  {
    
  public:
    typedef InterfaceInformation Information;

    typedef std::map<int,std::pair<Information,Information> > InformationMap;

    /**
     * @brief Builds the interface.
     *
     * The types T1 and T2 are classes representing a set of 
     * enumeration values of type Interface::Attribute. They have to provide
     * a (static) method
     * \code
     * bool contains(Attribute flag) const;
     * \endcode
     * for checking whether the set contains a specfic flag. 
     * This functionality is for example provided the classes
     * EnumItem, EnumRange and Combine.
     * @param remoteIndices The indices known to remote processes.
     * @param sourceFlags The set of flags marking indices we send from.
     * @param destFlags The set of flags marking indices we receive for.
     */
    template<typename R, typename T1, typename T2>
    void build(const R& remoteIndices, const T1& sourceFlags, 
	       const T2& destFlags);

    /**
     * @brief Frees memory allocated during the build.
     */
    void free();

    /**
     * @brief Get the MPI Communicator.
     */
    MPI_Comm communicator() const;

    /**
     * @brief Get information about the interfaces.
     *
     * @return Map of the interfaces.
     * The key of the map is the process number and the value
     * is the information pair (first the send and then the receive
     * information).
     */   
    const InformationMap& interfaces() const;
    
    Interface(MPI_Comm comm)
      : communicator_(comm), interfaces_()
    {}
  
    Interface()
      : communicator_(MPI_COMM_NULL), interfaces_()
    {}
    
    /**
     * @brief Print the interface to std::out for debugging.
     */
    void print() const;

    bool operator!=(const Interface& o) const
    {
      return ! operator==(o);
    }
    
    bool operator==(const Interface& o) const
    {
      if(communicator_!=o.communicator_)
	return false;
      if(interfaces_.size()!=o.interfaces_.size())
	return false;
      typedef InformationMap::const_iterator MIter;
      
      for(MIter m=interfaces_.begin(), om=o.interfaces_.begin();
	  m!=interfaces_.end(); ++m, ++om)
	{
	  if(om->first!=m->first)
	    return false;
	  if(om->second.first!=om->second.first)
	    return false;
	  if(om->second.second!=om->second.second)
	    return false;
	}
      return true;
    }
      
    /**
     * @brief Destructor.
     */
    virtual ~Interface();

    void strip();
  protected:
    
    /**
     * @brief Get information about the interfaces.
     *
     * @return Map of the interfaces.
     * The key of the map is the process number and the value
     * is the information pair (first the send and then the receive
     * information).
     */   
    InformationMap& interfaces();

    /** @brief The MPI communicator we use. */
    MPI_Comm communicator_;
        
  private:
    /**
     * @brief Information about the interfaces.
     *
     * The key of the map is the process number and the value
     * is the information pair (first the send and then the receive
     * information).
     */
    InformationMap interfaces_;
    
    template<bool send>
    class InformationBuilder
    {
    public:
      InformationBuilder(InformationMap& interfaces)
	: interfaces_(interfaces)
      {}
      
      void reserve(int proc, int size)
      {
	if(send)
	  interfaces_[proc].first.reserve(size);
	else
	  interfaces_[proc].second.reserve(size);
      }
      void add(int proc, std::size_t local)
      {
	if(send){
	  interfaces_[proc].first.add(local);
	}else{
	  interfaces_[proc].second.add(local);
	}
      }
      
    private:
      InformationMap& interfaces_;
    };
  };
  
  template<class R, class T1, class T2, class Op, bool send>
  void InterfaceBuilder::buildInterface(const R& remoteIndices, const T1& sourceFlags, const T2& destFlags, Op& interfaceInformation) const
  {

    if(!remoteIndices.isSynced())
      DUNE_THROW(RemotexIndicesStateError,"RemoteIndices is not in sync with the index set. Call RemoteIndices::rebuild first!");
    // Allocate the memory for the data type construction.
    typedef R RemoteIndices;
    typedef typename RemoteIndices::RemoteIndexMap::const_iterator const_iterator;

    const const_iterator end=remoteIndices.end();
    
    int rank;
    
    MPI_Comm_rank(remoteIndices.communicator(), &rank);
    
    // Allocate memory for the type construction.
    for(const_iterator process=remoteIndices.begin(); process != end; ++process){
      // Messure the number of indices send to the remote process first
      int size=0;
      typedef typename RemoteIndices::RemoteIndexList::const_iterator RemoteIterator;
      const RemoteIterator remoteEnd = send ? process->second.first->end() : 
	process->second.second->end();
      RemoteIterator remote = send ? process->second.first->begin() : process->second.second->begin();
	
      while(remote!=remoteEnd){
	  if( send ?  destFlags.contains(remote->attribute()) :
	      sourceFlags.contains(remote->attribute())){

              // do we send the index?
            if( send ? sourceFlags.contains(remote->localIndexPair().local().attribute()) :
                destFlags.contains(remote->localIndexPair().local().attribute()))
                ++size;
          }
          ++remote;
      }
      interfaceInformation.reserve(process->first, size);
    }

    // compare the local and remote indices and set up the types
    
    for(const_iterator process=remoteIndices.begin(); process != end; ++process){
      typedef typename RemoteIndices::RemoteIndexList::const_iterator RemoteIterator;
      const RemoteIterator remoteEnd = send ? process->second.first->end() : 
	process->second.second->end();
      RemoteIterator remote = send ? process->second.first->begin() : process->second.second->begin();
	
      while(remote!=remoteEnd){
	  if( send ?  destFlags.contains(remote->attribute()) :
	      sourceFlags.contains(remote->attribute())){
              // do we send the index?
            if( send ? sourceFlags.contains(remote->localIndexPair().local().attribute()) :
                destFlags.contains(remote->localIndexPair().local().attribute()))
              interfaceInformation.add(process->first,remote->localIndexPair().local().local());
          }
          ++remote;
      }
    }
  }
  
  inline MPI_Comm Interface::communicator() const
  {
    return communicator_;
    
  }
  
  
  inline const std::map<int,std::pair<InterfaceInformation,InterfaceInformation> >& Interface::interfaces() const
  {
    return interfaces_;
  }

  inline std::map<int,std::pair<InterfaceInformation,InterfaceInformation> >& Interface::interfaces()
  {
    return interfaces_;
  }

  inline void Interface::print() const
  {
    typedef InformationMap::const_iterator const_iterator;
    const const_iterator end=interfaces_.end();
    int rank;
    MPI_Comm_rank(communicator(), &rank);
    
    for(const_iterator infoPair=interfaces_.begin(); infoPair!=end; ++infoPair){
      {
	std::cout<<rank<<": send for process "<<infoPair->first<<": ";
	const InterfaceInformation& info(infoPair->second.first);
	for(size_t i=0; i < info.size(); i++)
	  std::cout<<info[i]<<" ";
	std::cout<<std::endl;
      }{
	
	std::cout<<rank<<": receive for process "<<infoPair->first<<": ";
	const InterfaceInformation& info(infoPair->second.second);
	for(size_t i=0; i < info.size(); i++)
	  std::cout<<info[i]<<" ";
	std::cout<<std::endl;
      }
      
    }
  }
  
  template<typename R, typename T1, typename T2>
  inline void Interface::build(const R& remoteIndices, const T1& sourceFlags, 
			  const T2& destFlags)
  {
    communicator_=remoteIndices.communicator();
    
    assert(interfaces_.empty());

    // Build the send interface
    InformationBuilder<true> sendInformation(interfaces_);
    this->template buildInterface<R,T1,T2,InformationBuilder<true>,true>(remoteIndices, sourceFlags, 
							      destFlags, sendInformation);
    
    // Build the receive interface
    InformationBuilder<false> recvInformation(interfaces_);
    this->template buildInterface<R,T1,T2,InformationBuilder<false>,false>(remoteIndices,sourceFlags, 
								destFlags, recvInformation);
    strip();
  }
  inline void Interface::strip()
  {
    typedef InformationMap::iterator const_iterator;
    for(const_iterator interfacePair = interfaces_.begin(); interfacePair != interfaces_.end();)
      if(interfacePair->second.first.size()==0 && interfacePair->second.second.size()==0){
	interfacePair->second.first.free();
	interfacePair->second.second.free();
	const_iterator toerase=interfacePair++;
	interfaces_.erase(toerase);
      }else
	++interfacePair;
  }
  
  inline void Interface::free()
  {
    typedef InformationMap::iterator iterator;
    typedef InformationMap::const_iterator const_iterator;
    const const_iterator end = interfaces_.end();
    for(iterator interfacePair = interfaces_.begin(); interfacePair != end; ++interfacePair){
      interfacePair->second.first.free();
      interfacePair->second.second.free();
    }
    interfaces_.clear();
  }

  inline Interface::~Interface()
  {
    free();
  }
  /** @} */
}

namespace std
{
  inline ostream& operator<<(ostream& os, const Dune::Interface& interface)
  {
    typedef Dune::Interface::InformationMap InfoMap;
    typedef InfoMap::const_iterator Iter;
    for(Iter i=interface.interfaces().begin(), end = interface.interfaces().end();
	i!=end; ++i)
      {
	os<<i->first<<": [ source=[";
	for(std::size_t j=0; j < i->second.first.size(); ++j)
	  os<<i->second.first[j]<<" ";
	os<<"] size="<<i->second.first.size()<<", target=[";
	for(std::size_t j=0; j < i->second.second.size(); ++j)
	  os<<i->second.second[j]<<" ";
	os<<"] size="<<i->second.second.size()<<"\n";
      }
    return os;
  }
}// end namespace std
#endif // HAVE_MPI

#endif