summaryrefslogtreecommitdiff
path: root/doc/largest_component.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/largest_component.1
First commit on github -- NetBunch 1.0
Diffstat (limited to 'doc/largest_component.1')
-rw-r--r--doc/largest_component.150
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/largest_component.1 b/doc/largest_component.1
new file mode 100644
index 0000000..2251849
--- /dev/null
+++ b/doc/largest_component.1
@@ -0,0 +1,50 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "LARGEST_COMPONENT" "1" "September 2017" "www.complex-networks.net" "www.complex-networks.net"
+.
+.SH "NAME"
+\fBlargest_component\fR \- Find largest connected component of a graph
+.
+.SH "SYNOPSIS"
+\fBlargest_component\fR \fIgraph_in\fR
+.
+.SH "DESCRIPTION"
+\fBlargest_component\fR computes the largest connected component of \fIgraph_in\fR, and prints on STDOUT the corresponding edge list\.
+.
+.SH "PARAMETERS"
+.
+.TP
+\fIgraph_in\fR
+undirected input graph (edge list)\. If it is equal to \fB\-\fR (dash), read the edge list from STDIN\.
+.
+.SH "OUTPUT"
+The program prints on STDOUT the edge list of the largest connected component of \fIgraph_in\fR, in the format:
+.
+.IP "" 4
+.
+.nf
+
+ i_1 j_1
+ i_2 j_2
+ \.\.\.\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+components(1), node_components(1), strong_conn(1)
+.
+.SH "REFERENCES"
+.
+.IP "\(bu" 4
+V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Chapter 6, Cambridge University Press (2017)
+.
+.IP "\(bu" 4
+V\. Latora, V\. Nicosia, G\. Russo, "Complex Networks: Principles, Methods and Applications", Appendix 8, Cambridge University Press (2017)
+.
+.IP "" 0
+.
+.SH "AUTHORS"
+(c) Vincenzo \'KatolaZ\' Nicosia 2009\-2017 \fB<v\.nicosia@qmul\.ac\.uk>\fR\.