summaryrefslogtreecommitdiff
path: root/doc/shortest.1.html
blob: d9bedd2ed61f5cf9fddb6b13f0117e4468cb1a5d (plain)
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
<!DOCTYPE html>
<html>
<head>
  <meta http-equiv='content-type' value='text/html;charset=utf8'>
  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
  <title>shortest(1) - Compute the distance between one node and all the other nodes of a graph</title>
  <style type='text/css' media='all'>
  /* style: man */
  body#manpage {margin:0}
  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
  .mp h2 {margin:10px 0 0 0}
  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
  .mp h3 {margin:0 0 0 4ex}
  .mp dt {margin:0;clear:left}
  .mp dt.flush {float:left;width:8ex}
  .mp dd {margin:0 0 0 9ex}
  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
  .mp pre {margin-bottom:20px}
  .mp pre+h2,.mp pre+h3 {margin-top:22px}
  .mp h2+pre,.mp h3+pre {margin-top:5px}
  .mp img {display:block;margin:auto}
  .mp h1.man-title {display:none}
  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
  .mp h2 {font-size:16px;line-height:1.25}
  .mp h1 {font-size:20px;line-height:2}
  .mp {text-align:justify;background:#fff}
  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
  .mp u {text-decoration:underline}
  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
  .mp b.man-ref {font-weight:normal;color:#434241}
  .mp pre {padding:0 4ex}
  .mp pre code {font-weight:normal;color:#434241}
  .mp h2+pre,h3+pre {padding-left:0}
  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
  ol.man-decor {width:100%}
  ol.man-decor li.tl {text-align:left}
  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
  ol.man-decor li.tr {text-align:right;float:right}
  </style>
  <style type='text/css' media='all'>
  /* style: toc */
  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
  .man-navigation a:hover {color:#111;text-decoration:underline}
  </style>
</head>
<!--
  The following styles are deprecated and will be removed at some point:
  div#man, div#man ol.man, div#man ol.head, div#man ol.man.

  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
  .man-navigation should be used instead.
-->
<body id='manpage'>
  <div class='mp' id='man'>

  <div class='man-navigation' style='display:none'>
    <a href="#NAME">NAME</a>
    <a href="#SYNOPSIS">SYNOPSIS</a>
    <a href="#DESCRIPTION">DESCRIPTION</a>
    <a href="#PARAMETERS">PARAMETERS</a>
    <a href="#OUTPUT">OUTPUT</a>
    <a href="#EXAMPLES">EXAMPLES</a>
    <a href="#SEE-ALSO">SEE ALSO</a>
    <a href="#REFERENCES">REFERENCES</a>
    <a href="#AUTHORS">AUTHORS</a>
  </div>

  <ol class='man-decor man-head man head'>
    <li class='tl'>shortest(1)</li>
    <li class='tc'>www.complex-networks.net</li>
    <li class='tr'>shortest(1)</li>
  </ol>

  <h2 id="NAME">NAME</h2>
<p class="man-name">
  <code>shortest</code> - <span class="man-whatis">Compute the distance between one node and all the other nodes of a graph</span>
</p>

<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p><code>shortest</code> <var>graph_in</var> <var>node</var> [SHOW]</p>

<h2 id="DESCRIPTION">DESCRIPTION</h2>

<p><code>shortest</code> computes the distance (and the shortest paths) between a
given node and all the other nodes of an undirected graph provided as
input. The program implements the Breadth-First Search algorithm.</p>

<h2 id="PARAMETERS">PARAMETERS</h2>

<dl>
<dt><var>graph_in</var></dt><dd><p>  input graph (edge list) if equal to <code>-</code> (dash), read the edge list
  from STDIN.</p></dd>
<dt class="flush"><var>node</var></dt><dd><p>  The label of the node from which distances are to be computed</p></dd>
<dt class="flush">SHOW</dt><dd><p>  If the third (optional) parameter is equal to <code>SHOW</code>, the program
  will dump on the standard error also all the shortest paths
  between <var>node</var> and all the other nodes of the graph</p></dd>
</dl>


<h2 id="OUTPUT">OUTPUT</h2>

<p><code>shortest</code> prints on the standard output the distances betwen <var>node</var>
and all the other nodes of the graph, in the format:</p>

<pre><code>d0 d1 d2 d3.....
</code></pre>

<p>where <code>d0</code> is the distance to node <code>0</code>, <code>d1</code> is the distance to node
<code>1</code>, and so forth. If <code>SHOW</code> is given, the list of all the shortest
paths between <var>node</var> and the other nodes is printed on the standard
error, one path per line, in the format:</p>

<pre><code>label0 label1 label2 ... node
</code></pre>

<p>where <code>label1</code>, <code>label2</code>, etc. are the labels of a shortest path
between <code>label0</code> and <var>node</var></p>

<h2 id="EXAMPLES">EXAMPLES</h2>

<p>The following command:</p>

<pre><code>      $ shortest er_1000_5000.net 25 
      3 4 4 4 2.......
      $
</code></pre>

<p>will show on output the distances between node 25 and all the other
nodes in the graph <code>er_1000_5000.net</code>. If we invoke the program with:</p>

<pre><code>      $ shortest er_1000_5000.net 25 SHOW 2&gt;er_1000_5000.net_25_paths
      3 4 4 4 2.......
      $
</code></pre>

<p>the program will dump on STDERR the list of all the shortest paths
between 'node' and all the other nodes of the graph. Since we used the
redirection <code>2&gt;er_1000_5000.net_25_paths</code> (which can be read "redirect
STDERR to 'er_1000_5000.net_25_paths' "), the list of shortest
paths will be written to the file <code>er_1000_5000.net_25_paths</code>.</p>

<h2 id="SEE-ALSO">SEE ALSO</h2>

<p><span class="man-ref">dijkstra<span class="s">(1)</span></span>, <span class="man-ref">bet_dependency<span class="s">(1)</span></span>, <span class="man-ref">betweenness<span class="s">(1)</span></span>, <span class="man-ref">shortest_avg_max_hist<span class="s">(1)</span></span></p>

<h2 id="REFERENCES">REFERENCES</h2>

<ul>
<li><p>V. Latora, V. Nicosia, G. Russo, "Complex Networks: Principles,
Methods and Applications", Chapter 3, Cambridge University Press
(2017)</p></li>
<li><p>V. Latora, V. Nicosia, G. Russo, "Complex Networks: Principles,
Methods and Applications", Appendix 6, Cambridge University Press
(2017)</p></li>
</ul>


<h2 id="AUTHORS">AUTHORS</h2>

<p>(c) Vincenzo 'KatolaZ' Nicosia 2009-2017 <code>&lt;v.nicosia@qmul.ac.uk&gt;</code>.</p>


  <ol class='man-decor man-foot man foot'>
    <li class='tl'>www.complex-networks.net</li>
    <li class='tc'>September 2017</li>
    <li class='tr'>shortest(1)</li>
  </ol>

  </div>
</body>
</html>