RCCE_bcast.3 812 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .TH RCCE 3 2010-02-04 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_bcast \- RCCE broadcast function
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_bcast(char * " buf ",size_t " number ",int " root ",RCCE_comm " comm );
  8. .SH DESCRIPTION
  9. .BR RCCE_bcast()
  10. copies number bytes at address buf on the UE with
  11. rank root to address buf on all other UEs in communicator comm.
  12. .TP
  13. .B buf
  14. Starting address of input array (private memory).
  15. .TP
  16. .B number
  17. Number of bytes to be sent.
  18. .TP
  19. .B root
  20. Rank of the UE that is the source of the message.
  21. .TP
  22. .B comm
  23. Communicator whose UEs receive the message.
  24. .SH "RETURN VALUE"
  25. Upon successful completion
  26. .BR RCCE_bcast()
  27. returns
  28. .BR RCCE_SUCCESS .
  29. .SH ERRORS
  30. Look in
  31. .BR rcce.h
  32. for additional error codes.
  33. .SH "SEE ALSO"
  34. rcce.h(5)
  35. .SH EXAMPLE
  36. .PP
  37. To be supplied.