Update of /cvsroot/boost/boost/libs/mpi/doc
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv1038
Modified Files:
mpi.qbk
Log Message:
Document mapping from every C function to Boost.MPI
Index: mpi.qbk
===================================================================
RCS file: /cvsroot/boost/boost/libs/mpi/doc/mpi.qbk,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- mpi.qbk 17 Apr 2007 04:44:58 -0000 1.3
+++ mpi.qbk 31 May 2007 13:56:29 -0000 1.4
@@ -1030,7 +1030,7 @@
This section provides tables that map from the functions and constants
of the standard C MPI to their Boost.MPI equivalents. It will be most
useful for users that are already familiar with the C or Fortran
-interfaces to MPI, or for porting existing parallel programs to MPI.
+interfaces to MPI, or for porting existing parallel programs to Boost.MPI.
[table Point-to-point communication
[[C Function/Constant] [Boost.MPI Equivalent]]
@@ -1340,7 +1340,7 @@
Boost.MPI.
[table Reduction operations
- [[C Function/Constant] [Boost.MPI Equivalent]]
+ [[C Constant] [Boost.MPI Equivalent]]
[[`MPI_BAND`] [[classref boost::mpi::bitwise_and `bitwise_and`]]]
[[`MPI_BOR`] [[classref boost::mpi::bitwise_or `bitwise_or`]]]
@@ -1358,6 +1358,265 @@
[[`MPI_SUM`] [`std::plus`]]
]
+MPI defines several special communicators, including `MPI_COMM_WORLD`
+(including all processes that the local process can communicate with),
+`MPI_COMM_SELF` (including only the local process), and
+`MPI_COMM_EMPTY` (including no processes). These special communicators
+are all instances of the [classref boost::mpi::communicator
+`communicator`] class in Boost.MPI.
+
+[table Predefined communicators
+ [[C Constant] [Boost.MPI Equivalent]]
+
+ [[`MPI_COMM_WORLD`] [a default-constructed [classref
boost::mpi::communicator `communicator`]]]
+ [[`MPI_COMM_SELF`] [a [classref boost::mpi::communicator `communicator`]
that contains only the current process]]
+ [[`MPI_COMM_EMPTY`] [a [classref boost::mpi::communicator `communicator`]
that evaluates false]]
+]
+
+Boost.MPI currently has no support for groups of processes, as
+specified in MPI 1.1.
+
+[table Group operations and constants
+ [[C Function/Constant] [Boost.MPI Equivalent]]
+
+ [[`MPI_GROUP_EMPTY`] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node97.html#Node97
+ `MPI_Group_size`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node97.html#Node97
+ `MPI_Group_rank`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node97.html#Node97
+ `MPI_Group_translate_ranks`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node97.html#Node97
+ `MPI_Group_compare`]] [unsupported]]
+ [[`MPI_IDENT`] [unsupported]]
+ [[`MPI_SIMILAR`] [unsupported]]
+ [[`MPI_UNEQUAL`] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Comm_group`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Group_union`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Group_intersection`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Group_difference`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Group_incl`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Group_excl`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Group_range_incl`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node98.html#Node98
+ `MPI_Group_range_excl`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node99.html#Node99
+ `MPI_Group_free`]] [unsupported]]
+]
+
+Boost.MPI provides manipulation of communicators through the [classref
+boost::mpi::communicator `communicator`] class.
+
+[table Communicator operations
+ [[C Function] [Boost.MPI Equivalent]]
+
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node101.html#Node101
+ `MPI_Comm_size`]] [[memberref boost::mpi::communicator::size
`communicator::size`]]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node101.html#Node101
+ `MPI_Comm_rank`]] [[memberref boost::mpi::communicator::rank
+ `communicator::rank`]]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node101.html#Node101
+ `MPI_Comm_compare`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node102.html#Node102
+ `MPI_Comm_dup`]] [[classref boost::mpi::communicator `communicator`]
+ class constructor using `comm_duplicate`]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node102.html#Node102
+ `MPI_Comm_create`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node102.html#Node102
+ `MPI_Comm_split`]] [[memberref boost::mpi::communicator::split
+ `communicator::split`]]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node103.html#Node103
+ `MPI_Comm_free`]] [used automatically in Boost.MPI]]
+]
+
+Boost.MPI currently provides no support for inter-communicators.
+
+[table Inter-communicator operations
+ [[C Function] [Boost.MPI Equivalent]]
+
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node112.html#Node112
+ `MPI_Comm_test_inter`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node112.html#Node112
+ `MPI_Comm_remote_size`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node112.html#Node112
+ `MPI_Comm_remote_group`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node113.html#Node113
+ `MPI_Intercomm_create`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node113.html#Node113
+ `MPI_Intercomm_merge`]] [unsupported]]
+]
+
+Boost.MPI currently provides no support for attribute caching.
+
+[table Attributes and caching
+ [[C Function/Constant] [Boost.MPI Equivalent]]
+
+ [[`MPI_NULL_COPY_FN`] [unsupported]]
+ [[`MPI_NULL_DELETE_FN`] [unsupported]]
+ [[`MPI_KEYVAL_INVALID`] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node119.html#Node119
+ `MPI_Keyval_create`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node119.html#Node119
+ `MPI_Copy_function`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node119.html#Node119
+ `MPI_Delete_function`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node119.html#Node119
+ `MPI_Keyval_free`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node119.html#Node119
+ `MPI_Attr_put`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node119.html#Node119
+ `MPI_Attr_get`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node119.html#Node119
+ `MPI_Attr_delete`]] [unsupported]]
+]
+
+Boost.MPI currently provides no support for process topologies.
+
+[table Process topologies
+ [[C Function/Constant] [Boost.MPI Equivalent]]
+
+ [[`MPI_GRAPH`] [unsupported]]
+ [[`MPI_CART`] [unsupported]]
+ [[`MPI_UNDEFINED`] [unsupported]]
+
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node133.html#Node133
+ `MPI_Cart_create`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node134.html#Node134
+ `MPI_Dims_create`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node135.html#Node135
+ `MPI_Graph_create`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Topo_test`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Graphdims_get`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Graph_get`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Cartdim_get`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Cart_get`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Cart_rank`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Cart_coords`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Graph_neighbors_count`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node136.html#Node136
+ `MPI_Graph_neighbors`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node137.html#Node137
+ `MPI_Cart_shift`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node138.html#Node138
+ `MPI_Cart_sub`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node139.html#Node139
+ `MPI_Cart_map`]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node139.html#Node139
+ `MPI_Graph_map`]] [unsupported]]
+]
+
+Boost.MPI supports environmental inquires through the [classref
+boost::mpi::environment `environment`] class.
+
+[table Environmental inquiries
+ [[C Function/Constant] [Boost.MPI Equivalent]]
+
+ [[`MPI_TAG_UB`] [unnecessary; use [memberref
+ boost::mpi::environment::max_tag `environment::max_tag`]]]
+ [[`MPI_HOST`] [unnecessary; use [memberref
+ boost::mpi::environment::host_rank `environment::host_rank`]]]
+ [[`MPI_IO`] [unnecessary; use [memberref
+ boost::mpi::environment::io_rank `environment::io_rank`]]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node143.html#Node147
+ `MPI_Get_processor_name`]]
+ [[memberref boost::mpi::environment::processor_name
+ `environment::processor_name`]]]
+]
+
+Boost.MPI translates MPI errors into exceptions, reported via the
+[classref boost::mpi::exception `exception`] class.
+
+[table Error handling
+ [[C Function/Constant] [Boost.MPI Equivalent]]
+
+ [[`MPI_ERRORS_ARE_FATAL`] [unused; errors are translated into
+ Boost.MPI exceptions]]
+ [[`MPI_ERRORS_RETURN`] [unused; errors are translated into
+ Boost.MPI exceptions]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node148.html#Node148
+ `MPI_errhandler_create`]] [unused; errors are translated into
+ Boost.MPI exceptions]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node148.html#Node148
+ `MPI_errhandler_set`]] [unused; errors are translated into
+ Boost.MPI exceptions]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node148.html#Node148
+ `MPI_errhandler_get`]] [unused; errors are translated into
+ Boost.MPI exceptions]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node148.html#Node148
+ `MPI_errhandler_free`]] [unused; errors are translated into
+ Boost.MPI exceptions]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node148.html#Node148
+ `MPI_Error_string`]] [used internally by Boost.MPI]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node149.html#Node149
+ `MPI_Error_class`]] [unsupported]]
+]
+
+The MPI timing facilities are exposed via the Boost.MPI [classref
+boost::mpi::timer `timer`] class, which provides an interface
+compatible with the [EMAIL PROTECTED]://www.boost.org/libs/timer/index.html
Boost
+Timer library].
+
+[table Timing facilities
+ [[C Function/Constant] [Boost.MPI Equivalent]]
+
+ [[`MPI_WTIME_IS_GLOBAL`] [unnecessary; use [memberref
+ boost::mpi::timer::time_is_global `timer::time_is_global`]]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node150.html#Node150
+ `MPI_Wtime`]] [use [memberref boost::mpi::timer::elapsed
+ `timer::elapsed`] to determine the time elapsed from some specific
+ starting point]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node150.html#Node150
+ `MPI_Wtick`]] [[memberref boost::mpi::timer::elapsed_min
`timer::elapsed_min`]]]
+]
+
+MPI startup and shutdown are managed by the construction and
+descruction of the Boost.MPI [classref boost::mpi::environment
+`environment`] class.
+
+[table Startup/shutdown facilities
+ [[C Function] [Boost.MPI Equivalent]]
+
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node151.html#Node151
+ `MPI_Init`]] [[classref boost::mpi::environment `environment`]
+ constructor]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node151.html#Node151
+ `MPI_Finalize`]] [[classref boost::mpi::environment `environment`]
+ destructor]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node151.html#Node151
+ `MPI_Initialized`]] [[memberref boost::mpi::environment::initialized
+ `environment::initialized`]]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node151.html#Node151
+ `MPI_Abort`]] [[memberref boost::mpi::environment::abort
+ `environment::abort`]]]
+]
+
+Boost.MPI does not provide any support for the profiling facilities in
+MPI 1.1.
+
+[table Profiling interface
+ [[C Function] [Boost.MPI Equivalent]]
+
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node153.html#Node153
+ `PMPI_*` routines]] [unsupported]]
+ [EMAIL PROTECTED]://www.mpi-forum.org/docs/mpi-11-html/node156.html#Node156
+ `MPI_Pcontrol`]] [unsupported]]
+]
+
[endsect]
[endsect]
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
