Recent changes to UserGuide

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 14:38:05 -0000

--- v10
+++ v11
@@ -21,7 +21,7 @@
 * `-p` Specifies to use the proof-of-concept method COSpoc rather than **COS**. Since **COS** is *faster* than COSpoc, it is recommended to use this option only for benchmark purposes. With this option, `-W` is ignored.
 * `-h` Prints the help and exits.
 * `-d` If `cos` is compiled with the `DEBUG` macro (see [SetupAndCompile]), set the debug level. Otherwise it is ignored and a warning message is printed on `stdout`. This parameter can be passed from zero (no debug) to four (maximum verbosity level) times. Each time the parameter is passed, the verbosity level of the debug is increased by one.
-* `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers. *You might want to have a look at [ListingMaximalCliques] if you are looking for a program that lists all the maximal cliques and delivers as output a file in this format*
+* `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers. *You might want to have a look at [MaximalCliquesListing] if you are looking for a program that lists all the maximal cliques and delivers as output a file in this format*
 
 ##### Usage Examples #####
     ./cos

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 13:49:46 -0000

--- v9
+++ v10
@@ -21,7 +21,7 @@
 * `-p` Specifies to use the proof-of-concept method COSpoc rather than **COS**. Since **COS** is *faster* than COSpoc, it is recommended to use this option only for benchmark purposes. With this option, `-W` is ignored.
 * `-h` Prints the help and exits.
 * `-d` If `cos` is compiled with the `DEBUG` macro (see [SetupAndCompile]), set the debug level. Otherwise it is ignored and a warning message is printed on `stdout`. This parameter can be passed from zero (no debug) to four (maximum verbosity level) times. Each time the parameter is passed, the verbosity level of the debug is increased by one.
-* `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers.
+* `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers. *You might want to have a look at [ListingMaximalCliques] if you are looking for a program that lists all the maximal cliques and delivers as output a file in this format*
 
 ##### Usage Examples #####
     ./cos

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 12:19:12 -0000

--- v8
+++ v9
@@ -45,7 +45,6 @@
     ./cos -p 
 Run the program with 8 parallel threads and a 1 GB sliding window buffer, using the proof-of-concept method COSpoc.
 
-
 Output Files
 -------------------------

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 12:15:36 -0000

--- v7
+++ v8
@@ -23,6 +23,29 @@
 * `-d` If `cos` is compiled with the `DEBUG` macro (see [SetupAndCompile]), set the debug level. Otherwise it is ignored and a warning message is printed on `stdout`. This parameter can be passed from zero (no debug) to four (maximum verbosity level) times. Each time the parameter is passed, the verbosity level of the debug is increased by one.
 * `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers.
 
+##### Usage Examples #####
+    ./cos 
+Run the program with 8 parallel threads and a 1 GB sliding window buffer.
+
+
+    ./cos -P 80 
+Run the program with 80 parallel threads.
+
+
+    ./cos -P 80 -W 32 
+Run the program with 80 parallel threads and a 2**32 B = 4 GB sliding window buffer.
+
+    ./cos -d 
+Run the program with minimum debug info.
+
+    ./cos -d -d -d -d 
+Run the program with maximum debug info.
+
+
+    ./cos -p 
+Run the program with 8 parallel threads and a 1 GB sliding window buffer, using the proof-of-concept method COSpoc.
+
+
 Output Files
 -------------------------

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 12:05:58 -0000

--- v6
+++ v7
@@ -22,3 +22,23 @@
 * `-h` Prints the help and exits.
 * `-d` If `cos` is compiled with the `DEBUG` macro (see [SetupAndCompile]), set the debug level. Otherwise it is ignored and a warning message is printed on `stdout`. This parameter can be passed from zero (no debug) to four (maximum verbosity level) times. Each time the parameter is passed, the verbosity level of the debug is increased by one.
 * `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers.
+
+Output Files
+-------------------------
+
+For each *k* such that at least one *k*-clique community exists, a file named
+k_comunities.txt is output in the current working directory.
+Each line of the file has the format
+
+    :
+
+Where:
+
+* `` Is an integer number in the range \[0, (Nk-1)\], where Nk is the number of *k*-clique communities discovered for a given *k*. This integer uniquely identifies the community.
+* `` Is a whistespace-separated list of nodes belonging to one input maximal clique, which is part of *k*-clique community identified by <community_id>
+
+In addition, a summary file containing the number of maximal cliques discovered for each *k* is output as well. Each line of this file, named k_num_communities.txt, has the format
+
+    k     Nk
+
+Where Nk is the number of *k*-clique communities discovered for a given *k*.

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 10:09:48 -0000

--- v5
+++ v6
@@ -18,7 +18,7 @@
 
 * `-P ` Specifies the number of *parallel threads* to be executed. Default value is 8.
 * `-W ` Set the sliding window buffer size to 2\*\*<exp> Bytes. Default value is 30 for a sliding window buffer size of 2\*\*30 B = 1 GB.
-* `-p` Specifies to use the proof-of-concept method COSpoc rather than **COS**. Since **COS** is *faster* than COSpoc, it is recommended to use this option only for benchmark purposes. With this option, -W is ignored.
+* `-p` Specifies to use the proof-of-concept method COSpoc rather than **COS**. Since **COS** is *faster* than COSpoc, it is recommended to use this option only for benchmark purposes. With this option, `-W` is ignored.
 * `-h` Prints the help and exits.
 * `-d` If `cos` is compiled with the `DEBUG` macro (see [SetupAndCompile]), set the debug level. Otherwise it is ignored and a warning message is printed on `stdout`. This parameter can be passed from zero (no debug) to four (maximum verbosity level) times. Each time the parameter is passed, the verbosity level of the debug is increased by one.
 * `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers.

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 10:08:57 -0000

--- v4
+++ v5
@@ -16,10 +16,9 @@
 
 Where:
 
-* `-P ` Specifies the number of parallel threads to be executed. Default value is 8.
+* `-P ` Specifies the number of *parallel threads* to be executed. Default value is 8.
 * `-W ` Set the sliding window buffer size to 2\*\*<exp> Bytes. Default value is 30 for a sliding window buffer size of 2\*\*30 B = 1 GB.
-* `-p` Specifies to use the proof-of-concept method COSpoc rather than COS.
-                   With this option, parameter -W is ignored.
+* `-p` Specifies to use the proof-of-concept method COSpoc rather than **COS**. Since **COS** is *faster* than COSpoc, it is recommended to use this option only for benchmark purposes. With this option, -W is ignored.
 * `-h` Prints the help and exits.
 * `-d` If `cos` is compiled with the `DEBUG` macro (see [SetupAndCompile]), set the debug level. Otherwise it is ignored and a warning message is printed on `stdout`. This parameter can be passed from zero (no debug) to four (maximum verbosity level) times. Each time the parameter is passed, the verbosity level of the debug is increased by one.
 * `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers.

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 10:04:48 -0000

--- v3
+++ v4
@@ -6,23 +6,20 @@
 
     ./cos -h
 
+
+
 Usage
 ---------------------------
 **COS** executable accepts the following command-line arguments:
 
     ./cos [-P ] [-W ] [-p] [-d] 
 
+Where:
 
-* `-P ` \t Specifies the number of parallel threads to be executed. Default value is 8.
-* `-W `          Set the sliding window buffer size to 2** Bytes.
-                   Default value is 30 for a sliding window buffer size of 2**30 B = 1 GB.
- -p                Specifies to use the proof-of-concept method COSpoc rather than COS.
+* `-P ` Specifies the number of parallel threads to be executed. Default value is 8.
+* `-W ` Set the sliding window buffer size to 2\*\*<exp> Bytes. Default value is 30 for a sliding window buffer size of 2\*\*30 B = 1 GB.
+* `-p` Specifies to use the proof-of-concept method COSpoc rather than COS.
                    With this option, parameter -W is ignored.
- -h                Prints this help and exits.
- -d                Set the debug level. This parameter can be passed from zero (no debug) to
-                   four (maximum verbosity level) times. Each time the parameter is passed,
-                   the verbosity level of the debug is increased by one.
-   A file containing a list of maximal cliques, one per line. Each maximal
-                   clique must be expressed as a whitespace-separated list of its nodes 
-                   and must end with a virtual node -1. Nodes must be expressed as non-negative
-                   integer numbers.
+* `-h` Prints the help and exits.
+* `-d` If `cos` is compiled with the `DEBUG` macro (see [SetupAndCompile]), set the debug level. Otherwise it is ignored and a warning message is printed on `stdout`. This parameter can be passed from zero (no debug) to four (maximum verbosity level) times. Each time the parameter is passed, the verbosity level of the debug is increased by one.
+* `` A file containing a list of maximal cliques, one per line. Each maximal clique must be expressed as a whitespace-separated list of its nodes and must end with a virtual node -1. Nodes must be expressed as non-negative integer numbers.

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 09:49:29 -0000

--- v2
+++ v3
@@ -8,12 +8,13 @@
 
 Usage
 ---------------------------
+**COS** executable accepts the following command-line arguments:
 
     ./cos [-P ] [-W ] [-p] [-d] 
 
 
-* `-P `  Specifies the number of parallel threads to be executed. Default value is 8.
- -W           Set the sliding window buffer size to 2** Bytes.
+* `-P ` \t Specifies the number of parallel threads to be executed. Default value is 8.
+* `-W `          Set the sliding window buffer size to 2** Bytes.
                    Default value is 30 for a sliding window buffer size of 2**30 B = 1 GB.
  -p                Specifies to use the proof-of-concept method COSpoc rather than COS.
                    With this option, parameter -W is ignored.

WikiPage UserGuide modified by Simone Mainardi

Simone Mainardi — Wed, 27 Jun 2012 09:47:04 -0000

--- v1
+++ v2
@@ -2,6 +2,26 @@
 
 Running **COS**
 ===========================
-Run the executable `cos` without parameters or with a `-h` to get useful information about usage, parameters, input and output files format, etc.
+Run the executable `cos` without parameters or with a `-h` to get useful information about usage, command-line arguments, input and output files format, etc.
 
     ./cos -h
+
+Usage
+---------------------------
+
+    ./cos [-P ] [-W ] [-p] [-d] 
+
+
+* `-P `  Specifies the number of parallel threads to be executed. Default value is 8.
+ -W           Set the sliding window buffer size to 2** Bytes.
+                   Default value is 30 for a sliding window buffer size of 2**30 B = 1 GB.
+ -p                Specifies to use the proof-of-concept method COSpoc rather than COS.
+                   With this option, parameter -W is ignored.
+ -h                Prints this help and exits.
+ -d                Set the debug level. This parameter can be passed from zero (no debug) to
+                   four (maximum verbosity level) times. Each time the parameter is passed,
+                   the verbosity level of the debug is increased by one.
+   A file containing a list of maximal cliques, one per line. Each maximal
+                   clique must be expressed as a whitespace-separated list of its nodes 
+                   and must end with a virtual node -1. Nodes must be expressed as non-negative
+                   integer numbers.