Add documentation
This commit is contained in:
@@ -3,8 +3,35 @@
|
||||
% $Id: lam_mpi.yap,v 1.1 2006-06-04 18:43:38 nunofonseca Exp $
|
||||
|
||||
|
||||
/** @defgroup LAM LAM
|
||||
@ingroup library
|
||||
:- module(lam_mpi, [
|
||||
mpi_init/0,
|
||||
mpi_finalize/0,
|
||||
mpi_comm_size/1,
|
||||
mpi_comm_rank/1,
|
||||
mpi_version/2,
|
||||
mpi_send/3,
|
||||
mpi_isend/4,
|
||||
mpi_recv/3,
|
||||
mpi_irecv/3,
|
||||
mpi_wait/2,
|
||||
mpi_wait_recv/3,
|
||||
mpi_test/2,
|
||||
mpi_test_recv/3,
|
||||
mpi_bcast/2,
|
||||
mpi_ibcast2/2,
|
||||
mpi_ibcast2/3,
|
||||
mpi_bcast2/2,
|
||||
mpi_bcast2/3,
|
||||
mpi_barrier/0,
|
||||
mpi_msg_buffer_size/2,
|
||||
mpi_msg_size/2,
|
||||
mpi_gc/0,
|
||||
mpi_default_buffer_size/2
|
||||
]).
|
||||
|
||||
/**
|
||||
* @defgroup lam_mpi MPI Interface
|
||||
* @ingroup library
|
||||
@{
|
||||
|
||||
This library provides a set of utilities for interfacing with LAM MPI.
|
||||
@@ -25,8 +52,6 @@ synchronization among all processes. Note that a collective
|
||||
communication means that all processes call the same predicate. To be
|
||||
able to use a regular `mpi_recv` to receive the messages, one
|
||||
should use `mpi_bcast2`.
|
||||
|
||||
|
||||
*/
|
||||
/** @pred mpi_bcast2(+ _Root_, ? _Data_)
|
||||
|
||||
@@ -186,31 +211,6 @@ message and _Data_ with the message itself.
|
||||
|
||||
|
||||
*/
|
||||
:- module(lam_mpi, [
|
||||
mpi_init/0,
|
||||
mpi_finalize/0,
|
||||
mpi_comm_size/1,
|
||||
mpi_comm_rank/1,
|
||||
mpi_version/2,
|
||||
mpi_send/3,
|
||||
mpi_isend/4,
|
||||
mpi_recv/3,
|
||||
mpi_irecv/3,
|
||||
mpi_wait/2,
|
||||
mpi_wait_recv/3,
|
||||
mpi_test/2,
|
||||
mpi_test_recv/3,
|
||||
mpi_bcast/2,
|
||||
mpi_ibcast2/2,
|
||||
mpi_ibcast2/3,
|
||||
mpi_bcast2/2,
|
||||
mpi_bcast2/3,
|
||||
mpi_barrier/0,
|
||||
mpi_msg_buffer_size/2,
|
||||
mpi_msg_size/2,
|
||||
mpi_gc/0,
|
||||
mpi_default_buffer_size/2
|
||||
]).
|
||||
|
||||
:- load_foreign_files([yap_mpi], [], init_mpi).
|
||||
|
||||
|
Reference in New Issue
Block a user