Skip to content

Commit 915d8da

Browse files
committed
updated documentation with alltoall / alltoallv
1 parent 22a4265 commit 915d8da

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ best MPI library available.
1717
The Chicken MPI egg provides a Scheme interface to a large subset of
1818
the MPI 1.2 procedures for communication. It is based on the Ocaml
1919
MPI library by Xavier Leroy
20-
(http://forge.ocamlcore.org/projects/ocamlmpi/). The mpi
21-
library has been tested with Open MPI versions 1.2.4 - 1.10.1.
20+
(http://forge.ocamlcore.org/projects/ocamlmpi/). The mpi library has
21+
been tested with Open MPI versions 1.2.4 - 1.10.1 and MPICH version
22+
3.2.
2223

2324
### Initialization and time procedures
2425

@@ -340,6 +341,21 @@ object. `TYPE` is one of the following: `int, flonum,
340341
bytevector, s8vector, u8vector, s16vector, u16vector, s32vector,
341342
u32vector, f32vector, f64vector`
342343

344+
`MPI:alltoall :: DATATYPE * DATA * SIZE * COMM -> DATA`
345+
`MPI:alltoall-TYPE :: DATA * SIZE * COMM -> DATA`
346+
347+
Collects data of size `SIZE` from all processes and distributes it to
348+
all processes. Argument `DATATYPE` is an MPI datatype object. `TYPE`
349+
is one of the following: `int, flonum, bytevector, s8vector, u8vector,
350+
s16vector, u16vector, s32vector, u32vector, f32vector, f64vector`
351+
352+
`MPI:alltoallv :: DATATYPE * DATA * SIZEVEC * COMM -> DATA`
353+
`MPI:alltoall-TYPE :: DATA * SIZEVEC * COMM -> DATA`
354+
355+
Collects variable length data from all processes and distributes it to
356+
all processes. Argument `DATATYPE` is an MPI datatype object. `TYPE`
357+
is one of the following: `int, flonum, bytevector, s8vector, u8vector,
358+
s16vector, u16vector, s32vector, u32vector, f32vector, f64vector`
343359

344360

345361
`MPI:reduce-TYPE :: DATA * OP * ROOT * COMM -> DATA`
@@ -536,6 +552,7 @@ this node.
536552

537553
## Version history
538554

555+
- 2.0 : Support for MPI alltoall / alltoallv operations
539556
- 2.0 : Support for MPI derived datatypes
540557
- 1.14 : Added simple round-robin routines
541558
- 1.12 : Fixes to allgather-int and allgather-flonum (thanks to Peter Bex)

0 commit comments

Comments
 (0)