forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkPBGLRMATGraphSource.h
183 lines (158 loc) · 6.63 KB
/
vtkPBGLRMATGraphSource.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
/*=========================================================================
Program: Visualization Toolkit
Module: vtkPBGLRMATGraphSource.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 2008 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
/*
* 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 vtkPBGLRMATGraphSource - a distributed graph with random edges built
// accorting to the recursive matrix (R-MAT) model.
//
// .SECTION Description
// Generates a directed distributed graph with a specified number of
// vertices (N=2^X) and a set of probabilities A, B, C, and D, using
// the recursive matrix (R-MAT) method of Chakrabarti, Zhan, and
// Faloutsos. Edges are generated by randomly selecting an element
// within the adjacency matrix, then adding the corresponding
// edge. The element in the adjacency matrix is selected by placing
// set of grids over the adjacency list. The topmost grid has four
// quadrants, and the probability of creating an edge within that
// quadrant is specified by A, B, C, or D, corresponding to the
// top-left, top-right, bottom-left, and bottom-right quadrants in the
// grid, respectively:
//
// +-+-+
// |A|B|
// +-+-+
// |C|D|
// +-+-+
//
// Naturally, A+B+C+D must equal 1. Once a quadrant has been selected,
// the quadrant itself is subdivided into another A-B-C-D grid and the
// same process is applied repeatedly until the grid itself matches
// the adjacency matrix and a specific edge is selected.
//
// Typically, A >= B, A >= C, and A >= D. A and D are viewed as two
// separate communities, while B and C provide interconnections
// between those two communities. The more skewed the probabilities
// between the communities (A >= D), the more unbalanced the resulting
// degree distributions will be. With no skew (A=B=C=D=0.25), this
// generator produces graphs similar to the random graphs provided by
// vtkPRandomGraphSource. Greater skew values tend to produce graphs
// with a power-law degree distribution, which mimics the behavior of
// many real-world graphs based on social networks.
//
// @deprecated Not maintained as of VTK 6.2 and will be removed eventually.
#ifndef vtkPBGLRMATGraphSource_h
#define vtkPBGLRMATGraphSource_h
#include "vtkInfovisParallelModule.h" // For export macro
#include "vtkGraphAlgorithm.h"
class vtkGraph;
class vtkPVXMLElement;
#if !defined(VTK_LEGACY_REMOVE)
class VTKINFOVISPARALLEL_EXPORT vtkPBGLRMATGraphSource : public vtkGraphAlgorithm
{
public:
static vtkPBGLRMATGraphSource* New();
vtkTypeMacro(vtkPBGLRMATGraphSource,vtkGraphAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// The number of vertices in the graph. This value will always be a
// power of two.
vtkGetMacro(NumberOfVertices, vtkIdType);
// Description:
// Sets the number of vertices in the graph, which will be rounded
// to the nearest power of two.
virtual void SetNumberOfVertices(vtkIdType value);
// Description:
// Creates a graph with the specified number of edges. Duplicate
// (parallel) edges are allowed.
vtkGetMacro(NumberOfEdges, vtkIdType);
vtkSetClampMacro(NumberOfEdges, vtkIdType, 0, VTK_ID_MAX);
// Description:
// Set the quadrant probabilities A, B, C, D. Requires that
// A+B+C+D=1.
void SetProbabilities(double A, double B, double C, double D);
// Description:
// Retrieves the quadrant probabilities.
void GetProbabilities(double *A, double *B, double *C, double *D);
// Description:
// When set, includes edge weights in an array named "edge_weights".
// Defaults to off. Weights are random between 0 and 1.
vtkSetMacro(IncludeEdgeWeights, bool);
vtkGetMacro(IncludeEdgeWeights, bool);
vtkBooleanMacro(IncludeEdgeWeights, bool);
// Description:
// The name of the edge weight array. Default "edge weight".
vtkSetStringMacro(EdgeWeightArrayName);
vtkGetStringMacro(EdgeWeightArrayName);
// Description:
// If this flag is set to true, edges where the source and target
// vertex are the same can be generated. The default is to forbid
// such loops.
vtkSetMacro(AllowSelfLoops, bool);
vtkGetMacro(AllowSelfLoops, bool);
vtkBooleanMacro(AllowSelfLoops, bool);
// Description:
// Add pedigree ids to vertex and edge data.
vtkSetMacro(GeneratePedigreeIds, bool);
vtkGetMacro(GeneratePedigreeIds, bool);
vtkBooleanMacro(GeneratePedigreeIds, bool);
// Description:
// The name of the vertex pedigree id array. Default "vertex id".
vtkSetStringMacro(VertexPedigreeIdArrayName);
vtkGetStringMacro(VertexPedigreeIdArrayName);
// Description:
// The name of the edge pedigree id array. Default "edge id".
vtkSetStringMacro(EdgePedigreeIdArrayName);
vtkGetStringMacro(EdgePedigreeIdArrayName);
// Description:
// Control the seed used for pseudo-random-number generation.
// This ensures that vtkPBGLRMATGraphSource can produce repeatable
// results. The seed values provided for each process should be different,
vtkSetMacro(Seed, int);
vtkGetMacro(Seed, int);
protected:
vtkPBGLRMATGraphSource();
~vtkPBGLRMATGraphSource();
vtkIdType NumberOfVertices;
vtkIdType NumberOfEdges;
double A;
double B;
double C;
double D;
bool IncludeEdgeWeights;
bool AllowSelfLoops;
bool GeneratePedigreeIds;
int Seed;
char* EdgeWeightArrayName;
char* VertexPedigreeIdArrayName;
char* EdgePedigreeIdArrayName;
virtual int RequestData(
vtkInformation*,
vtkInformationVector**,
vtkInformationVector*);
// Description:
// Creates directed or undirected output based on Directed flag.
virtual int RequestDataObject(vtkInformation*,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
private:
vtkPBGLRMATGraphSource(const vtkPBGLRMATGraphSource&); // Not implemented
void operator=(const vtkPBGLRMATGraphSource&); // Not implemented
};
#endif //VTK_LEGACY_REMOVE
#endif