Changes between Version 7 and Version 8 of MessagePassing

Timestamp:

07/12/13 09:29:01 (13 years ago)

Author:

siegel

Comment:

--

MessagePassing

@@ -157 +157 @@
 What should these datatypes be?
 
-* `$message` : an abstract datatype
+* `$message`
+ * an abstract datatype
 * `$message $message_create(int source, int dest, int tag, void *data, int size)`
+ * creates a new message, allocated memory and copying data from the specified buffer
 * `int $message_source($message * message)`
+ * returns the message source
 * `int $message_tag($message * message)`
+ * returns the message tag
 * `int $message_dest($message * message)`
+ * returns the message destination
 * `int $message_size($message * message)`
+ * returns the message size
 * `void $message_destroy($message * message)`
-* `$comm` : an abstract datatype
+ * destroys the message, deallocating whatever was allocated in its creation
+* `$comm`
+ * an abstract datatype representing a communicator, or set of message channels between every pair of processes in a set of processes
 * `$comm $comm_create(int nprocs, $proc * procs)`
+ * creates a new comm from the given sequence of processes, by allocating memory and copying the process sequences; the new comm has no messages
+* `void $comm_destroy($comm * comm)`
+ * destroys the comm, deallocating whatever was allocated in its constructions
 * `int $comm_nprocs($comm * comm)`
+ * returns the number of processes associated to the comm
 * `$proc * $comm_procs($comm * comm)`
+ * returns a pointer to the procs array in comm
 * `void $comm_enqueue($comm * comm, $message * message)`
+ * adds the message to the comm
 * `boolean $comm_probe($comm * comm, int source, int dest, int tag)`
+ * returns true iff a matching message exists in comm
+* `$message * $comm_seek($comm * comm, int source, int dest, int tag)`
+ * finds the first matching message and returns pointer to it without modifying comm
 * `$message * $comm_dequeue($comm * comm, int source, int dest, int tag)`
-
-
-
+ * find the first matching message, removes it from comm, and returns pointer to message
+* `int $comm_chan_size($comm * comm, int source, int dest)`
+ * returns the number of messages from source to dest stored in comm
+* `int $comm_total_size($comm * comm)`
+ * returns the total number of messages in the comm
+* constants defined:
+ * `int $COMM_ANY_SOURCE`
+ * `int $COMM_ANY_TAG`
+
+
+