File: clmresidue.1

package info (click to toggle)
mcl 1%3A06-021-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 5,276 kB
  • ctags: 2,975
  • sloc: ansic: 32,352; sh: 3,556; perl: 1,437; makefile: 338
file content (88 lines) | stat: -rw-r--r-- 2,613 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.\" Copyright (c) 2006 Stijn van Dongen
.TH "clmresidue" 1 "21 Jan 2006" "clmresidue 1\&.006, 06-021" "USER COMMANDS "
.po 2m
.de ZI
.\" Zoem Indent/Itemize macro I.
.br
'in +\\$1
.nr xa 0
.nr xa -\\$1
.nr xb \\$1
.nr xb -\\w'\\$2'
\h'|\\n(xau'\\$2\h'\\n(xbu'\\
..
.de ZJ
.br
.\" Zoem Indent/Itemize macro II.
'in +\\$1
'in +\\$2
.nr xa 0
.nr xa -\\$2
.nr xa -\\w'\\$3'
.nr xb \\$2
\h'|\\n(xau'\\$3\h'\\n(xbu'\\
..
.if n .ll -2m
.am SH
.ie n .in 4m
.el .in 8m
..
.SH NAME
clmresidue \- extend clustering of subgraph to clustering of graph\&.
.SH SYNOPSIS

\fBclmresidue\fP
\fB-icl\fP fname (\fIinput clustering\fP)
\fB-imx\fP fname (\fIinput graph\fP)
\fB[-rpm\fP fname (\fIresidue projection matrix\fP)\fB]\fP
\fB[--adapt\fP (\fIallow domain mismatch\fP)\fB]\fP
\fB[-mvp\fP fname (\fImajority vote projection (clustering)\fP)\fB]\fP
.SH DESCRIPTION

The cluster file presumably contains a clustering of a subgraph of the
graph\ \fCG\fP contained by the matrix file, implying that the row domain of
that clustering is a subset of the node domain of the graph\&. clmresidue will
compute a simple upwards projection of that clustering, resulting in a
clustering of\ \fCG\fP\&.
.SH OPTIONS

.ZI 3m "\fB-rpm\fP fname (\fIresidue projection matrix\fP)"
\&
.br
The name for the file in which the residue projection matrix is stored\&.
It contains for each node and for each cluster in the input clustering
the combined weight of the (edges to the) neighbours of that node
in that cluster\&.

The default output file name is \fCout\&.rpm\fP\&.
.in -3m

.ZI 3m "\fB-mvp\fP fname (\fImajority vote projection (clustering)\fP)"
\&
.br
The name for the file in which the majority vote projection clustering
is stored\&. Aka the majority vote projection clustering storage file name\&.

This embodies a very crude approach to distributing the missing nodes in the
input clustering onto that same cluster\&. For each node, the cluster is
taken for which the residue projection is the largest (see above)\&. The
residue (i\&.e\&. the set of missing nodes) is initially viewed as a cluster;
the set of nodes for which the projection is largest for the residue itself
will form a new cluster, if it is not empty\&.

The default output file name is \fCout\&.mvp\fP\&.
.in -3m

.ZI 3m "\fB--adapt\fP (\fIallow domain mismatch\fP)"
\&
.br
Allow the clustering domain to contain nodes not present in the graph
domain\&. \fBclmresidue\fP will take the appropriate subclustering\&.
.in -3m
.SH AUTHOR

Stijn van Dongen\&.
.SH SEE ALSO

\fBmclfamily(7)\fP for an overview of all the documentation
and the utilities in the mcl family\&.