summaryrefslogtreecommitdiff
path: root/doc/graph_info.1
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/graph_info.1
First commit on github -- NetBunch 1.0
Diffstat (limited to 'doc/graph_info.1')
-rw-r--r--doc/graph_info.148
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/graph_info.1 b/doc/graph_info.1
new file mode 100644
index 0000000..6eaaec3
--- /dev/null
+++ b/doc/graph_info.1
@@ -0,0 +1,48 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GRAPH_INFO" "1" "September 2017" "www.complex-networks.net" "www.complex-networks.net"
+.
+.SH "NAME"
+\fBgraph_info\fR \- Print basic information about a graph
+.
+.SH "SYNOPSIS"
+\fBgraph_info\fR \fIgraph_in\fR
+.
+.SH "DESCRIPTION"
+\fBgraph_info\fR prints the number of nodes, number of edges, average degree, and average squared degree of \fIgraph_in\fR\.
+.
+.SH "PARAMETERS"
+.
+.TP
+\fIgraph_in\fR
+undirected input graph (edge list)\. If is equal to \fB\-\fR (dash), read the edge list from STDIN\.
+.
+.SH "OUTPUT"
+The program prints on STDOUT a single line in the format:
+.
+.IP "" 4
+.
+.nf
+
+ N K avg_k avg_k2
+.
+.fi
+.
+.IP "" 0
+.
+.P
+where \fBN\fR is the number of nodes, \fBK\fR is the number of edges, \fBavg_k\fR is the average degree, and \fBavg_k2\fR is the average squared degree of \fIgraph_in\fR\.
+.
+.SH "SEE ALSO"
+clust(1)
+.
+.SH "REFERENCES"
+.
+.IP "\(bu" 4
+V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Cambridge University Press (2017)
+.
+.IP "" 0
+.
+.SH "AUTHORS"
+(c) Vincenzo \'KatolaZ\' Nicosia 2009\-2017 \fB<v\.nicosia@qmul\.ac\.uk>\fR\.