← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/fr/pvm/pvm_barrier.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/fr/pvm/pvm_barrier.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>pvm_barrier</TITLE>
 
6
  <TYPE>Scilab function</TYPE>
 
7
  <DATE>May 1998</DATE>
 
8
  <SHORT_DESCRIPTION name="pvm_barrier"> blocks the calling process until all processes in a group have called it.  </SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>[info] = pvm_barrier(group,count)  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <PARAM>
 
13
    <PARAM_INDENT>
 
14
      <PARAM_ITEM>
 
15
        <PARAM_NAME>type</PARAM_NAME>
 
16
        <PARAM_DESCRIPTION>
 
17
          <SP>: string,  name of an existing group.</SP>
 
18
        </PARAM_DESCRIPTION>
 
19
      </PARAM_ITEM>
 
20
      <PARAM_ITEM>
 
21
        <PARAM_NAME>count</PARAM_NAME>
 
22
        <PARAM_DESCRIPTION>
 
23
          <SP>: integer, specifying the number of group members that must call pvm_barrier before they are all released.</SP>
 
24
        </PARAM_DESCRIPTION>
 
25
      </PARAM_ITEM>
 
26
      <PARAM_ITEM>
 
27
        <PARAM_NAME>info</PARAM_NAME>
 
28
        <PARAM_DESCRIPTION>
 
29
          <SP>: integer, status code returned by the routine.</SP>
 
30
        </PARAM_DESCRIPTION>
 
31
      </PARAM_ITEM>
 
32
    </PARAM_INDENT>
 
33
  </PARAM>
 
34
  <DESCRIPTION>
 
35
    <P><VERB>pvm_barrier</VERB> blocks the calling process until <VERB>count</VERB>
 
36
    members of the <VERB>group</VERB> have called <VERB>pvm_barrier</VERB>.
 
37
    The <VERB>count</VERB> argument is required because processes could be
 
38
    joining the given group after other processes have called
 
39
    <VERB>pvm_barrier</VERB>. Thus PVM doesn't know how many group members
 
40
    to wait for at any given instant. Although <VERB>count</VERB> can be set less,
 
41
    it is typically the total number of members of the group.
 
42
    So the logical function of the <VERB>pvm_barrier</VERB> call
 
43
    is to provide a group synchronization.
 
44
    During any given barrier call all participating group members
 
45
    must call barrier with the same count value.
 
46
    Once a given barrier has been successfully passed,
 
47
    <VERB>pvm_barrier</VERB> can be called again by the same group using the same
 
48
    group name.</P>
 
49
    <P>
 
50
    The returned value <VERB>info</VERB>will be zero if 
 
51
    <VERB>pvm_barrier</VERB> is successful and will be 
 
52
    will be &lt; 0 if some error occurs.</P>
 
53
  </DESCRIPTION>
 
54
  <EXAMPLE>
 
55
<![CDATA[
 
56
info = pvm_barrier( "worker", pvm_gsize("worker") )
 
57
 ]]>
 
58
  </EXAMPLE>
 
59
  <SEE_ALSO>
 
60
    <SEE_ALSO_ITEM>
 
61
      <LINK>pvm_joingroup</LINK>
 
62
    </SEE_ALSO_ITEM>
 
63
  </SEE_ALSO>
 
64
</MAN>