diff options
Diffstat (limited to 'doc/pm.1')
| -rw-r--r-- | doc/pm.1 | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/pm.1 b/doc/pm.1 new file mode 100644 index 0000000..f948a2d --- /dev/null +++ b/doc/pm.1 @@ -0,0 +1,68 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PM" "1" "September 2017" "www.complex-networks.net" "www.complex-networks.net" +. +.SH "NAME" +\fBpm\fR \- Compute the leading eigenvalue and eigenvector of a graph +. +.SH "SYNOPSIS" +\fBpm\fR \fIgraph_in\fR \fIis_dir\fR \fIeps\fR +. +.SH "DESCRIPTION" +\fBpm\fR computes the leading eigenvalue and the corresponding eigenvector of the matrix given as input, using the Power Method\. In particular, this implementation uses the Rayleigh iteration, which allows faster convergence on undirected graphs\. +. +.SH "PARAMETERS" +. +.TP +\fIgraph_in\fR +input graph (edge list) if equal to \fB\-\fR (dash), read the edge list from STDIN (standard input)\. +. +.TP +\fIis_dir\fR +set either to \fB0\fR (zero) for undirected graphs, or to \fB1\fR (one) for directed graphs\. +. +.TP +\fIeps\fR +Required relative error on the approximation of the leading eigenvalue\. The program terminates when the relative change in the approximation of the eigenvalue is smaller than \fBeps\fR +. +.SH "EXAMPLES" +The following command: +. +.IP "" 4 +. +.nf + + $ pm er_1000_5000\.net 0 0\.0000001 +. +.fi +. +.IP "" 0 +. +.P +computes the leading eigenvalue and the corresponding eigenvector of the undirected graph stored in the file \fBer_1000_5000\.txt\fR\. We can store the leading eigenvector in a file, e\.g\. by using the command: +. +.IP "" 4 +. +.nf + + $ pm er_1000_5000\.net 0 0\.0000001 > er_1000_5000\.net_eig + 11\.0335794552533 + $ +. +.fi +. +.IP "" 0 +. +.P +which will save the leading eigenvector in the file \fBer_1000_5000\.net_eig\fR, one component for each row, and shown on output the leading eigenvalue of the graph\. +. +.SH "REFERENCES" +. +.IP "\(bu" 4 +V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Appendix 5, Cambridge University Press (2017) +. +.IP "" 0 +. +.SH "AUTHORS" +(c) Vincenzo \'KatolaZ\' Nicosia 2009\-2017 \fB<v\.nicosia@qmul\.ac\.uk>\fR\. |