SHMEM_COMPLEXF_PROD_TO_ALL(3)

📦

version 5.0.10 · 4 versions

💖 NAME 💖

okay bestie, gather round, because this page is serving a whole family of routines: shmem_comp4_prod_to_all(3), shmem_comp8_prod_to_all(3), shmem_complexd_prod_to_all(3), shmem_complexf_prod_to_all(3), shmem_double_prod_to_all(3), shmem_float_prod_to_all(3), shmem_int_prod_to_all(3), shmem_int4_prod_to_all(3), shmem_int8_prod_to_all(3), shmem_long_prod_to_all(3), shmem_longdouble_prod_to_all(3), shmem_longlong_prod_to_all(3), shmem_real8_prod_to_all(3), shmem_real16_prod_to_all(3), shmem_real4_prod_to_all(3), and shmem_short_prod_to_all(3).

and every single one of them Performs a product reduction across a set of processing elements (PEs). that's the assignment. that's the whole assignment. 💅

✨ SYNOPSIS ✨

C or C++:

#include <mpp/shmem.h>

void shmem_complexd_prod_to_all(double complex *target,
  const double complex *source, int nreduce, int PE_start,
  int logPE_stride, int PE_size, double complex *pWrk,
  long *pSync)

void shmem_complexf_prod_to_all(float complex *target,
  const float complex *source, int nreduce, int PE_start,
  int logPE_stride, int PE_size, float complex *pWrk,
  long *pSync)

void shmem_double_prod_to_all(double *target, const double *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  double *pWrk, long *pSync)

void shmem_float_prod_to_all(float *target, const float *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  float *pWrk, long *pSync)

void shmem_int_prod_to_all(int *target, const int *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  int *pWrk, long *pSync)

void shmem_long_prod_to_all(long *target, const long *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  long *pWrk, long *pSync)

void shmem_longdouble_prod_to_all(long double *target,
  const long double *source, int nreduce, int PE_start,
  int logPE_stride, int PE_size, long double *pWrk,
  long *pSync)

void shmem_longlong_prod_to_all(long long *target,
  const long long *source, int nreduce, int PE_start,
  int logPE_stride, int PE_size, long long *pWrk,
  long *pSync)

void shmem_short_prod_to_all(short *target, const short *source,
  int nreduce, int PE_start, int logPE_stride, int PE_size,
  short *pWrk, long *pSync)

Fortran:

INCLUDE "mpp/shmem.fh"

INTEGER pSync(SHMEM_REDUCE_SYNC_SIZE)
INTEGER nreduce, PE_start, logPE_stride, PE_size

CALL SHMEM_COMP4_PROD_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_COMP8_PROD_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_INT4_PROD_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_INT8_PROD_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_REAL4_PROD_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_REAL8_PROD_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

CALL SHMEM_REAL16_PROD_TO_ALL(target, source, nreduce, PE_start,
& logPE_stride, PE_size, pWrk, pSync)

🌸 DESCRIPTION 🌸

so the shared memory (SHMEM) reduction routines compute one or more reductions across symmetric arrays on multiple virtual PEs, no cap. a reduction is literally just an associative binary operation performed across a set of values. and if you want the full roster of other SHMEM reduction routines, go peek at intro_shmem(3). iykyk. 🦋

and because these are all SHMEM collective routines — same energy as every other collective — each one assumes that only the PEs in the active set call the routine. if a PE that is NOT in the active set calls a SHMEM collective routine, undefined behavior results. like, we don't do that here. 💀

the nreduce argument decides how many separate reductions we're doing. the source array on all PEs in the active set hands over one element for each reduction, and the results land in the target array on all PEs in the active set. the active set is defined by the PE_start, logPE_stride, PE_size triplet. iconic trio, honestly. 👑

and yes, source and target may be the same array — but they may not be overlapping arrays. okay?? noted.

the arguments are as follows:

target — a symmetric array of length nreduce elements that receives the results of the reduction operations. the data type of target varies with which version of the reduction routine you're calling and which language you're in. from C/C++, check the SYNOPSIS section for the data type tea. from Fortran, the target data types are:
- shmem_comp4_prod_to_all: Complex, with an element size equal to two 4-byte real values.
- shmem_comp8_prod_to_all: Complex, with an element size equal to two 8-byte real values.
- shmem_int4_prod_to_all: Integer, with an element size of 4 bytes
- shmem_int8_prod_to_all: Integer, with an element size of 8 bytes
- shmem_real4_prod_to_all: Real, with an element size of 4 bytes
- shmem_real8_prod_to_all: Real, with an element size of 8 bytes
- shmem_real16_prod_to_all: Real, with an element size of 16 bytes
source — a symmetric array, of length nreduce elements, that contains one element for each separate reduction operation. and bestie, source must have the same data type as target. matching fits only. 💖
nreduce — the number of elements in the target and source arrays. nreduce must be of type integer. if you're in Fortran, it must be a default integer value.
PE_start — the lowest virtual PE number of the active set of PEs. PE_start must be of type integer. if you're in Fortran, it must be a default integer value.
logPE_stride — the log (base 2) of the stride between consecutive virtual PE numbers in the active set. logPE_stride must be of type integer. if you're in Fortran, it must be a default integer value.
PE_size — the number of PEs in the active set. PE_size must be of type integer. if you're in Fortran, it must be a default integer value.
pWrk — a symmetric work array. pWrk must have the same data type as target. in C/C++, this contains max(nreduce/2 + 1, _SHMEM_REDUCE_MIN_WRKDATA_SIZE) elements. in Fortran, this contains max(nreduce/2 + 1, SHMEM_REDUCE_MIN_WRKDATA_SIZE) elements.
pSync — a symmetric work array. in C/C++, pSync is of type long and size _SHMEM_REDUCE_SYNC_SIZE. in Fortran, pSync is of type integer and size SHMEM_REDUCE_SYNC_SIZE. if you're in Fortran, it must be a default integer value. and before ANY of the PEs in the active set enter the reduction routine, every element of this array must be initialized with the value _SHMEM_SYNC_VALUE (in C/C++) or SHMEM_SYNC_VALUE (in Fortran). don't skip that part, fr fr.

the values of arguments nreduce, PE_start, logPE_stride, and PE_size must be equal on all PEs in the active set. and the same target and source arrays, plus the same pWrk and pSync work arrays, must be passed to all PEs in the active set. before any PE calls a reduction routine, you must ensure that the following conditions exist (synchronization via a barrier or some other method is often needed to ensure this):

the pWrk and pSync arrays on all PEs in the active set are not still in use from a prior call to a collective SHMEM routine.
the target array on all PEs in the active set is ready to accept the results of the reduction.

upon return from a reduction routine, the following are true for the local PE:

the target array is updated.
the values in the pSync array are restored to the original values.

📝 NOTES 📝

the terms collective, symmetric, and cache aligned are defined in intro_shmem(3). and here's a lil gift: all SHMEM reduction routines reset the values in pSync before they return, so a particular pSync buffer only needs to be initialized the first time it is used. we love an efficient queen. ✨

you MUST ensure that the pSync array is not being updated on any PE in the active set while any of the PEs participate in processing of a SHMEM reduction routine.

be careful of these situations, bestie:

if the pSync array is initialized at run time, some type of synchronization is needed to ensure that all PEs in the working set have initialized pSync before any of them enter a SHMEM routine called with the pSync synchronization array.
a pSync or pWrk array can be reused in a subsequent reduction routine call only if none of the PEs in the active set are still processing a prior reduction routine call that used the same pSync or pWrk arrays. in general, this can be assured only by doing some type of synchronization. however — in the special case of reduction routines being called with the same active set, you can allocate two pSync and pWrk arrays and alternate between them on successive calls. boom. hack unlocked. 🎀

🌈 EXAMPLES 🌈

Example 1: this Fortran example statically initializes the pSync array and finds the product of the real variable FOO across all the even PEs. she's doing the most and we respect it.

INCLUDE "mpp/shmem.fh"

INTEGER PSYNC(SHMEM_REDUCE_SYNC_SIZE)
DATA PSYNC /SHMEM_REDUCE_SYNC_SIZE*SHMEM_SYNC_VALUE/
PARAMETER (NR=1)
REAL FOO, FOOPROD, PWRK(MAX(NR/2+1,SHMEM_REDUCE_MIN_WRKDATA_SIZE))
COMMON /COM/ FOO, FOOPROD, PWRK
INTRINSIC MY_PE

IF ( MOD(MY_PE(),2) .EQ. 0) THEN
  CALL SHMEM_COMP8_PROD_TO_ALL(FOOPROD, FOO, NR, 0, 1, N$PES/2,
  & PWRK, PSYNC)
  PRINT *, 'Result on PE ', MY_PE(), ' is ', FOOPROD
ENDIF

Example 2: consider the following C/C++ call:

shmem_short_prod_to_all(target, source, 3, 0, 0, 8, pwrk, psync);

the preceding call is more efficient, but semantically equivalent to, the combination of the following calls:

shmem_short_prod_to_all(&(target[0]), &(source[0]), 1, 0, 0, 8,
  pwrk1, psync1);
shmem_short_prod_to_all(&(target[1]), &(source[1]), 1, 0, 0, 8,
  pwrk2, psync2);
shmem_short_prod_to_all(&(target[2]), &(source[2]), 1, 0, 0, 8,
  pwrk1, psync1);

note that two sets of pWrk and pSync arrays are used alternately because no synchronization is done between calls. alternating icon behavior, honestly. 💅

👀 See also 👀

intro_shmem(3)

💜 Copyright 💜

2003-2026, The Open MPI Community

aaaand that's the whole page, bestie!! 🫶 go forth and multiply (the products, obviously, across your active set of PEs). this iconic lil manual brought to you by the Open MPI girlies, dated Sep 10, 2026 — SHMEM_COMPLEXF_PROD_TO_ALL(3), no cap. 💖✨🎀

📦 where this page comes from

ubuntu stonking: openmpi-doc 5.0.10-6 · other
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-11-03: a language model's rewrite of the original, under its terms