forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkPBGLGraphAdapter.h
476 lines (401 loc) · 15.3 KB
/
vtkPBGLGraphAdapter.h
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
/*=========================================================================
Program: Visualization Toolkit
Module: vtkPBGLGraphAdapter.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*
* Copyright (C) 2008 The Trustees of Indiana University.
* Use, modification and distribution is subject to the Boost Software
* License, Version 1.0. (See http://www.boost.org/LICENSE_1_0.txt)
*/
// .NAME vtkPBGLGraphAdapter - adapter to the Parallel Boost Graph Library (http://www.osl.iu.edu/research/pbgl)
//
// .SECTION Description
// Including this header allows you to use a vtk*Graph in Parallel BGL algorithms.
// @deprecated Not maintained as of VTK 6.2 and will be removed eventually.
#ifndef vtkPBGLGraphAdapter_h
#define vtkPBGLGraphAdapter_h
#include "vtkBoostGraphAdapter.h" // for the sequential BGL adapters
//BTX
#include <vtksys/stl/map> // required for Boost 1.54.0
#include <boost/graph/use_mpi.hpp>
#include <boost/graph/distributed/mpi_process_group.hpp>
#include <boost/graph/properties.hpp>
#include <boost/graph/parallel/container_traits.hpp>
#include <boost/property_map/parallel/local_property_map.hpp>
#include <boost/property_map/parallel/distributed_property_map.hpp>
#include <boost/serialization/base_object.hpp>
#include <boost/functional/hash.hpp>
//ETX
#include "vtkPBGLDistributedGraphHelper.h"
#include "vtkVariantBoostSerialization.h"
namespace boost {
// Define specializations of class template property_map for
// vtkDirectedGraph and vtkUndirectedGraph, based on the
// specialization for vtkGraph.
#define SUBCLASS_PROPERTY_MAP_SPECIALIZATIONS(Property) \
template<> \
struct property_map<vtkDirectedGraph *, Property> \
: property_map<vtkGraph *, Property> { }; \
\
template<> \
struct property_map<vtkUndirectedGraph *, Property> \
: property_map<vtkGraph *, Property> { }; \
\
template<> \
struct property_map<vtkDirectedGraph * const, Property> \
: property_map<vtkGraph *, Property> { }; \
\
template<> \
struct property_map<vtkUndirectedGraph * const, Property> \
: property_map<vtkGraph *, Property> { }
// Property map from a vertex descriptor to the owner of the vertex
struct vtkVertexOwnerMap
{
// Default-construct an empty (useless!) vertex-owner map
vtkVertexOwnerMap() : helper(0) { }
// Construct a vertex-owner map for a specific vtkGraph
explicit vtkVertexOwnerMap(vtkGraph* graph)
: helper(graph? graph->GetDistributedGraphHelper() : 0) { }
// The distributed graph helper that will aid in mapping vertices
// to their owners.
vtkDistributedGraphHelper *helper;
};
// Property map traits for the vertex-owner map
template<>
struct property_traits<vtkVertexOwnerMap>
{
typedef vtkIdType value_type;
typedef vtkIdType reference;
typedef vtkIdType key_type;
typedef readable_property_map_tag category;
};
// Retrieve the owner of the given vertex (the key)
inline property_traits<vtkVertexOwnerMap>::reference
get(
vtkVertexOwnerMap owner_map,
property_traits<vtkVertexOwnerMap>::key_type key)
{
return owner_map.helper->GetVertexOwner(key);
}
// State that the vertex owner property map of a vtkGraph is the
// vtkVertexOwnerMap
template<>
struct property_map<vtkGraph*, vertex_owner_t>
{
typedef vtkVertexOwnerMap type;
typedef vtkVertexOwnerMap const_type;
};
SUBCLASS_PROPERTY_MAP_SPECIALIZATIONS(vertex_owner_t);
// Retrieve the vertex-owner property map from a vtkGraph
inline vtkVertexOwnerMap
get(vertex_owner_t, vtkGraph* graph)
{
return vtkVertexOwnerMap(graph);
}
// Property map from a vertex descriptor to the local descriptor of
// the vertex
struct vtkVertexLocalMap
{
// Default-construct an empty (useless!) vertex-local map
vtkVertexLocalMap() : helper(0) { }
// Construct a vertex-local map for a specific vtkGraph
explicit vtkVertexLocalMap(vtkGraph* graph)
: helper(graph? graph->GetDistributedGraphHelper() : 0) { }
// The distributed graph helper that will aid in mapping vertices
// to their locals.
vtkDistributedGraphHelper *helper;
};
// Property map traits for the vertex-local map
template<>
struct property_traits<vtkVertexLocalMap>
{
typedef int value_type;
typedef int reference;
typedef vtkIdType key_type;
typedef readable_property_map_tag category;
};
// Retrieve the local descriptor of the given vertex (the key)
inline property_traits<vtkVertexLocalMap>::reference
get(
vtkVertexLocalMap local_map,
property_traits<vtkVertexLocalMap>::key_type key)
{
return local_map.helper->GetVertexIndex(key);
}
// State that the vertex local property map of a vtkGraph is the
// vtkVertexLocalMap
template<>
struct property_map<vtkGraph*, vertex_local_t>
{
typedef vtkVertexLocalMap type;
typedef vtkVertexLocalMap const_type;
};
SUBCLASS_PROPERTY_MAP_SPECIALIZATIONS(vertex_local_t);
// Retrieve the vertex-local property map from a vtkGraph
inline vtkVertexLocalMap
get(vertex_local_t, vtkGraph* graph)
{
return vtkVertexLocalMap(graph);
}
// Map from vertex descriptor to (owner, local descriptor)
struct vtkVertexGlobalMap
{
vtkVertexGlobalMap() : helper(0) { }
explicit vtkVertexGlobalMap(vtkGraph* graph)
: helper(graph? graph->GetDistributedGraphHelper() : 0) { }
vtkDistributedGraphHelper *helper;
};
template<>
struct property_traits<vtkVertexGlobalMap>
{
typedef std::pair<int, vtkIdType> value_type;
typedef value_type reference;
typedef vtkIdType key_type;
typedef readable_property_map_tag category;
};
inline property_traits<vtkVertexGlobalMap>::reference
get(
vtkVertexGlobalMap global_map,
property_traits<vtkVertexGlobalMap>::key_type key)
{
return std::pair<int,vtkIdType>(global_map.helper->GetVertexOwner(key),
global_map.helper->GetVertexIndex(key));
}
//
template<>
struct property_map<vtkGraph*, vertex_global_t>
{
typedef vtkVertexGlobalMap type;
typedef vtkVertexGlobalMap const_type;
};
SUBCLASS_PROPERTY_MAP_SPECIALIZATIONS(vertex_global_t);
inline vtkVertexGlobalMap
get(vertex_global_t, vtkGraph* graph)
{
return vtkVertexGlobalMap(graph);
}
// Map from edge descriptor to (owner, local descriptor)
struct vtkEdgeGlobalMap
{
vtkEdgeGlobalMap() : helper(0) { }
explicit vtkEdgeGlobalMap(vtkGraph* graph)
: helper(graph? graph->GetDistributedGraphHelper() : 0) { }
vtkDistributedGraphHelper *helper;
};
template<>
struct property_traits<vtkEdgeGlobalMap>
{
typedef std::pair<int, vtkIdType> value_type;
typedef value_type reference;
typedef vtkEdgeType key_type;
typedef readable_property_map_tag category;
};
inline property_traits<vtkEdgeGlobalMap>::reference
get(
vtkEdgeGlobalMap global_map,
property_traits<vtkEdgeGlobalMap>::key_type key)
{
return std::pair<int, vtkIdType>
(global_map.helper->GetEdgeOwner(key.Id), key.Id);
}
//
template<>
struct property_map<vtkGraph*, edge_global_t>
{
typedef vtkEdgeGlobalMap type;
typedef vtkEdgeGlobalMap const_type;
};
SUBCLASS_PROPERTY_MAP_SPECIALIZATIONS(edge_global_t);
inline vtkEdgeGlobalMap
get(edge_global_t, vtkGraph* graph)
{
return vtkEdgeGlobalMap(graph);
}
#undef SUBCLASS_PROPERTY_MAP_SPECIALIZATIONS
//===========================================================================
// Hash functions
template<>
struct hash<vtkEdgeType>
{
std::size_t operator()(const vtkEdgeType& edge) const
{
return hash_value(edge.Id);
}
};
} // namespace boost
//----------------------------------------------------------------------------
// Extract the process group from a vtkGraph
//----------------------------------------------------------------------------
namespace boost { namespace graph { namespace parallel {
template<>
struct process_group_type<vtkGraph *>
{
typedef boost::graph::distributed::mpi_process_group type;
};
template<>
struct process_group_type<vtkDirectedGraph *>
: process_group_type<vtkGraph *> { };
template<>
struct process_group_type<vtkUndirectedGraph *>
: process_group_type<vtkGraph *> { };
template<>
struct process_group_type<vtkDirectedGraph * const>
: process_group_type<vtkDirectedGraph *> { };
template<>
struct process_group_type<vtkUndirectedGraph * const>
: process_group_type<vtkUndirectedGraph *> { };
} } } // end namespace boost::graph::parallel
boost::graph::distributed::mpi_process_group process_group(vtkGraph *graph);
inline boost::graph::distributed::mpi_process_group
process_group(vtkDirectedGraph *graph)
{
return process_group(static_cast<vtkGraph *>(graph));
}
inline boost::graph::distributed::mpi_process_group
process_group(vtkUndirectedGraph *graph)
{
return process_group(static_cast<vtkGraph *>(graph));
}
//----------------------------------------------------------------------------
// Serialization support for simple VTK structures
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
template<typename Archiver>
void serialize(Archiver& ar, vtkEdgeBase& edge, const unsigned int)
{
ar & edge.Id;
}
template<typename Archiver>
void serialize(Archiver& ar, vtkOutEdgeType& edge, const unsigned int)
{
ar & boost::serialization::base_object<vtkEdgeBase>(edge)
& edge.Target;
}
template<typename Archiver>
void serialize(Archiver& ar, vtkInEdgeType& edge, const unsigned int)
{
ar & boost::serialization::base_object<vtkEdgeBase>(edge)
& edge.Source;
}
template<typename Archiver>
void serialize(Archiver& ar, vtkEdgeType& edge, const unsigned int)
{
ar & boost::serialization::base_object<vtkEdgeBase>(edge)
& edge.Source
& edge.Target;
}
//----------------------------------------------------------------------------
// Simplified tools to build distributed property maps
//----------------------------------------------------------------------------
// Description:
// A property map used as the vertex index map for distributed
// vtkGraphs. Using this index property map when building PBGL's
// vector_property_map or iterator_property_map will automatically
// make those property maps distributed. This feature is relied upon
// by several of the PBGL graph algorithms.
typedef boost::local_property_map<boost::graph::distributed::mpi_process_group,
boost::vtkVertexGlobalMap,
boost::vtkGraphIndexMap>
vtkGraphDistributedVertexIndexMap;
// Description:
// Creates the distributed vertex index property map for a vtkGraph.
inline vtkGraphDistributedVertexIndexMap
MakeDistributedVertexIndexMap(vtkGraph* graph)
{
vtkDistributedGraphHelper *helper = graph->GetDistributedGraphHelper();
if (!helper)
{
vtkErrorWithObjectMacro(graph, "A vtkGraph without a distributed graph helper is not a distributed graph");
return vtkGraphDistributedVertexIndexMap();
}
vtkPBGLDistributedGraphHelper *pbglHelper
= vtkPBGLDistributedGraphHelper::SafeDownCast(helper);
if (!pbglHelper)
{
vtkErrorWithObjectMacro(graph, "A vtkGraph with a non-Parallel BGL distributed graph helper cannot be used with the Parallel BGL");
return vtkGraphDistributedVertexIndexMap();
}
return vtkGraphDistributedVertexIndexMap(pbglHelper->GetProcessGroup(),
boost::vtkVertexGlobalMap(graph),
boost::vtkGraphIndexMap());
}
// Description:
// Retrieves the type of the distributed property map indexed by the
// vertices of a distributed graph.
template<typename DataArray>
struct vtkDistributedVertexPropertyMapType
{
typedef boost::parallel::distributed_property_map<
boost::graph::distributed::mpi_process_group,
boost::vtkVertexGlobalMap,
DataArray*> type;
};
// Description:
// Build a distributed property map indexed by the vertices of the
// given graph, using storage from the given array.
template<typename DataArray>
inline typename vtkDistributedVertexPropertyMapType<DataArray>::type
MakeDistributedVertexPropertyMap(vtkGraph* graph, DataArray* array)
{
typedef typename vtkDistributedVertexPropertyMapType<DataArray>::type MapType;
vtkDistributedGraphHelper *helper = graph->GetDistributedGraphHelper();
if (!helper)
{
vtkErrorWithObjectMacro(graph, "A vtkGraph without a distributed graph helper is not a distributed graph");
return MapType();
}
vtkPBGLDistributedGraphHelper *pbglHelper
= vtkPBGLDistributedGraphHelper::SafeDownCast(helper);
if (!pbglHelper)
{
vtkErrorWithObjectMacro(graph, "A vtkGraph with a non-Parallel BGL distributed graph helper cannot be used with the Parallel BGL");
return MapType();
}
return MapType(pbglHelper->GetProcessGroup(),
boost::vtkVertexGlobalMap(graph),
array);
}
// Description:
// Retrieves the type of the distributed property map indexed by the
// edges of a distributed graph.
template<typename DataArray>
struct vtkDistributedEdgePropertyMapType
{
typedef boost::parallel::distributed_property_map<
boost::graph::distributed::mpi_process_group,
boost::vtkEdgeGlobalMap,
DataArray*> type;
};
// Description:
// Build a distributed property map indexed by the edges of the
// given graph, using storage from the given array.
template<typename DataArray>
inline typename vtkDistributedEdgePropertyMapType<DataArray>::type
MakeDistributedEdgePropertyMap(vtkGraph* graph, DataArray* array)
{
typedef typename vtkDistributedEdgePropertyMapType<DataArray>::type MapType;
vtkDistributedGraphHelper *helper = graph->GetDistributedGraphHelper();
if (!helper)
{
vtkErrorWithObjectMacro(graph, "A vtkGraph without a distributed graph helper is not a distributed graph");
return MapType();
}
vtkPBGLDistributedGraphHelper *pbglHelper
= vtkPBGLDistributedGraphHelper::SafeDownCast(helper);
if (!pbglHelper)
{
vtkErrorWithObjectMacro(graph, "A vtkGraph with a non-Parallel BGL distributed graph helper cannot be used with the Parallel BGL");
return MapType();
}
return MapType(pbglHelper->GetProcessGroup(),
boost::vtkEdgeGlobalMap(graph),
array);
}
#endif // vtkPBGLGraphAdapter_h
// VTK-HeaderTest-Exclude: vtkPBGLGraphAdapter.h