Debian Codegraph @

doc/clmmeet.azm

raw ◀ ▶
Source reconstructed at patch state 0 of 1 — not the installed (fully patched) source.
1 Debian patch touch this file
1 \import{mcx.zmm}
2
3 \begin{pud::man}{
4
5 {name}{clm meet}
6 {html_title}{The clm meet manual}
7 {author}{Stijn van Dongen}
8 {section}{1}
9 {synstyle}{long}
10 {defstyle}{long}
11
12 \man_share
13 }
14
15 \${html}{\"pud::man::maketoc"}
16
17 \sec{name}{NAME}
18 \NAME{clm meet}{compute the intersection of a set of clusterings.}
19
20 \disclaim_clm{meet}
21
22 \sec{synopsis}{SYNOPSIS}
23 \par{
24 \clm{meet}
25 \synoptopt{-o}{fname}{output file name}
26 \stdsynopt
27 <file name>+
28 }
29
30 \sec{description}{DESCRIPTION}
31
32 \par{
33 \clm{meet} computes the intersection of a set of clusterings, that is,
34 the largest clustering that is a subclustering of all the clusterings
35 in the set. It stores the intersection (or meet) in the argument
36 to the \genopt{-o} flag, which must be the first option given.
37 All remaining arguments are interpreted as names of files containing
38 clusterings in mcl format (see \mysib{mcxio}), which must all
39 pertain to a set of the same cardinality.
40 }
41
42 \par{
43 This utility can be useful in measuring (in conjunction with
44 \clmref{dist}) the consistency of a set of clusterings at different
45 levels of granularity \- if the meet of all those clusterings is close to
46 being a subclustering of each of them, consistency is good. See
47 \clmref{dist} for an example.
48 }
49
50
51 \sec{options}{OPTIONS}
52
53 \'begin{itemize}{\mcx_itemopts}
54
55 \item{\defopt{-o}{fname}{output file name}}
56 \stddefopt
57
58 \end{itemize}
59
60 \sec{author}{AUTHOR}
61 \par{
62 Stijn van Dongen.
63 }
64
65 \sec{seealso}{SEE ALSO}
66
67 \par{
68 \mysib{mclfamily} for an overview of all the documentation
69 and the utilities in the mcl family.
70 }
71
72 \end{pud::man}
73