← Back to branch summary

~ubuntu-branches/ubuntu/vivid/mpich/vivid-proposed

« back to all changes in this revision

Viewing changes to www/www3/MPI_T_pvar_reset.html

  • Committer: Package Import Robot
  • Author(s): Anton Gladky
  • Date: 2014-04-01 20:24:20 UTC
  • mfrom: (5.2.4 sid)
  • Revision ID: package-import@ubuntu.com-20140401202420-t5ey1ia2klt5dkq3
Tags: 3.1-4
http://bugs.debian.org/743047
* [c3e3398] Disable test_primitives, which is unreliable on some platforms.
            (Closes: #743047)
* [265a699] Add minimal autotest.

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/www3/MPI_T_pvar_reset.html
6
6
</HEAD>
7
7
<BODY BGCOLOR="FFFFFF">
8
8
<A NAME="MPI_T_pvar_reset"><H1>MPI_T_pvar_reset</H1></A>
9
 
XXX description here 
 
9
Reset a performance variable 
10
10
<H2>Synopsis</H2>
11
11
<PRE>
12
12
int MPI_T_pvar_reset(MPI_T_pvar_session session, MPI_T_pvar_handle handle)
18
18
<DT><B>handle </B><DD>handle of a performance variable (handle)
19
19
</DL>
20
20
<P>
 
21
<H2>Notes</H2>
 
22
The MPI_T_pvar_reset() call sets the performance variable with the handle identified
 
23
by the parameter handle to its starting value. If it is not possible
 
24
to change the variable, the function returns MPI_T_ERR_PVAR_NO_WRITE.
 
25
If the constant MPI_T_PVAR_ALL_HANDLES is passed in handle, the MPI implementation
 
26
attempts to reset all variables within the session identified by the parameter session for
 
27
which handles have been allocated. In this case, the routine returns MPI_SUCCESS if all
 
28
variables are reset successfully, otherwise MPI_T_ERR_PVAR_NO_WRITE is returned. Readonly
 
29
variables are ignored when MPI_T_PVAR_ALL_HANDLES is specified.
 
30
<P>
21
31
<H2>Thread and Interrupt Safety</H2>
22
32
<P>
23
33
This routine is thread-safe.  This means that this routine may be
26
36
this is due to the use of memory allocation routines such as <TT>malloc
27
37
</TT>or other non-MPICH runtime routines that are themselves not interrupt-safe.
28
38
<P>
29
 
<H2>Notes for Fortran</H2>
30
 
All MPI routines in Fortran (except for <TT>MPI_WTIME</TT> and <TT>MPI_WTICK</TT>) have
31
 
an additional argument <TT>ierr</TT> at the end of the argument list.  <TT>ierr
32
 
</TT>is an integer and has the same meaning as the return value of the routine
33
 
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
34
 
<TT>call</TT> statement.
35
 
<P>
36
 
All MPI objects (e.g., <TT>MPI_Datatype</TT>, <TT>MPI_Comm</TT>) are of type <TT>INTEGER
37
 
</TT>in Fortran.
38
 
<P>
39
39
<H2>Errors</H2>
40
40
<P>
41
41
All MPI routines (except <TT>MPI_Wtime</TT> and <TT>MPI_Wtick</TT>) return an error value;
51
51
an error; however, MPI implementations will attempt to continue whenever
52
52
possible.
53
53
<P>
54
 
<P><B>Location:</B>src/mpi_t/pvar_reset.c<P>
 
54
<DL><DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
 
55
</DL>
 
56
<DL><DT><B>MPI_T_ERR_NOT_INITIALIZED </B> <DD> The MPI tool information interface is not initialized.
 
57
</DL>
 
58
<DL><DT><B>MPI_T_ERR_INVALID_SESSION </B> <DD> Session argument is not valid.
 
59
</DL>
 
60
<DL><DT><B>MPI_T_ERR_INVALID_HANDLE </B> <DD> The handle is invalid.
 
61
</DL>
 
62
<DL><DT><B>MPI_T_ERR_PVAR_NO_WRITE </B> <DD> The performance variable can not be written or reset.
 
63
</DL>
 
64
<P><B>Location:</B>/tmp/gyCYfBi4J6/mpich-3.1/src/mpi_t/pvar_reset.c<P>
55
65
</BODY></HTML>