gord(1)

📦 version 6.1.2, in epel 9, opensuse-leap 16.0

💅 gord(1) — the Scotch user's manual, but make it cute

okay bestie, pull up a chair, we're talking about gord from the Scotch user's manual ✨

🌸 NAME 🌸

gord — compute sparse matrix orderings of graphs. yes she ORDERS. she's the girl who reorganizes your whole friend group's seating chart and somehow it's better 🫶

🎀 SYNOPSIS 🎀

gord [options] [gfile] [ofile] [lfile]

🦋 DESCRIPTION 🦋

So. gord computes, in a sequential way, an ordering of a Scotch source graph that represents the pattern of some symmetric sparse matrix. that's the whole gig, that's her job, she's employed 💅

Your source graph file, gfile, can only be a centralized graph file. no decentralized shenanigans. the resulting ordering gets stashed in ofile, and any eventual logging info (like the stuff option -v produces) gets sent to lfile. 🌈

When you don't specify file names, data is read from standard input and written to standard output. and yes, standard streams can also be explicitely represented by a dash '-'. that's not me being quirky, that's literally what the manual says, dash = stream, periodt.

When the proper libraries have been included at compile time, gord can directly handle compressed graphs, both as input and output 🔥 A stream counts as compressed whenever its name is postfixed with a compressed file extension, like in 'brol.grf.bz2' or '-.gz'. The compression formats that can be supported are:

  • the bzip2 format ('.bz2')
  • the gzip format ('.gz')
  • the lzma format ('.lzma')

no cap, she'll unzip your whole life. 🧚

✨ OPTIONS ✨

  • -copt — Choose your default ordering strategy according to one or several options among:
    • b — enforce load balance as much as possible. fairness queen.
    • q — privilege quality over speed (default). she's a perfectionist, that's the vibe.
    • s — privilege speed over quality. fast and unbothered.
    • t — enforce safety. helmet on, bestie ⛑️
  • -h — Display some help. when you're lost, she's got you 🫶
  • -mmfile — Save column block mapping data to mfile. Mapping data specifies, for each vertex, the index of the column block to which this vertex belongs. very "everyone has a table" energy.
  • -ostrat — Use sequential graph ordering strategy strat (see the Scotch user's manual for more information). you want a specific strat? name her. 👑
  • -ttfile — Save partitioning tree data to tfile. Partitioning tree data specifies, for each vertex, the index of the first vertex of the parent block of the block to which the vertex belongs. Altogether with the mapping data provided in file mfile, it allows one to rebuild the separator tree of the nested dissection process. family tree but for math, obsessed 😭
  • -V — Display program version and copyright. show her some respect.
  • -vverb — Set verbose mode to verb. It is a set of one of more characters which can be:
    • s — strategy information. spill the tea about the strat.
    • t — timing information. how long did it take, we need to know ⏱️

💖 EXAMPLE 💖

Reorder matrix graph brol.grf and save the resulting ordering to file brol.ord using the default sequential graph ordering strategy:

$ gord brol.grf brol.ord

look at her go. ate that. 🍓

🌈 SEE ALSO 🌈

Scotch user's manual.

👑 AUTHOR 👑

Francois Pellegrini <francois.pellegrini@labri.fr>

okay that's the whole page bestie, you're welcome 💜 and a little sign-off for the record books: this was the gord(1) page from the Scotch user's manual, dated 23 November 2019. iconic, timeless, no notes. periodt. ✨🎀

📦 where this page comes from