octave-mpi 1.2.0-4 / usr / share / octave / packages / mpi-1.2.0 / doc-cache

# doc-cache created by Octave 4.2.1
# name: cache
# type: cell
# rows: 3
# columns: 8
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2
Pi


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 716
 -- Function File: [RESULT] = Pi ()
     Classical MPI example that computes PI by integrating arctan'(x) in
     [0,1].  N [1e7] #subdivisions of the [0, 1] interval.  MOD ['s']
     communication modality: (s)end (r)educe.  RESULTS struct contains

        - PI: estimated pi value
        - ERR: error
        - TIME: from argument xmit to pi computed

     To run this example, set the variables HOSTFILE and
     NUMBER_OF_MPI_NODES to appropriate values, then type the following
     command in your shell:
          mpirun --hostfile $HOSTFILE -np $NUMBER_OF_MPI_NODES octave --eval 'pkg load mpi; Pi ()'

     See also:
     hello2dimmat,helloworld,hellocell,hellosparsemat,mc_example,montecarlo,hellostruct.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 74
Classical MPI example that computes PI by integrating arctan'(x) in
[0,1].



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 588
 -- Function File: = hello2dimmat ()
     This function demonstrates sending and receiving of a 2-dimensional
     matrix over MPI. Each process in the pool will create a random
     90x90 matrix and send it to process with rank 0.  To run this
     example, set the variables HOSTFILE and NUMBER_OF_MPI_NODES to
     appropriate values, then type the following command in your shell:
          mpirun --hostfile $HOSTFILE -np $NUMBER_OF_MPI_NODES octave --eval 'pkg load mpi; hello2dimmat ()'

     See also:
     hellocell,hellosparsemat,hellostruct,helloworld,mc_example,montecarlo,Pi.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
This function demonstrates sending and receiving of a 2-dimensional
matrix over 



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 566
 -- Function File: = hellocell ()
     This function demonstrates sending and receiving a string message
     over MPI. Each process will send a message to process with rank 0,
     which will then display it.  To run this example, set the variables
     HOSTFILE and NUMBER_OF_MPI_NODES to appropriate values, then type
     the following command in your shell:
          mpirun --hostfile $HOSTFILE -np $NUMBER_OF_MPI_NODES octave --eval 'pkg load mpi; hellocell ()'

     See also:
     hello2dimmat,helloworld,hellosparsemat,hellostruct,mc_example,montecarlo,Pi.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 75
This function demonstrates sending and receiving a string message over
MPI.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
hellosparsemat


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 578
 -- Function File: = hellosparsemat ()
     This function demonstrates sending and receiving a sparse matrix
     over MPI. Each process will send a a sparse matrix to process with
     rank 0, which will then display it.  To run this example, set the
     variables HOSTFILE and NUMBER_OF_MPI_NODES to appropriate values,
     then type the following command in your shell:
          mpirun --hostfile $HOSTFILE -np $NUMBER_OF_MPI_NODES octave --eval 'pkg load mpi; hellosparsemat ()'

     See also:
     hello2dimmat,helloworld,hellocell,hellostruct,mc_example,montecarlo,Pi.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 74
This function demonstrates sending and receiving a sparse matrix over
MPI.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
hellostruct


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 561
 -- Function File: = hellostruct ()
     This function demonstrates sending and receiving a struct over MPI.
     Each process will send a a struct to process with rank 0, which
     will then display it.  To run this example, set the variables
     HOSTFILE and NUMBER_OF_MPI_NODES to appropriate values, then type
     the following command in your shell:
          mpirun --hostfile $HOSTFILE -np $NUMBER_OF_MPI_NODES octave --eval 'pkg load mpi; hellostruct ()'

     See also:
     hello2dimmat,helloworld,hellocell,hellosparsemat,mc_example,montecarlo,Pi.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 67
This function demonstrates sending and receiving a struct over MPI.



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 567
 -- Function File: = helloworld ()
     This function demonstrates sending and receiving a string message
     over MPI. Each process will send a message to process with rank 0,
     which will then display it.  To run this example, set the variables
     HOSTFILE and NUMBER_OF_MPI_NODES to appropriate values, then type
     the following command in your shell:
          mpirun --hostfile $HOSTFILE -np $NUMBER_OF_MPI_NODES octave --eval 'pkg load mpi; helloworld ()'

     See also:
     hello2dimmat,hellocell,hellosparsemat,hellostruct,mc_example,montecarlo,Pi.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 75
This function demonstrates sending and receiving a string message over
MPI.



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 241
 -- Function File: = mc_example ()
     Demonstrates doing Monte Carlo with mpi.  Does Monte Carlo on the
     OLS estimator.  Uses montecarlo.m

     See also:
     hello2dimmat,helloworld,hellocell,hellosparsemat,Pi,montecarlo,hellostruct.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 40
Demonstrates doing Monte Carlo with mpi.



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


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1093
 -- Function File: [N_RECEIVED] = montecarlo (F, F_ARGS, REPS, OUTFILE,
          N_POOLED, N_RETURNS, USEMPI, VERBOSE)
     Generate a specified number of replications of a function's output
     and write them to a user-specified output file.

     IMPORTANT: F should return a row vector of output from feval (f,
     f_args)

     For normal evaluation on one core, only the first 4 arguments are
     required.

        - Arg 1: (required) the function that generates a row vector of
          output
        - Arg 2: (required) the arguments of the function, in a cell
        - Arg 3: (required) the number of replications to generate
        - Arg 4: (required) the output file name
        - Arg 5 (optional) number of replications to be pooled together
          between writes
        - Arg 6 (optional) verbose: 1 for on, 0 for off

     If using MPI, you should run using ranks equal to number of cores
     plus 1, and should make sure that the core running the frontend is
     also the one that has the second rank.  That way the core the
     frontend is on will also do work.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Generate a specified number of replications of a function's output and
write the