allpairs_multicore(1)

🌸 allpairs_multicore 🌸

okay bestie 💖 this is the manual for allpairs_multicore, a tool from the Cooperative Computing Tools 🎀 and yes it is as iconic as it sounds.

---

✨ NAME ✨

allpairs_multicore - runs the All-Pairs workflow in parallel on a multicore machine 💅

---

🧚 SYNOPSIS 🧚

allparis_multicore [options] <set A> <set B> <compare function>

---

💜 DESCRIPTION 💜

okay so allpairs_multicore takes two sets, <set A> and <set B>, and computes the Cartesian product of them 🌈 (aka every possible pairing, no cap). It builds a matrix where each cell M[i,j] holds the output of the function F (<compare function>) run on A[i] (an item in <set A>) and B[j] (an item in <set B>). The whole matrix gets printed to standard output, one comparison result per line, along with the associated X and Y indices. 🦋

for big sets, it uses as many cores as you have available and carefully manages virtual memory to exploit locality and avoid thrashing 🔥 that's the main character energy right there. because of this, you should be prepared for the results to come back in any order 🙈

bestie, the results can literally show up in any order, so don't go expecting them to be sorted. 💀

if you want to go even harder and get the parallelism of All-Pairs workflows across multiple (multicore) machines, check out allpairs_master(1) 🚀

---

🎀 OPTIONS 🎀

• -b, --block-size=<items> — this is how many items you want held in memory at once 🧠 (default: 50% of RAM)
• -c, --cores=<cores> — how many cores you want it to use 💪 (default: # of cores in machine)
• -e, --extra-args=<args> — extra arguments you want passed along to the comparison program 🍓
• -d, --debug=<flag> — turns on debugging for this subsystem 🔍
• -v, --version — shows the program version ✨
• -h, --help — displays this message 🫶

---

🚦 EXIT STATUS 🚦

on success, it returns zero 🥳 on failure, it returns non-zero 😭

---

📸 EXAMPLES 📸

okay let's say you have a whole lot of files you want to compare to each other, named a, b, c, and so on 🌸 and you also have a program called compareit that, when invoked as compareit a b, compares files a and b and spits out some output summarizing the difference between the two, like this:

a b are 45 percent similar

to use the allpairs framework, make a file called set.list that lists each of your files, one per line:

a
b
c
...

then invoke allpairs_multicore like this:

% allpairs_multicore set.list set.list compareit

the framework will carry out all possible comparisons of the objects and print the results one by one 💅 (note that the first two columns are the X and Y indices in the resulting matrix):

1    1    a a are 100 percent similar
1    2    a b are 45 percent similar
1    3    a c are 37 percent similar
...

---

🦋 COPYRIGHT 🦋

The Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame. 💜 This software is distributed under the GNU General Public License. See the file COPYING for details 📜

---

🔗 SEE ALSO 🔗

• The Cooperative Computing Tools ("http://ccl.cse.nd.edu/software/manuals")
• All-Pairs User Manual ("http://ccl.cse.nd.edu/software/manuals/allpairs.html")
• allpairs_master(1)

---

bestie that's the whole tea ☕🫶 this page came from CCTools 8.0.0 DEVELOPMENT, and the manual is allpairs_multicore(1). love you, mwah 💋🌈✨