# doc-cache created by Octave 4.0.0
# name: cache
# type: cell
# rows: 3
# columns: 14
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
MPI_Barrier


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 493
 -- Loadable Function: INFO = MPI_Barrier (COMM)
     Block processes in the communicator COMM untill the call to this
     routine has been reached by all.  The communicator object COMM
     (loaded with MPI_Comm_Load) must be specified otherwise an error
     occurs.
 
              INFO (int) return code
                 0 MPI_SUCCESS    No error
                 5 MPI_ERR_COMM   Invalid communicator (NULL?)
                13 MPI_ERR_ARG    Invalid argument (typically a NULL pointer?)


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Block processes in the communicator COMM untill the call to this routine
has bee



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
MPI_Comm_Load


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 429
 -- Loadable Function: COMM = MPI_Comm_Load (DESCRIPTION)
     Return COMM the MPI_Communicator object whose description is
     DESCRIPTION, as a string.  The default value will be
     MPI_COMM_WORLD. If DESCRIPTION is omitted, return anyway an
     MPI_COMM_WORLD comunicator object with no decription.  For example,

          MPI_Init();
          X = MPI_Comm_Load("description");
          whos X
          MPI_Finalize();


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Return COMM the MPI_Communicator object whose description is
DESCRIPTION, as a s



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
MPI_Comm_Test


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 312
 -- Loadable Function: DESCRIPTION = MPI_Comm_Test (COMM)
     Return DESCRIPTION string description of the MPI_Communicator COMM.
     For example,

          MPI_Init();
          X = MPI_Comm_Load("description");
          whos X
          MPI_Comm_Test(X)
          => "description"
          MPI_Finalize();


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 67
Return DESCRIPTION string description of the MPI_Communicator COMM.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
MPI_Comm_rank


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 564
 -- Loadable Function: [ RANK INFO] = MPI_Comm_rank (COMM)
     Return the rank of the calling process in the specified
     communicator.  If the comunicator object COMM (loaded with
     MPI_Comm_Load) is omitted an error is thrown.
 
              RANK rank of the calling process in group of communicator
              INFO (int) return code
                 0 MPI_SUCCESS    No error
                 5 MPI_ERR_COMM   Invalid communicator (NULL?)
                13 MPI_ERR_ARG    Invalid argument (typically a NULL pointer?)
          SEE ALSO: MPI_Comm_size


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 69
Return the rank of the calling process in the specified communicator.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
MPI_Comm_size


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 550
 -- Loadable Function: [ RANK INFO] = MPI_Comm_size (COMM)
     Return the size of a communicator.  The comunicator object COMM
     (loaded with MPI_Comm_Load) must be sepcified or otherwise an error
     occurs.
 
              EXPRANK rank of the calling process in group of communicator
              EXPRINFO (int) return code
                 0 MPI_SUCCESS    No error
                 5 MPI_ERR_COMM   Invalid communicator (NULL?)
                13 MPI_ERR_ARG    Invalid argument (typically a NULL pointer?)
          SEE ALSO: MPI_Comm_rank


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 34
Return the size of a communicator.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
MPI_Finalize


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 345
 -- Loadable Function: INFO = MPI_Finalize ()
     Terminate the MPI execution environment.

 
              INFO (int) return code
                 0 MPI_SUCCESS    No error
                 5 MPI_ERR_COMM   Invalid communicator (NULL?)
                13 MPI_ERR_ARG    Invalid argument (typically a NULL pointer?)
          SEE ALSO: MPI_Init


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 40
Terminate the MPI execution environment.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
MPI_Finalized


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 356
 -- Loadable Function: [FLAG, INFO] = MPI_Finalized ()
     Indicates whether MPI_Finalize has been executed.

 
              FLAG (int) return code
          	    0 false
                      1 true
              INFO (int) return code
                 0 MPI_SUCCESS    This function always returns MPI_SUCCESS
          SEE ALSO: MPI_Init, MPI_Finalize


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 49
Indicates whether MPI_Finalize has been executed.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 22
MPI_Get_processor_name


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 433
 -- Loadable Function: NAME,RESULTLEN,INFO = MPI_Get_processor_name ()
     Get the name of the processor that is using MPI.

 
              INFO (int) return code
                 0 MPI_SUCCESS    No error
                16 MPI_ERR_OTHER  Attempt was made to call MPI_Init a  second  time
                                 MPI_Init may only be called once in a program


     See also: MPI_Finalize, MPI_Initialized, MPI_Finalized.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 48
Get the name of the processor that is using MPI.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
MPI_Init


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 399
 -- Loadable Function: INFO = MPI_Init()
     Initialize the MPI execution environment.

 
              INFO (int) return code
                 0 MPI_SUCCESS    No error
                16 MPI_ERR_OTHER  Attempt was made to call MPI_Init a  second  time
                                 MPI_Init may only be called once in a program

          SEE ALSO: MPI_Finalize, MPI_Initialized, MPI_Finalized


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 41
Initialize the MPI execution environment.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 15
MPI_Initialized


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 351
 -- Loadable Function: [ FLAG INFO] = MPI_Initialized
     Indicates whether MPI_Init has been executed.

 
              FLAG (int) return code
          	    0 false
                      1 true
              INFO (int) return code
                 0 MPI_SUCCESS    This function always returns MPI_SUCCESS
          SEE ALSO: MPI_Init, MPI_Finalize


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 45
Indicates whether MPI_Init has been executed.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
MPI_Iprobe


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 985
 -- Loadable Function: [ FLAG STAT INFO] = MPI_Iprobe(SRCRANK, TAG,
          COMM)
     Nonblocking test for an MPI message.
 

               FLAG int
          	    1 if the message is ready to be received
                     0 if it is not (boolean)
               STAT struct object
                 src (int)       source rank for the accepted message
                 tag (int)       message tag for the accepted message
                 err(int)        error
                 cnt (int)       count
                 can (int)       cancel
              INFO (int) return code
                0 MPI_SUCCESS    No error
               13 MPI_ERR_ARG    Invalid argument
                5 MPI_ERR_COMM   Invalid communicator (null?)
                4 MPI_ERR_TAG    Invalid tag argument (MPI_ANY_TAG, 0..MPI_TAG_UB attr)
                6 MPI_ERR_RANK   Invalid src/dst rank (MPI_ANY_SOURCE, 0..Comm_size-1)
 
 

     See also: MPI_Probe, MPI_Recv, MPI documentation for examples.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 36
Nonblocking test for an MPI message.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
MPI_Probe


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 847
 -- Loadable Function: [ STAT INFO] = MPI_Probe(SRCRANK, TAG, COMM)
     Blocking test for a message.
 

               STAT struct object
                 src (int)       source rank for the accepted message
                 tag (int)       message tag for the accepted message
                 err(int)        error
                 cnt (int)       count
                 can (int)       cancel
              INFO (int) return code
                0 MPI_SUCCESS    No error
               13 MPI_ERR_ARG    Invalid argument
                5 MPI_ERR_COMM   Invalid communicator (null?)
                4 MPI_ERR_TAG    Invalid tag argument (MPI_ANY_TAG, 0..MPI_TAG_UB attr)
                6 MPI_ERR_RANK   Invalid src/dst rank (MPI_ANY_SOURCE, 0..Comm_size-1)
 
 

     See also: MPI_Iprobe, MPI_Recv, and MPI documentation for C
     examples.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 28
Blocking test for a message.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
MPI_Recv


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 552
 -- Loadable Function: [ VALUE INFO] = MPI_Recv(SOURCE,TAG,COMM)
     Receive an MPI message containing an Octave variable and extract
     its value.  The Octave variable being received is returned as
     VALUE, while INFO is an integer indicating success or failure.
 
          SOURCE must be an integer indicating source processes
          TAG must be an integer to identify the message by openmpi
          COMM must be an octave communicator object created by MPI_Comm_Load function

     See also: MPI_Comm_Load,MPI_Init,MPI_Finalize,MPI_Send.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 75
Receive an MPI message containing an Octave variable and extract its
value.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
MPI_Send


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 523
 -- Loadable Function: INFO = MPI_Send( VALUE,RANKS,TAG,COMM)
     Transmit an Octave variable as a set of MPI message.  Return an
     integer INFO to indicate success or failure.
          VALUE must be an octave variable
          RANKS must be a vector containing the list of rank destination processes
          TAG must be an integer to identify the message by openmpi
          COMM must be an octave communicator object created by MPI_Comm_Load function

     See also: MPI_Comm_Load,MPI_Init,MPI_Finalize,MPI_Recv.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 52
Transmit an Octave variable as a set of MPI message.





