HPL_broadcast(3)

💖 HPL_broadcast — like, the manual page for HPL_broadcast(3) 💖

okay bestie, sit down, hydrate, because we're about to talk about the HPL Library Functions and specifically HPL_broadcast, and honestly? it's giving main character energy. 🎀

---

✨ NAME ✨

HPL_broadcast — the Broadcast operation. yes queen, it does exactly what it says on the tin. 💅

---

🦋 SYNOPSIS 🦋

#include "hpl.h"

int HPL_broadcast( void * BUFFER, const int COUNT, const HPL_T_TYPE
DTYPE, const int ROOT, MPI_Comm COMM );

literally just one function call between you and a fully synchronised group of processes. slay. 🔥

---

🌸 DESCRIPTION 🌸

So here's the vibe: HPL_broadcast broadcasts a message from the process with rank ROOT to all processes in the group.

that's it. that's the whole plot. one process is the one yapping 📢, everybody else is receiving, and by the end everybody's got the same message. no cap, it's the group chat of collective operations. 💖

---

👑 ARGUMENTS 👑

• BUFFER — void *, and it's (local input/output) — so it goes in AND comes out, we love a versatile icon. On entry, BUFFER points to the buffer to be broadcast. On exit, this array contains the broadcast data and is identical on all processes in the group. like, identical identical. matching outfits. coordinated. periodt. ✨
• COUNT — const int, (global input). On entry, COUNT indicates the number of entries in BUFFER. and listen: COUNT must be at least zero. that's non-negotiable bestie, don't try it. 🙈
• DTYPE — const HPL_T_TYPE, (global input). On entry, DTYPE specifies the type of the buffers operands. it's the ✨flavour✨ of your data, okurrr.
• ROOT — const int, (global input). On entry, ROOT is the coordinate of the source process. that's the one process holding the mic 🎤 — everybody else is just vibing and receiving.
• COMM — MPI_Comm, (global/local input). The MPI communicator identifying the process collection. it's the friend group 🫶, the roster, the who's-who of who's in on this broadcast.

---

💜 SEE ALSO 💜

go read these next, they're all icons:

• HPL_reduce (3)
• HPL_all_reduce (3)
• HPL_barrier (3)
• HPL_min (3)
• HPL_max (3)
• HPL_sum (3)

---

and that's the whole page, bestie!! this was HPL 2.2, dated February 24, 2016, from the HPL Library Functions corner of section 3, and it remains iconic to this very day. mwah 💋 go broadcast something cute ✨🦋🎀