This file is indexed.

/usr/include/trilinos/Isorropia_EpetraPartitioner.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.

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
//@HEADER
/*
************************************************************************

              Isorropia: Partitioning and Load Balancing Package
                Copyright (2006) Sandia Corporation

Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
license for use of this work by or on behalf of the U.S. Government.

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA

************************************************************************
*/
//@HEADER

#ifndef _Isorropia_EpetraPartitioner_hpp_
#define _Isorropia_EpetraPartitioner_hpp_


/*! \file Isorropia_EpetraPartitioner.hpp
 *
 * \brief Contains functionality used for partitioning Epetra
 * matrices, maps, multivectors, etc.
 */

/** \example matrix_1.cpp
 *
 * This example demonstrates creating a balanced copy of Epetra_CrsGraph and 
 * Epetra_CrsMatrix objects using Isorropia::Epetra::createBalancedCopy functions.
 *
 */

/** \example geometric/example_rcb.cpp
 *
 * This example shows how to use geometric partitioning methods with multivectors.
 *
 */

/** \example vert_weights.cpp
 *
 * This example shows how to use graph partitioning methods with vertex weights.
 *
 */

/** \example graphedge_weights.cpp
 *
 * This example shows how to use graph partitioning methods with edge weights.
 *
 */

/** \example hgedge_weights.cpp
 *
 * This example shows how to use hypergraph partitioning methods with hyperedge weights.
 *
 */

/** \example part_redist.cpp
 *
 * This example demonstrates repartitioning and redistributing the
 * contents of an Epetra_LinearProblem object, using the Isorropia::Partitioner
 * and Isorropia::Redistributor classes. This program does not use
 * user-specified weights/costs.
 *
 */



#include <Isorropia_ConfigDefs.hpp>
#include <Teuchos_RCP.hpp>
#include <Teuchos_ParameterList.hpp>

#include <Isorropia_EpetraCostDescriber.hpp>
#include <Isorropia_EpetraOperator.hpp>
#include <Isorropia_Partitioner.hpp>

#ifdef HAVE_EPETRA
class Epetra_Map;
class Epetra_BlockMap;
class Epetra_Import;
class Epetra_Vector;
class Epetra_MultiVector;
class Epetra_CrsGraph;
class Epetra_CrsMatrix;
class Epetra_RowMatrix;
class Epetra_LinearProblem;

namespace Isorropia {

namespace Epetra {
  class CostDescriber;

/** An implementation of the Partitioner interface that operates on
    Epetra matrices and linear systems.

\ingroup partitioning_grp partitioning_rcp_grp partitioning_ptr_grp
*/

class Partitioner : public Isorropia::Partitioner, public Isorropia::Epetra::Operator  {
public:
  
  /** @ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_CrsGraph> inputGraph,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),  
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_CrsGraph *inputGraph,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),  
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_CrsGraph> inputGraph,
              Teuchos::RCP<CostDescriber> costs,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_CrsGraph *inputGraph,
              CostDescriber* costs,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_RowMatrix> inputMatrix,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_RowMatrix *inputMatrix,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_RowMatrix> inputMatrix,
              Teuchos::RCP<CostDescriber> costs,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_RowMatrix *inputMatrix,
              CostDescriber *costs,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_MultiVector> coords,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_MultiVector *coords,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** 
      \ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_MultiVector> coords,
              Teuchos::RCP<const Epetra_MultiVector> weights,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_MultiVector *coords,
              const Epetra_MultiVector *weights,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_BlockMap> inputMap,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_BlockMap *inputMap,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_CrsGraph> inputGraph,
	      Teuchos::RCP<const Epetra_MultiVector> coords,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_CrsGraph *inputGraph,
	      const Epetra_MultiVector *coords,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);
  

  /** @ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_CrsGraph> inputGraph,
              Teuchos::RCP<CostDescriber> costs,
	      Teuchos::RCP<const Epetra_MultiVector> coords,
              Teuchos::RCP<const Epetra_MultiVector> weights,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_CrsGraph *inputGraph,
              CostDescriber *costs,
	      const Epetra_MultiVector *coords,
              const Epetra_MultiVector *weights,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_RowMatrix> inputMatrix,
	      Teuchos::RCP<const Epetra_MultiVector> coords,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_RowMatrix *inputMatrix,
	      const Epetra_MultiVector *coords,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_rcp_grp 
  */
  Partitioner(Teuchos::RCP<const Epetra_RowMatrix> inputMatrix,
              Teuchos::RCP<CostDescriber> costs,
	      Teuchos::RCP<const Epetra_MultiVector> coords,
              Teuchos::RCP<const Epetra_MultiVector> weights,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);

  /** @ingroup partitioning_ptr_grp 
  */
  Partitioner(const Epetra_RowMatrix *inputMatrix,
              CostDescriber *costs,
	      const Epetra_MultiVector *coords,
              const Epetra_MultiVector *weights,
              const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
              bool compute_partitioning_now=true);


  /** @ingroup partitioning_grp
      Destructor 
  */
  virtual ~Partitioner();

   /* @ingroup partitioning_grp
    * Set the relative number of objects in each part.  The default is to
    * evenly divide objects across parts.  The numbers can be fractions of
    * one, or whole numbers.  Zoltan adds the values supplied and takes the sizes
    * as proportional to that whole.
    *
    * We make a copy of id and size lists.
    *
    * Caller should supply either global part IDs or local part IDs.
    * Part IDs are integers beginning at zero for the first part.
    *
    * No communication is done during this call.  One process can make the call
    * for all parts, or many processes can make the call.  Zoltan checks the
    * consistency of the information provided.
    */

  void setPartSizes(int len, int *global_part_id, float *part_size);

  /* @ingroup partitioning_grp
   * Free the memory allocated to store part sizes.
   */
  void clearPartSizes();

  /** @ingroup partitioning_grp 
      partition is the method that computes 
       a rebalanced partitioning for the data in the object
      that this class was constructed with.

      \param force_repartitioning Optional argument defaults to false. By
         default, compute_partitioning() only does anything the first time
         it is called, and subsequent repeated calls are no-ops. If the user's
         intent is to re-compute the partitioning (e.g., if parameters
         or other inputs have been changed), then setting this flag to
         true will force a new partitioning to be computed.
   */
  void partition(bool force_repartitioning=false);

  /** @ingroup partitioning_grp
   */
  virtual void compute(bool forceRecomputing=false);

  /** @ingroup partitioning_grp
   */
  int numElemsInPart(int part) const {
    return (numElemsWithProperty(part));
  }

  /** @ingroup partitioning_grp
   */
  void elemsInPart(int part, int* elementList, int len) const {
    elemsWithProperty(part, elementList, len);
  }

  /** @ingroup partitioning_rcp_grp
      Create a new @c Epetra_Map corresponding to the new partition.

      This method is essentially used by the
      Isorropia::Epetra::Redistributor object.

      \return @c Epetra_Map that contains the new distribution of elements.

      \pre The number of parts might be the same or lower than the
      number of processors.
  */
  Teuchos::RCP<Epetra_Map> createNewMap();

  /** @ingroup partitioning_ptr_grp
      Create a new @c Epetra_Map corresponding to the new partition.

      This method is essentially used by the
      Isorropia::Epetra::Redistributor object.

      \param[out] outputMap @c Epetra_Map that contains the new distribution of elements.

      \pre The number of parts might be the same or lower than the
      number of processors.
  */
  void createNewMap(Epetra_Map *&outputMap);

private:
  int *partGIDs;
  float *partSizes;
  int numPartSizes;

};//class Partitioner

}//namespace Epetra
}//namespace Isorropia

#endif //HAVE_EPETRA

#endif