CLMRESIDUE(1)

💖 clm residue(1) 💖

okay bestie, so this is the clm residue mode — that's part of the clm manual family, and it's literally the glow-up era of clustering. 🦋

✨ NAME ✨

clm_residue — extend clustering of subgraph to clustering of graph. 💅

real talk though: clmresidue is not in actual fact a program. this page just documents the behaviour and options of the clm program when you invoke it in mode residue. and just so you know, the options -h, --apropos, --version, -set, and --nop are accessible in all clm modes — they get their own whole description over in the clm manual page. slay, consistency. 👑

---

🌸 SYNOPSIS 🌸

clm residue -icl fname (input clustering) -imx fname (input graph) [-rpm fname (residue projection matrix)] [-o fname (output clustering file)]

---

🎀 DESCRIPTION 🎀

so here's the vibe. the cluster file presumably contains a clustering of a subgraph of the graph G contained by the matrix file — meaning the row domain of that clustering is a subset of the node domain of the graph. lowkey a glow-up in progress. ✨

clm residue will compute a simple upwards projection of that clustering, resulting in a clustering of G. that's it, that's the whole job. iconic behaviour, no notes. 💖

---

💜 OPTIONS 💜

• -imx fname — (input graph). the graph bestie, your main character matrix. 🌈
• -icl fname — (input clustering). the clustering you're starting from. 🎀
• -rpm fname — (residue projection matrix). this is the name for the file where the residue projection matrix gets 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 out.rpm. 💾
• -o fname — (output clustering file). the name for the file where the majority vote projection clustering is stored. aka the majority vote projection clustering storage file name. 🫶

okay so this one 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. no empty clusters allowed, we don't do that here. 💀

by default, output is sent to STDOUT. 📤

---

👑 AUTHOR 👑

Stijn van Dongen. (the og, the blueprint, fr fr. 🫡)

---

🦋 SEE ALSO 🦋

mclfamily(7) for an overview of all the documentation and the utilities in the mcl family. go read it bestie, iykyk. 💖

---

ok that's the whole page!! 🎀 no cap, every flag, every default, every little detail stayed exactly where it belongs. periodt. 💅

source/version: clm residue 22-282 ✨ date: 9 Oct 2022 🌸 mwah, love u, go cluster something beautiful 💖🦋✨