sc::ExEnv(3)

📦
version 2.3.1 · 4 versions
, in ubuntu jammy

okay so this is sc::ExEnv(3) from the MPQC manual, and it's literally the vibe-check class for figuring out how your program is being run — like, who are you, where are you, how many CPUs are you working with, all that. bestie, it's giving "main character energy" for runtime info. 💅✨

💖 NAME 💖

sc::ExEnv — the ExEnv class is used to find out about how the program is being run. periodt. 🫶

✨ SYNOPSIS ✨

#include <exenv.h>

🌸 Static Public Member Functions 🌸

  • static void init (int &argcref, char **&argvref) — sets the argument count and vector. like, this is where you hand over argc and argv. 🎀
  • static int initialized () — returns nonzero if ExEnv has been initialized. zero means nope, not yet. 💀
  • static int & argc () — returns a reference to the argument count. yes, a reference. int &. iconic. 🔥
  • static char **& argv () — returns a reference to the argument vector. char **&, no cap. 👑
  • static const char * program_name () — returns argv[0] with the path removed. so just the program's little name, slaying on its own. 💖
  • static const char * hostname () — returns the host name. where you at, bestie? 🦋
  • static const char * username () — returns the user name. who you are, iykyk. 🌸
  • static void set_out (std::ostream *o) — the original gives no description here, so i'm not gonna invent one. it's just listed, and we respect that. 💅
  • static std::ostream & outn () — returns an ostream that writes from all nodes. all of them. every single one. 🌈
  • static std::ostream & errn () — returns an ostream for error messages that writes from all nodes. errors, but make it multi-node. 😭
  • static std::ostream & out0 () — returns an ostream that writes from node 0. just node 0. VIP behavior. ⭐
  • static std::ostream & err0 () — returns an ostream for error messages that writes from node 0. node 0 gets the error tea. 🍓
  • static size_t memory () — the amount of memory on this node. how much room you've got, literally. 🧚
  • static int nproc () — the number of processors on this node. how many little workers are out here doing the most. 💜

🦋 Static Protected Attributes 🦋

  • static int initialized_
  • static int * argc_
  • static char *** argv_
  • static char hostname_ [256]
  • static char username_ [9]
  • static size_t mem_
  • static int nproc_
  • static std::ostream * out_
  • static std::ostream * nullstream_

like, these are the protected internals — the backstage pass. don't touch unless you're supposed to. 🙈

💫 Detailed Description 💫

the ExEnv class is used to find out about how the program is being run. that's the whole assignment, bestie. no extra lore, no side quests. it's just here to tell you the runtime tea. ☕✨

🎀 Author 🎀

Generated automatically by Doxygen for MPQC from the source code. so technically the author is Doxygen, which is a whole mood. 🤖💖

and that's the page! Version 2.3.1, dated Sun Oct 4 2020 — oldie but a goodie. bye bestie, go check your nproc() and slay. 💅🫶🌸

📦 where this page comes from