summaryrefslogtreecommitdiff
path: root/doc/clust_w.1.html
diff options
context:
space:
mode:
authorKatolaZ <katolaz@freaknet.org>2017-09-27 15:06:31 +0100
committerKatolaZ <katolaz@freaknet.org>2017-09-27 15:06:31 +0100
commit3aee2fd43e3059a699af2b63c6f2395e5a55e515 (patch)
tree58c95505a0906ed9cfa694f9dbd319403fd8f01d /doc/clust_w.1.html
First commit on github -- NetBunch 1.0
Diffstat (limited to 'doc/clust_w.1.html')
-rw-r--r--doc/clust_w.1.html197
1 files changed, 197 insertions, 0 deletions
diff --git a/doc/clust_w.1.html b/doc/clust_w.1.html
new file mode 100644
index 0000000..49eceb6
--- /dev/null
+++ b/doc/clust_w.1.html
@@ -0,0 +1,197 @@
+<!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>clust_w(1) - Compute the graph and node clustering of weighted graphs</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'>clust_w(1)</li>
+ <li class='tc'>www.complex-networks.net</li>
+ <li class='tr'>clust_w(1)</li>
+ </ol>
+
+ <h2 id="NAME">NAME</h2>
+<p class="man-name">
+ <code>clust_w</code> - <span class="man-whatis">Compute the graph and node clustering of weighted graphs</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>clust_w</code> <var>graph_in</var> [SHOW]</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><code>clust_w</code> computes the clustering coefficient of the undirected and
+weighted graph given as input in the file <var>graph_in</var>. The program uses
+the definition of weighted clustering proposed by Barrat, Barthelemy,
+Pastor-Satorras ans Vespignani. If <code>SHOW</code> is provided as a second
+parameter, the program prints on STDERR the label, degree, and
+clustering coefficient of all the nodes in <var>graph_in</var>.</p>
+
+<h2 id="PARAMETERS">PARAMETERS</h2>
+
+<dl>
+<dt><var>graph_in</var></dt><dd><p> undirected and weighted input graph (edge list). If it is equal to
+ <code>-</code> (dash), read the edge list from STDIN.</p></dd>
+<dt class="flush">SHOW</dt><dd><p> If the second (optional) parameter is equal to <code>SHOW</code>, the program
+ will dump on the standard error the label, degree, and clustering
+ coefficient of each node in <var>graph_in</var>.</p></dd>
+</dl>
+
+
+<h2 id="OUTPUT">OUTPUT</h2>
+
+<p>If only <var>graph_in</var> is specified, then the output is a single line,
+containing the clustering coefficient of the undirected and weighted
+graph provided as input. If <code>SHOW</code> is specified, the program will
+print on the standard output one line for each node, in the format:</p>
+
+<pre><code>node_1 k_1 c_1
+node_2 k_2 c_2
+node_3 k_3 c_3
+ ....
+</code></pre>
+
+<p>where <code>node_1</code> is the label of the node, <code>k_1</code> is its degree, and
+<code>c_1</code> is its node clustering coefficient.</p>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>The most simple way of using <code>clust</code> is to compute only the clustering
+coefficient of a graph. For instance, the command:</p>
+
+<pre><code> $ clust_w US_airports.net
+ 0.01034196
+ $
+</code></pre>
+
+<p>computes the weighted clustering coefficient of the graph
+<code>US_airports.net</code> (the US air transportation network). In order to
+obtain the weighted clustering coefficient of all the nodes, we should
+use:</p>
+
+<pre><code> $ clust_w US_airports.net SHOW
+ 0 145 0.30493676524961
+ 1 136 0.364315549333
+ 2 132 0.3443612411812
+ 3 76 0.52204673222936
+ ....
+ 497 2 1
+ 498 2 1
+ 499 1 0
+ 0.65111741
+ $
+</code></pre>
+
+<p>The last line printed on output is still the value of the weighted
+clustering coefficient of the graph, while the previous 500 lines
+(which are printed on STDERR) contain the label, degree, and weighted
+clustering coefficient of each node. For instance, the first line
+indicates that node <code>0</code> has degree equal to <code>145</code> and clustering
+coefficient equal to <code>0.30493676524961</code>. It is more convenient to save
+the values of node clustering coefficients in a file, e.g.:</p>
+
+<pre><code> $ clust_w US_airports.net SHOW 2&gt; node_clust_w
+ 0.65111741
+ $
+</code></pre>
+
+<p>In this case, the program prints on output only the weighted graph
+clustering coefficient <code>0.65111741</code>, while the node clustering
+coefficients are saved on the file <code>node_clust_w</code> (notice the syntax
+<code>2&gt; node_clust_w</code>, which redirects the STDERR to the file
+<code>node_clust_w</code>).</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><a class="man-ref" href="clust.1.html">clust<span class="s">(1)</span></a></p>
+
+<h2 id="REFERENCES">REFERENCES</h2>
+
+<ul>
+<li>V. Latora, V. Nicosia, G. Russo, "Complex Networks: Principles,
+Methods and Applications", Chapter 10, Cambridge University Press
+(2017)</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'>clust_w(1)</li>
+ </ol>
+
+ </div>
+</body>
+</html>