summaryrefslogtreecommitdiff
path: root/doc/er_A.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/er_A.1')
-rw-r--r--doc/er_A.178
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/er_A.1 b/doc/er_A.1
new file mode 100644
index 0000000..ad2a504
--- /dev/null
+++ b/doc/er_A.1
@@ -0,0 +1,78 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "ER_A" "1" "September 2017" "www.complex-networks.net" "www.complex-networks.net"
+.
+.SH "NAME"
+\fBer_A\fR \- Sample a random graph from the Erdos\-Renyi model A
+.
+.SH "SYNOPSIS"
+\fBer_A\fR \fIN\fR \fIK\fR [\fIfileout\fR]
+.
+.SH "DESCRIPTION"
+\fBer_A\fR samples a random graph with \fIN\fR nodes and \fIK\fR edges from the Erdos\-Renyi model A, i\.e\. the ensemble of random graphs where K links are placed uniformly at random among N nodes\. The program dumps the edge list of the resulting graph on output\. If the optional \fIfileout\fR is provided, the output is written on a file with that name\.
+.
+.SH "PARAMETERS"
+.
+.TP
+\fIN\fR
+Number of nodes in the final graph\.
+.
+.TP
+\fIK\fR
+Number of edges in the final graph\.
+.
+.TP
+\fIfileout\fR
+The (optional) name of the filename where the edge list of the graph will be saved\.
+.
+.SH "EXAMPLES"
+The following command:
+.
+.IP "" 4
+.
+.nf
+
+ $ er_A 1000 3000
+.
+.fi
+.
+.IP "" 0
+.
+.P
+samples an undirected random network with \fIN=1000\fR nodes and \fIK=3000\fR edges using the Erdos\-Renyi model A\. The output of the command \fBer_A\fR will be the edge\-list of the resulting graph, where each (undirected) edge is reported only once\. In order to be useful, such edge\-list should be saved into a file\. The following command:
+.
+.IP "" 4
+.
+.nf
+
+ $ er_A 1000 3000 > er_A_1000_3000\.net
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will save the resulting graph in the file er_A_1000_3000\.net\. Notice the usage of the symbol ">" to redirect the output of the program to a file\.
+.
+.SH "SEE ALSO"
+er_B(1), ws(1)
+.
+.SH "REFERENCES"
+.
+.IP "\(bu" 4
+P\. Erdos, & A\. Rényi, "On Random Graphs I", Publ\. Math\. Debrecen, 6, 290 (1959)
+.
+.IP "\(bu" 4
+P\.Erdos, & A\. Renyi, "On the evolution of random graphs" Publ\. Math\. Inst\. Hungary\. Acad\. Sci\., 5, 17\-61 (1960)
+.
+.IP "\(bu" 4
+V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Chapter 3, Cambridge University Press (2017)
+.
+.IP "\(bu" 4
+V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Appendix 10, Cambridge University Press (2017)
+.
+.IP "" 0
+.
+.SH "AUTHORS"
+(c) Vincenzo \'KatolaZ\' Nicosia 2009\-2017 \fB<v\.nicosia@qmul\.ac\.uk>\fR\.