summaryrefslogtreecommitdiff
path: root/doc/conf_model_deg_nocheck.md
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/conf_model_deg_nocheck.md
First commit on github -- NetBunch 1.0
Diffstat (limited to 'doc/conf_model_deg_nocheck.md')
-rw-r--r--doc/conf_model_deg_nocheck.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/conf_model_deg_nocheck.md b/doc/conf_model_deg_nocheck.md
new file mode 100644
index 0000000..e4131d9
--- /dev/null
+++ b/doc/conf_model_deg_nocheck.md
@@ -0,0 +1,58 @@
+conf_model_deg_nocheck(1) -- Sample a multigraph from the configuration model
+======
+
+## SYNOPSIS
+
+`conf_model_deg_nocheck` <degs>
+
+## DESCRIPTION
+
+`conf_model_deg_nocheck` samples an undirected multigraph (i.e., a
+graph that might contain self-loops multiple edges) from the
+configuration model associated to the degree sequence provided in the
+input file <degs>.
+
+## PARAMETERS
+
+* <degs>:
+ The name of the file containing the degree sequence. If <degs> is
+ equal to '-' (dash) the degree sequence is read from STDIN
+ (standard input).
+
+## OUTPUT
+
+`conf_model_deg_nocheck` prints on output the edge list of the sampled
+graph.
+
+
+## EXAMPLES
+
+Let us assume that the file `AS-20010316.net_degs` contains the degree
+sequence of the data set `AS-20010316.net` (the graph of the Internet
+at AS level in March 2001). In this case, the degree sequence is too
+constrained, since the maximum degree (2277) is much larger than the
+structural cut-off (see [REFERENCES][] below). However, since
+`conf_model_deg_nocheck` allows for self-loops and multiple edges, it
+always finds a multigraph:
+
+ $ conf_model_deg_nocheck AS-20010316.net_degs > AS_20010316_rand.net
+ $
+
+## SEE ALSO
+
+conf_model_deg(1), power_law(1), hv_net(1)
+
+## REFERENCES
+
+* V\. Latora, V. Nicosia, G. Russo, "Complex Networks: Principles,
+ Methods and Applications", Chapter 5, Cambridge University Press
+ (2017)
+
+* V\. Latora, V. Nicosia, G. Russo, "Complex Networks: Principles,
+ Methods and Applications", Appendix 12, Cambridge University Press
+ (2017)
+
+
+## AUTHORS
+
+(c) Vincenzo 'KatolaZ' Nicosia 2009-2017 `<v.nicosia@qmul.ac.uk>`.