Changes between Version 14 and Version 15 of Libraries

Timestamp:

05/22/23 18:51:12 (3 years ago)

Author:

siegel

Comment:

--

Libraries

@@ -50 +50 @@
 Header: [https://vsl.cis.udel.edu/trac/civl/browser/CIVL/trunk/mods/dev.civl.abc/src/include/headers/comm.cvh comm.cvh].
 Uses: [#bundle bundle].
+
+The comm library supports message-passing-style communication.
+It provides a number of basic data structures which can be used to implement specific message-passing interfaces, such as MPI.
+
+=== Types
+* `$message`
+* `$gcomm`
+* `$comm`
+
+=== Constants
+* `$COMM_ANY_SOURCE`
+* `$COMM_ANY_TAG`
+
+=== Functions
+* `$atomic_f $message $message_pack(int source, int dest, int tag, const void *data, int size)`
+* `$atomic_f int $message_source($message message)`
+* `$atomic_f int $message_tag($message message)`
+* `$atomic_f int $message_dest($message message)`
+* `$atomic_f int $message_size($message message)`
+* `$atomic_f void $message_unpack($message message, void *buf, int size)`
+* `$atomic_f $gcomm $gcomm_create($scope scope, int size)`
+* `$atomic_f int $gcomm_destroy($gcomm gcomm, void * junkMsgs)`
+* `$atomic_f void $gcomm_dup($comm comm, $comm newcomm)`
+* `$atomic_f $comm $comm_create($scope scope, $gcomm gcomm, int place)`
+* `$atomic_f void $comm_destroy($comm comm)`
+* `$atomic_f int $comm_size($comm comm)`
+* `$atomic_f int $comm_place($comm comm)`
+* `$system void $comm_enqueue($comm comm, $message message)`
+* `$system $state_f _Bool $comm_probe($comm comm, int source, int tag)`
+* `$system $message $comm_seek($comm comm, int source, int tag)`
+* `$system $message $comm_dequeue($comm comm, int source, int tag)`
+* `$system $state_f _Bool $comm_empty_in($comm )`
+* `$system $state_f _Bool $comm_empty_out($comm )`
+
+
 
 == concurrency #concurrency