MPI_DUP_FN(3)

📦
version 7.1.4 · 4 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 MPI_DUP_FN — the LAM/MPI manual page, bestie edition 💖

okay so we're looking at MPI_DUP_FN(3) from the LAM/MPI manual, and honestly? it's giving "vintage", it's giving "they deprecated her but she still shows up". let's get into it 🫶

✨ NAME ✨

MPI_DUP_FN — a built-in MPI function that simple-mindedly copies communicator attributes. yes, "simple-mindedly" is the official wording, and yes, she owns it 💅

✨ SYNOPSIS ✨

#include <mpi.h>
int MPI_DUP_FN(MPI_Comm comm, int key, void *extra,
               void *attrin, void *attrout, int *flag)

🌸 INPUT PARAMETERS 🌸

  • comm — communicator (handle). it's the group chat you're operating on 💬
  • key — key value (integer). the lil name tag on the attribute ✨
  • extra — extra state. the baggage, the lore, the extras 🎀
  • attrin — in value for attribute. what's coming in 📥

🦋 OUTPUT PARAMETERS 🦋

  • attrout — out value for attribute. what goes back out 📤
  • flag — 1 if attribute copied successfully, 0 otherwise (logical). basically a vibe check on whether the copy worked 😌

💀 NOTES 💀

This function is deprecated. no cap. she's been replaced.

She's been replaced with an MPI-2 function (peep the "See also" section down below 👇) which provides the same functionality. And honestly? This function is (or effectively is) a wrapper to the replacement function anyway. So user programs should use the MPI-2 replacement function instead of this one. fr fr.

Some functions get deprecated because their names did not conform to the stricter naming conventions of MPI-2; others get deprecated because they've been replaced with more flexible functionality. either way, it's giving "we love you but use the new one" 😭

👀 SEE ALSO 👀

  • MPI_COMM_DUP_FN

🌈 ADDITIONAL 🌈

Note that the C typedefs MPI_Copy_function and MPI_MPI_Delete_function are also deprecated, in favor of their new names — MPI_Comm_copy_function , MPI_Comm_delete_function .

Additionally, the MPI constants MPI_NULL_COPY_FN and MPI_NULL_DELETE_FN are also deprecated in favor of their new names — MPI_COMM_NULL_COPY_FN and MPI_COMM_NULL_DELETE_FN .

(yes those are the exact names, and yes one of them is literally spelled MPI_MPI_Delete_function, i am not touching that, i am simply reporting 🫡)

🔥 MORE INFORMATION 🔥

For more information, please see the official MPI Forum web site, which contains the text of both the MPI-1 and MPI-2 standards. These documents contain detailed information about each MPI function (most of which is not duplicated in these man pages).

http://www.mpi-forum.org/

🎀 ACKNOWLEDGEMENTS 🎀

The LAM Team would like the thank the MPICH Team for the handy program to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sowing/sowing.tar.gz ), the initial formatting, and some initial text for most of the MPI-1 man pages.

(also yes, the original says "would like the thank" and not "would like to thank" — we preserve, we don't edit, that's the whole brand 💜)

👑 LOCATION 👑

dupfn.c

and that's the whole page, bestie. LAM/MPI 7.1.4, dated 6/24/2006 — an absolute icon, still serving deprecated realness from way back. periodt. 💅✨

📦 where this page comes from