summaryrefslogtreecommitdiff
path: root/doc/node_components.1.html
blob: d528de7ad7ce6a421a399feb2bca77293072a5a4 (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
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
<!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>node_components(1) - Find the components associated to a specific node</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'>node_components(1)</li>
    <li class='tc'>www.complex-networks.net</li>
    <li class='tr'>node_components(1)</li>
  </ol>

  <h2 id="NAME">NAME</h2>
<p class="man-name">
  <code>node_components</code> - <span class="man-whatis">Find the components associated to a specific node</span>
</p>

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

<p><code>node_components</code> <var>graph_in</var> <var>node</var> [<var>component</var> [SHOW]]</p>

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

<p><code>node_components</code> finds the components associated to the node <var>node</var>
of the graph <var>graph_in</var> provided as input, and prints on output the
size of those components. The value of the third parameter <var>component</var>
can be set to <code>IN</code>, <code>OUT</code>, <code>INOUT</code>, <code>SSC</code>, <code>WCC</code>, or <code>ALL</code>. According
to the value of <var>component</var>, the program will compute the IN-component
(<code>IN</code>), the OUT-component (<code>OUT</code>), both the IN- and OUT-component
(<code>INOUT</code>), the strongly connected components (<code>SCC</code>), or the
weakly-connected component (<code>WCC</code>) to which <var>node</var> belongs. If the
third parameter is omitted or equal to <code>ALL</code>, then <code>node_components</code>
computes all the components associated to <var>node</var>.  If <code>SHOW</code> is
specified as the fourth parameter, the program also shows the list of
nodes which belong to each of the required components.</p>

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

<dl>
<dt><var>graph_in</var></dt><dd>  input graph (edge list) if equal to <code>-</code> (dash), read the edge list
  from STDIN.</dd>
<dt class="flush"><var>node</var></dt><dd><p>  the label of the node.</p></dd>
<dt><var>component</var></dt><dd><p>  the component to compute. Can be set to one of <code>IN</code>
  (IN-component), <code>OUT</code> (OUT-component), <code>INOUT</code> (both the IN- and
  the OUT-component), <code>SSC</code> (strongly connected component), <code>WCC</code>
  (weakly connected component), or <code>ALL</code> (all the above). If
  <var>component</var> is not set, compute all the components.</p></dd>
<dt class="flush">SHOW</dt><dd><p>  If the (optional) fourth parameter is equal to <code>SHOW</code>, the program
  will dump on output the list of all the nodes belonging to each
  component.</p></dd>
</dl>


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

<p><code>node_components</code> prints on the standard output the size of the
required components, one per line, in the format:</p>

<pre><code>comp_type_1: size_1
comp_type_2: size_2
.....
</code></pre>

<p>where <code>comp_type_1</code> is the type of component (one of <code>IN</code>, <code>OUT</code>,
<code>SCC</code>, or <code>WCC</code>) and <code>size_1</code> is its size, and so on. Notice that the
sizes are not sorted.  If <code>SHOW</code> is given, the program shows the list
of nodes belonging to each component, in the format:</p>

<pre><code>comp_type_1: size_1 node_1 node_2 node_3 ...
comp_type_2: size_2 node_1 node_2 node_3 ...
</code></pre>

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

<p>We can use <code>node_components</code> to compute the IN-component of a specific
node. For instance, the command:</p>

<pre><code>      $ node_components web-NotreDame.net 2711 IN 
      IN: 53968
      $
</code></pre>

<p>computes the size of the IN-component of node 2711 in the graph
<code>www_nd.net</code> (WWW Notre Dame). This component contains 53968
nodes. Similarly:</p>

<pre><code>      $ node_components web-NotreDame.net 2711 OUT SHOW
      OUT: 21 559 2711 2712 2713 2714 2715 2716 ... 33271 33272
      $
</code></pre>

<p>computes and shows the OUT-component of node 2711, which contains 21
nodes, including node 2711. Finally, we can obtain the size of all the
components associated to node 2711 by running:</p>

<pre><code>      $ node_components web-NotreDame.net 2711
      IN: 53986
      OUT: 21
      WCC: 325729
      SCC: 18
      $
</code></pre>

<p>In this case, the IN-component of node 2711 contains 53986 nodes, the
OUT-component contains 21 nodes, the weakly connected components
contains 325729 nodes (the whole graph), and the strongly connected
component contains 18 nodes. It is also possible to show the list of
nodes belonging to each component by providing <code>SHOW</code> as fourth
parameter. IN this case, it is better to save the output of
<code>node_components</code> into a file, e.g. by using:</p>

<pre><code>      $ node_components web-NotreDame.net 2711 ALL SHOW &gt; web-NotreDame.net_components_2711
</code></pre>

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

<p><span class="man-ref">components<span class="s">(1)</span></span>, <span class="man-ref">strong_conn<span class="s">(1)</span></span>, <span class="man-ref">largest_component<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 6, Cambridge University Press
(2017)</p></li>
<li><p>V. Latora, V. Nicosia, G. Russo, "Complex Networks: Principles,
Methods and Applications", Appendix 8, Cambridge University Press
(2017)</p></li>
</ul>


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

<p>(c) (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'>node_components(1)</li>
  </ol>

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