gotst(1)

📦 version 7.0.7, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing

💖 gotst(1) — the Scotch user's manual, but make it cute 💖

okay bestie, so this is the manual page for gotst, from the Scotch user's manual, and it's genuinely one of those tools that's lowkey doing the most while looking like nothing. let's get into it 🫶

✨ NAME ✨

gomtst — compute statistics on sparse matrix orderings 💅

(yes, it says gomtst right there in the NAME, and we are NOT editing it, we are respecting the lore 🙈)

🌸 SYNOPSIS 🌸

gotst [options] [gfile] [ofile] [lfile]

🦋 DESCRIPTION 🦋

so gotst computes, in a sequential way, statistics on a sparse matrix ordering. it's giving... math girlie with a clipboard 📋✨

the stats it's out here collecting:

  • fill-in
  • operation count
  • separator tree parameters: minimum, maximum, average height, and variance of its leaves

that's the whole vibe. no cap.

source graph file gfile can only be a centralized graph file, okay? it cannot be anything else, don't even try it 🙅‍♀️

file ofile represents the ordering of the symmetric sparse matrix — and the pattern of that matrix is what gfile represents.

the resulting statistics get stored in file lfile. so that's the lil receipt of everything it found 🧾

when file names are not specified, data is read from standard input and written to standard output. and standard streams can also be explicitly represented by a dash '-', if you're the kind of person who likes to be explicit about things. we respect that. main character energy 💅

🎀 compressed graphs 🎀

when the proper libraries have been included at compile time, gtst can directly handle compressed graphs — both as input and as output. iconic behavior honestly ✨

a stream is treated as compressed whenever its name is postfixed with a compressed file extension, like in 'brol.grf.bz2' or '-.gz'.

the compression formats which can be supported are:

  • the bzip2 format ('.bz2')
  • the gzip format ('.gz')
  • the lzma format ('.lzma')
⚠️ okay so this part is real, please read it, i'm not being dramatic: since gotst performs sequentially the symbolic factorization of matrix gfile in order to compute fill-in and operation count numbers, this program can take a long time or even run out of memory when applied to very large graphs. like, it will simply perish 💀💀 so be aware. you've been warned, bestie.

👑 OPTIONS 👑

  • -h — display some help. lil helper 🫶
  • -v — do not account for vertex weights when computing factorization costs. so like, ignore the weights, keep it simple 💜
  • -V — display program version and copyright. the receipts of who made it 📜

🔥 EXAMPLE 🔥

display statistics on ordering brol.ord of graph brol.grf:

$ gotst brol.grf brol.ord

look at that. clean. no notes. ate and left no crumbs 🌈

🌟 SEE ALSO 🌟

also, the Scotch user's manual — go read her, she's the blueprint 💖

💜 AUTHOR 💜

Francois Pellegrini <francois.pellegrini@labri.fr>

and that's the whole page bestie!! this was the gotst(1) page from the Scotch user's manual, dated 02 September 2020 — go forth and compute those ordering statistics, you absolute legend 👑✨💅

📦 where this page comes from