HPL_recv(3)

💖 HPL_recv 💖

okay so bestie, welcome to HPL_recv from the HPL Library Functions — she's a lil function, she receives a message, and honestly? she's giving "quiet overachiever." 🎀

---

✨ NAME ✨

HPL_recv — receive a message. that's it, that's the whole job. 💅

---

🌸 SYNOPSIS 🌸

#include "hpl.h"

int HPL_recv( double * RBUF, int RCOUNT, int SRC, int RTAG, MPI_Comm
COMM );

---

🦋 DESCRIPTION 🦋

so like, HPL_recv is a simple little wrapper around MPI_Recv. her whole main character purpose is to let you do some experimentation / tuning of this simple routine, iykyk. 🔬✨

when she finishes successfully, you'll know because she hands you back the error code HPL_SUCCESS. 🫶

and here's the lil detail that matters: if the messages are of length less than or equal to zero, this function returns immediately — no waiting around, no drama, she's out. 💀

---

👑 ARGUMENTS 👑

• RBUF — (local output) double * — on entry, RBUF specifies the starting address of the buffer to be received. literally the destination, bestie. 📥
• RCOUNT — (local input) int — on entry, RCOUNT specifies the number of double precision entries in RBUF. and listen — RCOUNT must be at least zero. no negatives, we don't do that here. 🚫
• SRC — (local input) int — on entry, SRC specifies the rank of the sending process in the communication space defined by COMM. that's your pen pal's address, basically. 💌
• RTAG — (local input) int — on entry, the page says STAG specifies the message tag to be used for this communication operation. (yes girl, the manpage really wrote STAG there while the argument is RTAG — we're just reporting the lore exactly as it was handed down, no cap. 🙈)
• COMM — (local input) MPI_Comm — the MPI communicator identifying the communication space. this is the group chat. the whole vibe. 🌈

---

💜 SEE ALSO 💜

• HPL_send (3)
• HPL_sendrecv (3)

---

and that's the whole page, bestie — go forth and receive responsibly. 🧚✨

this lil dispatch came to you courtesy of HPL 2.2, dated February 24, 2016 — vintage, iconic, still slaying. 💖