Changes between Version 18 and Version 19 of Libraries

Timestamp:

05/25/23 21:52:01 (3 years ago)

Author:

siegel

Comment:

--

Libraries

@@ -84 +84 @@
   * Destroys the gcomm, deallocating memory that was allocated for it.  If `junkMsgs` is not NULL it shall be a pointer to an array of indeterminate length of `$message`.   This function will populate that array with all messages remaining the gcomm's buffers and return the number of such messages.
 * `$atomic_f void $gcomm_dup($comm comm, $comm newcomm)`
+  * Duplicates the communicator `comm`.   The `newcomm` is initialized to have the same gcomm and place as the original `comm`.  
 * `$atomic_f $comm $comm_create($scope scope, $gcomm gcomm, int place)`
-  * 
+  * Creates a new `comm` associated with the specified `place` in `gcomm`.  If `place` is less than 0, or greater than the size of `gcomm`, or another process has already occupied `place` in `gcomm`, an error occurs.  The new comm object is allocated in the heap of the given scope.
 * `$atomic_f void $comm_destroy($comm comm)`
+  * Deallocates the comm.
 * `$atomic_f int $comm_size($comm comm)`
+  * Gets the size of the gcomm that owns `comm`.
 * `$atomic_f int $comm_place($comm comm)`
+  * Gets the place of the given `comm` in its gcomm object.
 * `$system void $comm_enqueue($comm comm, $message message)`
+  * Enqueues a message in a FIFO channel in the gcomm.  The message should have its source be the place of `comm`.   The message will enqueued on channel ''(i,j)'' in the gcomm, where ''i'' is the place of the source, and ''j'' is the place of the destination of the message.
 * `$system $state_f _Bool $comm_probe($comm comm, int source, int tag)`
+  * Determines whether there exists a message with the given source and tag, and with destination the place of `comm`, in the gcomm associated to `comm`.   `source` may be $COMM_ANY_SOURCE` and `tag` may be `$COMM_ANY_TAG`.
 * `$system $message $comm_seek($comm comm, int source, int tag)`
 * `$system $message $comm_dequeue($comm comm, int source, int tag)`