[Octave-cvsupdate] SF.net SVN: octave:[10928] trunk/octave-forge/main/openmpi_ext

[<cd...@us...>]

Revision: 10928
          http://octave.svn.sourceforge.net/octave/?rev=10928&view=rev
Author:   cdf
Date:     2012-08-29 16:54:42 +0000 (Wed, 29 Aug 2012)
Log Message:
-----------
improve first help sentences

Modified Paths:
--------------
    trunk/octave-forge/main/openmpi_ext/src/MPI_Barrier.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_Test.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_rank.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_size.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Finalize.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Finalized.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Get_processor_name.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Init.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Initialized.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Iprobe.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Probe.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Recv.cc
    trunk/octave-forge/main/openmpi_ext/src/MPI_Send.cc

Removed Paths:
-------------
    trunk/octave-forge/main/openmpi_ext/inst/allnodes

Deleted: trunk/octave-forge/main/openmpi_ext/inst/allnodes
===================================================================
--- trunk/octave-forge/main/openmpi_ext/inst/allnodes	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/inst/allnodes	2012-08-29 16:54:42 UTC (rev 10928)
@@ -1,7 +0,0 @@
-#!/bin/bash
-# this script will run an Octave script using MPI with a given hostfile,
-# using a given number of ranks. Edit it to set the hostfile and number of nodes
-# then use it as follows: allnodes <your_script_name.m> 
-HOSTFILE="/home/user/tmp/bhosts"
-NUMBER_OF_NODES="33"
-mpirun --hostfile $HOSTFILE -np $NUMBER_OF_NODES octave -q --eval $1

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Barrier.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Barrier.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Barrier.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -28,9 +28,9 @@
 DEFUN_DLD (NAME, args, ,
 "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} @var{INFO} = MPI_Barrier (@var{COMM})\n\
-Blocks until all processes in the communicator have reached this routine.\n\
-If @var{COMM} octave comunicator object loaded with MPI_Comm_Load is omitted \n\
-returns an error. \n\
+Block processes in the communicator @var{COMM} untill the call to this routine has been reached by all.\n\
+The communicator object @var{COMM} (loaded with MPI_Comm_Load) must be specified otherwise \n\
+an error occurs. \n\
  @example\n\
  @group\n\
     @var{INFO} (int) return code\n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_Test.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_Test.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_Test.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -17,7 +17,7 @@
 #include "simple.h"
 DEFUN_DLD(MPI_Comm_Test, args, ,"-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} @var{DESCRIPTION} = MPI_Comm_Test (@var{COMM})\n\
-Return @var{DESCRIPTION} string description of the MPI_Communicator  @var{COMM}\n\
+Return @var{DESCRIPTION} string description of the MPI_Communicator  @var{COMM}.\n\
 For\n\
 example,\n\
 \n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_rank.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_rank.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_rank.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -26,9 +26,9 @@
 #include "simple.h"       
 DEFUN_DLD(NAME, args,nargout ,"-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} [@var{RANK} @var{INFO}] = MPI_Comm_rank (@var{COMM})\n\
-Determines rank of calling process in communicator.\n\
-If @var{COMM} octave comunicator object loaded with MPI_Comm_Load is omitted \n\
-returns an error. \n\
+Return the rank of the calling process in the specified communicator.\n\
+If the comunicator object @var{COMM} (loaded with MPI_Comm_Load) is omitted \n\
+an error is thrown. \n\
  @example\n\
  @group\n\
     @var{RANK} rank of the calling process in group of communicator\n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_size.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_size.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Comm_size.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -26,9 +26,9 @@
 #include "simple.h"  
 DEFUN_DLD(NAME, args,nargout ,"-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} [@var{RANK} @var{INFO}] = MPI_Comm_size (@var{COMM})\n\
-Determines size of calling process in communicator.\n\
-If @var{COMM} octave comunicator object loaded with MPI_Comm_Load is omitted \n\
-returns an error. \n\
+Return the size of a communicator.\n\
+The comunicator object @var{COMM} (loaded with MPI_Comm_Load) must be sepcified \n\
+or otherwise an error occurs. \n\
  @example\n\
  @group\n\
     @var{exprank} rank of the calling process in group of communicator\n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Finalize.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Finalize.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Finalize.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -27,8 +27,8 @@
 #include <octave/oct.h>
 
 DEFUN_DLD(NAME, args, nargout,"-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} @var{INFO} = MPI_Finalize()\n\
-           Terminates MPI execution environment\n\
+@deftypefn {Loadable Function} {} @var{INFO} = MPI_Finalize ()\n\
+Terminate the MPI execution environment.\n\
 \n\
  @example\n\
  @group\n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Finalized.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Finalized.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Finalized.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -24,8 +24,8 @@
 #include "mpi.h"       
 #include <octave/oct.h>
 DEFUN_DLD(NAME, args, nargout,"-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} [@var{FLAG} @var{INFO}] = MPI_Finalized\n\
-           Indicates whether MPI_Finalize has completed\n\
+@deftypefn {Loadable Function} {[@var{FLAG}, @var{INFO}]} = MPI_Finalized ()\n\
+Indicates whether MPI_Finalize has been executed.\n\
 \n\
  @example\n\
  @group\n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Get_processor_name.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Get_processor_name.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Get_processor_name.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -19,8 +19,8 @@
 #include <octave/oct.h>
 
 DEFUN_DLD(MPI_Get_processor_name, args, nargout,"-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} @var{name,resultlen,INFO} = MPI_Get_processor_name()\n\
-           Get the name of the processor that is using MPI\n\
+@deftypefn {Loadable Function} {} @var{name,resultlen,INFO} = MPI_Get_processor_name ()\n\
+Get the name of the processor that is using MPI.\n\
 \n\
  @example\n\
  @group\n\
@@ -29,9 +29,9 @@
       16 MPI_ERR_OTHER  Attempt was made to call MPI_Init a  second  time\n\
                        MPI_Init may only be called once in a program\n\
                        \n\
-SEE ALSO: MPI_Finalize, MPI_Initialized, MPI_Finalized\n\
 @end group\n\
 @end example\n\
+@seealso{MPI_Finalize, MPI_Initialized, MPI_Finalized}\n\
 @end deftypefn")
 {
   int info; 	

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Init.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Init.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Init.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -28,7 +28,7 @@
 
 DEFUN_DLD(NAME, args, nargout,"-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} @var{INFO} = MPI_Init()\n\
-           Initialize the MPI execution environment\n\
+Initialize the MPI execution environment.\n\
 \n\
  @example\n\
  @group\n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Initialized.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Initialized.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Initialized.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -27,7 +27,7 @@
 
 DEFUN_DLD(NAME, args, nargout,"-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} [@var{FLAG} @var{INFO}] = MPI_Initialized\n\
-           Indicates whether MPI_Init has been called\n\
+Indicates whether MPI_Init has been executed.\n\
 \n\
  @example\n\
  @group\n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Iprobe.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Iprobe.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Iprobe.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -44,8 +44,8 @@
 }
 
 DEFUN_DLD(NAME, args, nargout,"-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} [@var{FLAG} @var{STAT} @var{INFO}] = MPI_Iprobe(@var{SRCRANK}, @var{TAG}, @var{COMM})\n \
-           Nonblocking test for a message\n\
+@deftypefn {Loadable Function} {} [@var{FLAG} @var{STAT} @var{INFO}] = MPI_Iprobe(@var{SRCRANK}, @var{TAG}, @var{COMM})\n\
+Nonblocking test for an MPI message.\n\
  @example\n\
  @group\n\
  \n\
@@ -67,7 +67,7 @@
  @end group\n\
  @end example\n\
  \n\
-  SEE ALSO: MPI_Probe, MPI_Recv, MPI documentation for examples\n\
+@seealso{MPI_Probe, MPI_Recv, MPI documentation for examples}\n\
 @end deftypefn")
 {
   octave_value_list results;

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Probe.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Probe.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Probe.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -44,7 +44,7 @@
 
 DEFUN_DLD(NAME, args, nargout,"-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} [@var{STAT} @var{INFO}] = MPI_Probe(@var{SRCRANK}, @var{TAG}, @var{COMM})\n \
-           blocking test for a message\n\
+Blocking test for a message.\n\
  @example\n\
  @group\n\
  \n\
@@ -63,7 +63,7 @@
  @end group\n\
  @end example\n\
  \n\
-  SEE ALSO: MPI_Iprobe, MPI_Recv, and MPI documentation for C examples\n\
+@seealso{MPI_Iprobe, MPI_Recv, and MPI documentation for C examples}\n\
 @end deftypefn")
 {
   octave_value_list results;

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Recv.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Recv.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Recv.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -687,9 +687,9 @@
 
 DEFUN_DLD(MPI_Recv, args, nargout,"-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} [@var{VALUE} @var{INFO}]= MPI_Recv(@var{SOURCE},@var{TAG},@var{COMM})\n\
-MPI_Recv receive any Octave datatype into contiguous memory using openmpi library even over an heterogeneous cluster i.e 32 bits CPUs and 64 bits CPU \n \n\
-Returns @var{VALUE} that is an octave variable received\n\
-and an integer @var{INFO} to indicate success or failure  \
+Receive an MPI message containing an Octave variable packed into a contiguous memory chunk and extract its value.\n\
+The Octave variable being received is returned as @var{VALUE},\n\
+while @var{INFO} is an integer indicating success or failure.\n\
  @example\n\
  @group\n\
 @var{SOURCE} must be an integer indicating source processes \n\

Modified: trunk/octave-forge/main/openmpi_ext/src/MPI_Send.cc
===================================================================
--- trunk/octave-forge/main/openmpi_ext/src/MPI_Send.cc	2012-08-29 16:28:49 UTC (rev 10927)
+++ trunk/octave-forge/main/openmpi_ext/src/MPI_Send.cc	2012-08-29 16:54:42 UTC (rev 10928)
@@ -749,9 +749,8 @@
 DEFUN_DLD(MPI_Send, args, nargout, 
           "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{INFO} =} MPI_Send(@var{VALUE},@var{RANKS},@var{TAG},@var{COMM})\n\
-MPI_Send sends  any octave_value  into contiguous memory using openmpi library \n\
-even over an heterogeneous cluster i.e 32 bits CPUs and 64 bits CPU.\n\
-Returns an integer @var{INFO} to indicate success or failure of octave_value expedition.\n\
+Pack an Octave variable into a contiguous memory chunck and transmit it as an MPI message.\n\
+Return an integer @var{INFO} to indicate success or failure.\n\
 @example\n\
 @group\n\
 @var{VALUE} must be an octave variable \n\

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.