-
Notifications
You must be signed in to change notification settings - Fork 0
/
godoc-graph-pkg.html
624 lines (316 loc) · 16 KB
/
godoc-graph-pkg.html
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>graph - The Go Programming Language</title>
<link type="text/css" rel="stylesheet" href="/doc/style.css">
<script type="text/javascript" src="/doc/godocs.js"></script>
</head>
<body>
<div id="topbar"><div class="container wide">
<form method="GET" action="/search">
<div id="menu">
<a href="/doc/">Documents</a>
<a href="/ref/">References</a>
<a href="/pkg/">Packages</a>
<a href="/project/">The Project</a>
<a href="/help/">Help</a>
<input type="text" id="search" name="q" class="inactive" value="Search">
</div>
<div id="heading"><a href="/">The Go Programming Language</a></div>
</form>
</div></div>
<div id="page" class="wide">
<div id="plusone"><g:plusone size="small" annotation="none"></g:plusone></div>
<h1>Package graph</h1>
<div id="nav"></div>
<!--
Copyright 2009 The Go Authors. All rights reserved.
Use of this source code is governed by a BSD-style
license that can be found in the LICENSE file.
-->
<div id="short-nav">
<dl>
<dd><code>import "graph"</code></dd>
</dl>
<dl>
<dd><a href="#overview" class="overviewLink">Overview</a></dd>
<dd><a href="#index">Index</a></dd>
</dl>
</div>
<!-- The package's Name is printed as title by the top-level template -->
<div id="overview" class="toggleVisible">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
</div>
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
<p>
Package graph provides both primitives for initializing graph structures
and functions to solve the maximum flow of a graph. Testing methods and
graphic interfaces are also available.
</p>
</div>
</div>
<h2 id="index">Index</h2>
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
<div id="manual-nav">
<dl>
<dd><a href="#variables">Variables</a></dd>
<dd><a href="#Abs">func Abs(n int) int</a></dd>
<dd><a href="#BreadthFirstSearch">func BreadthFirstSearch(g *Graph, source Node, sink Node) (int, map[Node]Node)</a></dd>
<dd><a href="#EdmondsKarp">func EdmondsKarp(g *Graph, source Node, sink Node) (int, *Graph)</a></dd>
<dd><a href="#Min">func Min(x, y int) int</a></dd>
<dd><a href="#ParallelBFS">func ParallelBFS(g *Graph, source Node, sink Node) (int, map[Node]Node)</a></dd>
<dd><a href="#ParallelEdmondsKarp">func ParallelEdmondsKarp(g *Graph, source Node, sink Node) (int, *Graph)</a></dd>
<dd><a href="#SolveGraph1">func SolveGraph1(parallel bool) (int, *Graph)</a></dd>
<dd><a href="#SolveGraph2">func SolveGraph2(parallel bool) (int, *Graph)</a></dd>
<dd><a href="#SolveGraph3">func SolveGraph3(parallel bool) (int, *Graph)</a></dd>
<dd><a href="#SolveGraph4">func SolveGraph4(parallel bool) (int, *Graph)</a></dd>
<dd><a href="#SolveGraph5">func SolveGraph5(parallel bool) (int, *Graph)</a></dd>
<dd><a href="#SolveGraph6">func SolveGraph6(parallel bool) (int, *Graph)</a></dd>
<dd><a href="#SolveRandomGraph">func SolveRandomGraph(gr *Graph, source Node, sink Node, parallel bool) (int, *Graph, Node, Node)</a></dd>
<dd><a href="#Graph">type Graph</a></dd>
<dd> <a href="#GenBlankGraph">func GenBlankGraph() *Graph</a></dd>
<dd> <a href="#GenRandomGraph">func GenRandomGraph(nodenum, connectnum, maxcap int) *Graph</a></dd>
<dd> <a href="#Graph.AddNeighbour">func (g *Graph) AddNeighbour(source Node, destination Node, capacity int) *Graph</a></dd>
<dd> <a href="#Graph.AddNode">func (g *Graph) AddNode(node Node) *Graph</a></dd>
<dd> <a href="#Graph.GetNeighbours">func (g *Graph) GetNeighbours(node Node) []Neighbour</a></dd>
<dd> <a href="#Graph.GetNodeList">func (g *Graph) GetNodeList() []Node</a></dd>
<dd> <a href="#Graph.GetWeight">func (g *Graph) GetWeight(source Node, destination Node) int</a></dd>
<dd> <a href="#Graph.UpdateWeight">func (g *Graph) UpdateWeight(source Node, destination Node, weight int) *Graph</a></dd>
<dd><a href="#Neighbour">type Neighbour</a></dd>
<dd><a href="#Node">type Node</a></dd>
<dd><a href="#Queue">type Queue</a></dd>
<dd> <a href="#GenQueue">func GenQueue(length int) *Queue</a></dd>
<dd> <a href="#Queue.Dequeue">func (q *Queue) Dequeue() Node</a></dd>
<dd> <a href="#Queue.Enqueue">func (q *Queue) Enqueue(node Node)</a></dd>
<dd> <a href="#Queue.GetSize">func (q *Queue) GetSize() int</a></dd>
</dl>
<h4>Package files</h4>
<p>
<span style="font-size:90%">
<a href="/src/pkg/graph/algorithm.go">algorithm.go</a>
<a href="/src/pkg/graph/graph-struct.go">graph-struct.go</a>
<a href="/src/pkg/graph/parallel-algo.go">parallel-algo.go</a>
<a href="/src/pkg/graph/queue.go">queue.go</a>
<a href="/src/pkg/graph/support-funcs.go">support-funcs.go</a>
<a href="/src/pkg/graph/test.go">test.go</a>
</span>
</p>
<h2 id="variables">Variables</h2>
<pre>var NCPU = 4</pre>
<p>
Initialize a number of CPU cores.
</p>
<h2 id="Abs">func <a href="/src/pkg/graph/support-funcs.go?s=464:483#L9">Abs</a></h2>
<pre>func Abs(n int) int</pre>
<p>
Function Abs returns the absolute value of an integer.
</p>
<h2 id="BreadthFirstSearch">func <a href="/src/pkg/graph/algorithm.go?s=1534:1612#L34">BreadthFirstSearch</a></h2>
<pre>func BreadthFirstSearch(g *Graph, source Node, sink Node) (int, map[Node]Node)</pre>
<p>
Function BreadthFirstSearch accepts a graph with a valid source and sink
node, and returns a valid path through the graph's flow network along with
the flow of the found path.
</p>
<h2 id="EdmondsKarp">func <a href="/src/pkg/graph/algorithm.go?s=395:459#L1">EdmondsKarp</a></h2>
<pre>func EdmondsKarp(g *Graph, source Node, sink Node) (int, *Graph)</pre>
<p>
Function EdmondsKarp accepts a graph with a valid source and sink node,
and returns the maximum flow as an integer along with a graph with a valid
flow network. The function runs a serial BFS in order to find valid paths
through the graph.
</p>
<h2 id="Min">func <a href="/src/pkg/graph/support-funcs.go?s=312:334#L1">Min</a></h2>
<pre>func Min(x, y int) int</pre>
<p>
Function Min returns the smaller of two integers.
</p>
<h2 id="ParallelBFS">func <a href="/src/pkg/graph/parallel-algo.go?s=1753:1824#L41">ParallelBFS</a></h2>
<pre>func ParallelBFS(g *Graph, source Node, sink Node) (int, map[Node]Node)</pre>
<p>
Function ParallelBFS accepts a graph with a valid source and sink
node, and returns a valid path through the graph's flow network along with
the flow of the found path using channels to speed up runtime.
</p>
<h2 id="ParallelEdmondsKarp">func <a href="/src/pkg/graph/parallel-algo.go?s=585:657#L8">ParallelEdmondsKarp</a></h2>
<pre>func ParallelEdmondsKarp(g *Graph, source Node, sink Node) (int, *Graph)</pre>
<p>
Function ParallelEdmondsKarp accepts a graph with a valid source and sink
node, and returns the maximum flow as an integer along with a graph with a
valid flow network. The function runs a parallelized BFS in order to find
valid paths through the graph.
</p>
<h2 id="SolveGraph1">func <a href="/src/pkg/graph/test.go?s=298:343#L2">SolveGraph1</a></h2>
<pre>func SolveGraph1(parallel bool) (int, *Graph)</pre>
<p>
Function SolveGraph1 runs the algorithm on the graph
sample-problems/problem1;solution-5.png
</p>
<h2 id="SolveGraph2">func <a href="/src/pkg/graph/test.go?s=1132:1177#L39">SolveGraph2</a></h2>
<pre>func SolveGraph2(parallel bool) (int, *Graph)</pre>
<p>
Function SolveGraph2 runs the algorithm on the graph
sample-problems/problem2;solution-5.svg
</p>
<h2 id="SolveGraph3">func <a href="/src/pkg/graph/test.go?s=1857:1902#L71">SolveGraph3</a></h2>
<pre>func SolveGraph3(parallel bool) (int, *Graph)</pre>
<p>
Function SolveGraph3 runs the algorithm on the graph
sample-problems/problem3;solution-15.jpg
</p>
<h2 id="SolveGraph4">func <a href="/src/pkg/graph/test.go?s=2442:2487#L96">SolveGraph4</a></h2>
<pre>func SolveGraph4(parallel bool) (int, *Graph)</pre>
<p>
Function SolveGraph4 runs the algorithm on the graph
sample-problems/problem4;solution-3.gif
</p>
<h2 id="SolveGraph5">func <a href="/src/pkg/graph/test.go?s=3198:3243#L130">SolveGraph5</a></h2>
<pre>func SolveGraph5(parallel bool) (int, *Graph)</pre>
<p>
Function SolveGraph5 runs the algorithm on the graph
sample-problems/problem5;solution-4.gif
</p>
<h2 id="SolveGraph6">func <a href="/src/pkg/graph/test.go?s=4195:4240#L171">SolveGraph6</a></h2>
<pre>func SolveGraph6(parallel bool) (int, *Graph)</pre>
<p>
Function SolveGraph6 runs the algorithm on the graph
sample-problems/problem6;solution-21.jpg
Note: This graph follows different rules of flow between nodes, but this
implementation still provides the correct answer.
</p>
<h2 id="SolveRandomGraph">func <a href="/src/pkg/graph/test.go?s=5278:5375#L220">SolveRandomGraph</a></h2>
<pre>func SolveRandomGraph(gr *Graph, source Node, sink Node, parallel bool) (int, *Graph, Node, Node)</pre>
<p>
Function SolveRandomGraph() runs the algorithm on a random graph.
</p>
<h2 id="Graph">type <a href="/src/pkg/graph/graph-struct.go?s=824:875#L19">Graph</a></h2>
<pre>type Graph struct {
Nodemap map[Node][]Neighbour
}</pre>
<p>
Graph structure containing a map in which the nodes are values and a list
of neighbours connected to that node is the key.
</p>
<h3 id="GenBlankGraph">func <a href="/src/pkg/graph/graph-struct.go?s=934:961#L24">GenBlankGraph</a></h3>
<pre>func GenBlankGraph() *Graph</pre>
<p>
Function GenBlankGraph initializes a new empty graph.
</p>
<h3 id="GenRandomGraph">func <a href="/src/pkg/graph/graph-struct.go?s=5289:5348#L140">GenRandomGraph</a></h3>
<pre>func GenRandomGraph(nodenum, connectnum, maxcap int) *Graph</pre>
<p>
Function GenRandomGraph initializes a new graph, fills it with a given
number of nodes and connections with random values, and returns the graph.
</p>
<h3 id="Graph.AddNeighbour">func (*Graph) <a href="/src/pkg/graph/graph-struct.go?s=2720:2800#L77">AddNeighbour</a></h3>
<pre>func (g *Graph) AddNeighbour(source Node, destination Node, capacity int) *Graph</pre>
<p>
Function AddNeighbour is a graph-associated method that initializes a
connection with no weight between a given source and destination node and
records the connection and its residual connection into the graph. Returns
the graph exactly as is if the nodes are the same, if the nodes do not
exist, or if the connection already exists.
</p>
<h3 id="Graph.AddNode">func (*Graph) <a href="/src/pkg/graph/graph-struct.go?s=2216:2257#L64">AddNode</a></h3>
<pre>func (g *Graph) AddNode(node Node) *Graph</pre>
<p>
Function AddNode is a graph-associated method that initializes a node
value, with no neighbours, into the map. Returns the graph exactly as is
if the node is already initialized.
</p>
<h3 id="Graph.GetNeighbours">func (*Graph) <a href="/src/pkg/graph/graph-struct.go?s=1129:1181#L32">GetNeighbours</a></h3>
<pre>func (g *Graph) GetNeighbours(node Node) []Neighbour</pre>
<p>
Function GetNeighbours is a graph-associated method that returns the
neighbours of a given node.
</p>
<h3 id="Graph.GetNodeList">func (*Graph) <a href="/src/pkg/graph/graph-struct.go?s=1784:1820#L51">GetNodeList</a></h3>
<pre>func (g *Graph) GetNodeList() []Node</pre>
<p>
Function GetNodeList is a graph-associated method that returns a list
of all initialized nodes. Useful for iteration.
</p>
<h3 id="Graph.GetWeight">func (*Graph) <a href="/src/pkg/graph/graph-struct.go?s=1359:1419#L38">GetWeight</a></h3>
<pre>func (g *Graph) GetWeight(source Node, destination Node) int</pre>
<p>
Function GetWeight is a graph-associated method that returns the weight
of a connection from a given source node to a given destination node.
</p>
<h3 id="Graph.UpdateWeight">func (*Graph) <a href="/src/pkg/graph/graph-struct.go?s=4043:4121#L110">UpdateWeight</a></h3>
<pre>func (g *Graph) UpdateWeight(source Node, destination Node, weight int) *Graph</pre>
<p>
Function UpdateWeight is a graph-associated method that updates the weight
of both the connection between the source and destination and the residual
connection between the destination and source. Returns the graph exactly
as is if the new weight is greater than the connection's capacity.
</p>
<h2 id="Neighbour">type <a href="/src/pkg/graph/graph-struct.go?s=622:692#L12">Neighbour</a></h2>
<pre>type Neighbour struct {
Neighbour_Node Node
Weight, Capacity int
}</pre>
<p>
Neighbour structure containing a "connected" node, along with integers for
the weight and capacity of the connection.
</p>
<h2 id="Node">type <a href="/src/pkg/graph/graph-struct.go?s=465:495#L6">Node</a></h2>
<pre>type Node struct {
X, Y int
}</pre>
<p>
Node structure containing a simple (x, y) integer coordinate set.
</p>
<h2 id="Queue">type <a href="/src/pkg/graph/queue.go?s=205:251#L1">Queue</a></h2>
<pre>type Queue struct {
<span class="comment">// contains filtered or unexported fields</span>
}</pre>
<p>
FIFO queue structure containing a list of nodes and a size.
</p>
<h3 id="GenQueue">func <a href="/src/pkg/graph/queue.go?s=444:476#L6">GenQueue</a></h3>
<pre>func GenQueue(length int) *Queue</pre>
<p>
Function GenQueue initializes a new queue with a given length.
Note: Use a length of 0 to begin; GenQueue is also used in function Enqueue
to copy the contents and update the size.
</p>
<h3 id="Queue.Dequeue">func (*Queue) <a href="/src/pkg/graph/queue.go?s=1196:1226#L33">Dequeue</a></h3>
<pre>func (q *Queue) Dequeue() Node</pre>
<p>
Function Dequeue returns an item from the first spot in the queue, deletes
it from the queue, and reorganizes the remaining items without disrupting
the queue's order.
</p>
<h3 id="Queue.Enqueue">func (*Queue) <a href="/src/pkg/graph/queue.go?s=716:750#L19">Enqueue</a></h3>
<pre>func (q *Queue) Enqueue(node Node)</pre>
<p>
Function Enqueue adds an item to the end of the queue.
</p>
<h3 id="Queue.GetSize">func (*Queue) <a href="/src/pkg/graph/queue.go?s=608:637#L14">GetSize</a></h3>
<pre>func (q *Queue) GetSize() int</pre>
<p>
Function GetSize returns the current size of the queue.
</p>
</div>
</div>
<div id="footer">
Build version go1.<br>
Except as <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the
Creative Commons Attribution 3.0 License,
and code is licensed under a <a href="/LICENSE">BSD license</a>.<br>
<a href="/doc/tos.html">Terms of Service</a> |
<a href="http://www.google.com/intl/en/privacy/privacy-policy.html">Privacy Policy</a>
</div>
</body>
<script type="text/javascript">
(function() {
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
})();
</script>
</html>