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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkRandomGraphSource</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkinfovis_vtkrandomgraphsource.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkRandomGraphSource </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkinfovis.html">Visualization Toolkit Infovis Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>Generates a graph with a specified number of vertices, with the density of edges specified by either an exact number of edges or the probability of an edge. You may additionally specify whether to begin with a random tree (which enforces graph connectivity).</p>
<p>To create an instance of class vtkRandomGraphSource, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkRandomGraphSource
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkRandomGraphSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkRandomGraphSource class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkRandomGraphSource = obj.NewInstance ()</code> </li>
<li>
<code>vtkRandomGraphSource = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>int = obj.GetNumberOfVertices ()</code> - The number of vertices in the graph. </li>
<li>
<code>obj.SetNumberOfVertices (int )</code> - The number of vertices in the graph. </li>
<li>
<code>int = obj.GetNumberOfVerticesMinValue ()</code> - The number of vertices in the graph. </li>
<li>
<code>int = obj.GetNumberOfVerticesMaxValue ()</code> - The number of vertices in the graph. </li>
<li>
<code>int = obj.GetNumberOfEdges ()</code> - If UseEdgeProbability is off, creates a graph with the specified number of edges. Duplicate (parallel) edges are allowed. </li>
<li>
<code>obj.SetNumberOfEdges (int )</code> - If UseEdgeProbability is off, creates a graph with the specified number of edges. Duplicate (parallel) edges are allowed. </li>
<li>
<code>int = obj.GetNumberOfEdgesMinValue ()</code> - If UseEdgeProbability is off, creates a graph with the specified number of edges. Duplicate (parallel) edges are allowed. </li>
<li>
<code>int = obj.GetNumberOfEdgesMaxValue ()</code> - If UseEdgeProbability is off, creates a graph with the specified number of edges. Duplicate (parallel) edges are allowed. </li>
<li>
<code>double = obj.GetEdgeProbability ()</code> - If UseEdgeProbability is on, adds an edge with this probability between 0 and 1 for each pair of vertices in the graph. </li>
<li>
<code>obj.SetEdgeProbability (double )</code> - If UseEdgeProbability is on, adds an edge with this probability between 0 and 1 for each pair of vertices in the graph. </li>
<li>
<code>double = obj.GetEdgeProbabilityMinValue ()</code> - If UseEdgeProbability is on, adds an edge with this probability between 0 and 1 for each pair of vertices in the graph. </li>
<li>
<code>double = obj.GetEdgeProbabilityMaxValue ()</code> - If UseEdgeProbability is on, adds an edge with this probability between 0 and 1 for each pair of vertices in the graph. </li>
<li>
<code>obj.SetIncludeEdgeWeights (bool )</code> - When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1. </li>
<li>
<code>bool = obj.GetIncludeEdgeWeights ()</code> - When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1. </li>
<li>
<code>obj.IncludeEdgeWeightsOn ()</code> - When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1. </li>
<li>
<code>obj.IncludeEdgeWeightsOff ()</code> - When set, includes edge weights in an array named "edge_weights". Defaults to off. Weights are random between 0 and 1. </li>
<li>
<code>obj.SetEdgeWeightArrayName (string )</code> - The name of the edge weight array. Default "edge weight". </li>
<li>
<code>string = obj.GetEdgeWeightArrayName ()</code> - The name of the edge weight array. Default "edge weight". </li>
<li>
<code>obj.SetDirected (bool )</code> - When set, creates a directed graph, as opposed to an undirected graph. </li>
<li>
<code>bool = obj.GetDirected ()</code> - When set, creates a directed graph, as opposed to an undirected graph. </li>
<li>
<code>obj.DirectedOn ()</code> - When set, creates a directed graph, as opposed to an undirected graph. </li>
<li>
<code>obj.DirectedOff ()</code> - When set, creates a directed graph, as opposed to an undirected graph. </li>
<li>
<code>obj.SetUseEdgeProbability (bool )</code> - When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. </li>
<li>
<code>bool = obj.GetUseEdgeProbability ()</code> - When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. </li>
<li>
<code>obj.UseEdgeProbabilityOn ()</code> - When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. </li>
<li>
<code>obj.UseEdgeProbabilityOff ()</code> - When set, uses the EdgeProbability parameter to determine the density of edges. Otherwise, NumberOfEdges is used. </li>
<li>
<code>obj.SetStartWithTree (bool )</code> - When set, builds a random tree structure first, then adds additional random edges. </li>
<li>
<code>bool = obj.GetStartWithTree ()</code> - When set, builds a random tree structure first, then adds additional random edges. </li>
<li>
<code>obj.StartWithTreeOn ()</code> - When set, builds a random tree structure first, then adds additional random edges. </li>
<li>
<code>obj.StartWithTreeOff ()</code> - When set, builds a random tree structure first, then adds additional random edges. </li>
<li>
<code>obj.SetAllowSelfLoops (bool )</code> - 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. </li>
<li>
<code>bool = obj.GetAllowSelfLoops ()</code> - 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. </li>
<li>
<code>obj.AllowSelfLoopsOn ()</code> - 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. </li>
<li>
<code>obj.AllowSelfLoopsOff ()</code> - 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. </li>
<li>
<code>obj.SetAllowParallelEdges (bool )</code> - When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops. </li>
<li>
<code>bool = obj.GetAllowParallelEdges ()</code> - When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops. </li>
<li>
<code>obj.AllowParallelEdgesOn ()</code> - When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops. </li>
<li>
<code>obj.AllowParallelEdgesOff ()</code> - When set, multiple edges from a source to a target vertex are allowed. The default is to forbid such loops. </li>
<li>
<code>obj.SetGeneratePedigreeIds (bool )</code> - Add pedigree ids to vertex and edge data. </li>
<li>
<code>bool = obj.GetGeneratePedigreeIds ()</code> - Add pedigree ids to vertex and edge data. </li>
<li>
<code>obj.GeneratePedigreeIdsOn ()</code> - Add pedigree ids to vertex and edge data. </li>
<li>
<code>obj.GeneratePedigreeIdsOff ()</code> - Add pedigree ids to vertex and edge data. </li>
<li>
<code>obj.SetVertexPedigreeIdArrayName (string )</code> - The name of the vertex pedigree id array. Default "vertex id". </li>
<li>
<code>string = obj.GetVertexPedigreeIdArrayName ()</code> - The name of the vertex pedigree id array. Default "vertex id". </li>
<li>
<code>obj.SetEdgePedigreeIdArrayName (string )</code> - The name of the edge pedigree id array. Default "edge id". </li>
<li>
<code>string = obj.GetEdgePedigreeIdArrayName ()</code> - The name of the edge pedigree id array. Default "edge id". </li>
<li>
<code>obj.SetSeed (int )</code> - Control the seed used for pseudo-random-number generation. This ensures that vtkRandomGraphSource can produce repeatable results. </li>
<li>
<code>int = obj.GetSeed ()</code> - Control the seed used for pseudo-random-number generation. This ensures that vtkRandomGraphSource can produce repeatable results. </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkinfovis.html">Visualization Toolkit Infovis Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:33 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
