/usr/share/doc/mrmpi-doc/Manual.html

<HTML>
<HEAD>
<TITLE>MapReduce-MPI Library Users Manual</TITLE>
<META NAME="docnumber" CONTENT="http://mapreduce.sandia.gov">
<META NAME="author" CONTENT="Sandia National Laboratories, Copyright (2009) Sandia Corporation">
<META NAME="copyright" CONTENT="This software and manual is distributed under the modified Berkeley Software Distribution (BSD) License.">
</HEAD>

<BODY>

<CENTER><A HREF = "httpmapreduce.sandia.gov">MapReduce-MPI WWW Site</A> 
</CENTER>


<HR>

<H1></H1>

<H2><CENTER>MapReduce-MPI (MR-MPI) Library Documentation 
</CENTER></H2>
<H4>Version info: 
</H4>
<P>The MR-MPI "version" is the date when it was released, such as 1 May
2010.  MR-MPI is updated continuously.  Whenever we fix a bug or add a
feature, we release it immediately, and post a notice on <A HREF = "http://mapreduce.sandia.gov/bug.html">this page of
the WWW site</A>.  Each dated copy of MR-MPI contains all the
features and bug-fixes up to and including that version date. The
version date is printed to the screen every time you run a program
that uses MR-MPI. It is also in the file src/version.h and in the
MR-MPI directory name created when you unpack a tarball.
</P>
<UL><LI>If you browse the HTML or PDF doc pages on the MR-MPI WWW site, they
always describe the most current version of MR-MPI. 

<LI>If you browse the HTML or PDF doc pages included in your tarball, they
describe the version you have. 
</UL>
<P>The MapReduce-MPI (MR-MPI) library is open-source software that
implements the <A HREF = "http://en.wikipedia.org/wiki/Mapreduce">MapReduce operation</A> popularized by Google on top
of standard MPI message passing.
</P>
<P>The library is designed for parallel execution on distributed-memory
platforms, but will also operate on a single processor.  It requires
no additional software to build and run, except linking with an MPI
library if you wish to perform MapReduces in parallel.  Similar to the
original Google design, a user performs a MapReduce by writing a small
program that invokes the library.  The user typically provides two
application-specific functions, a "map()" and a "reduce()", that are
called back from the library when a MapReduce operation is executed.
"Map()" and "reduce()" are serial functions, meaning they are invoked
independently on individual processors on portions of your data when
performing a MapReduce operation in parallel.
</P>
<P>The MR-MPI library is written in C++ and is callable from hi-level
langauges such as C++, C, Fortran.  A Python wrapper is also included,
so MapReduce programs can be written in Python, including map() and
reduce() user callback methods.  A hi-level scripting interface to the
MR-MPI library, called OINK, is also included which can be used to
develop and chain MapReduce algorithms together in scripts with
commands that simplify data management tasks.  OINK has its own
<A HREF = "../oinkdoc/Manual.html">manual and doc pages</A>.
</P>
<P>The goal of the MR-MPI library is to provide a simple and portable
interface for users to create their own MapReduce programs, which can
then be run on any desktop or large parallel machine using MPI.  See
the Background section for features and limitations of this
implementation.
</P>
<P>The distrubution includes a few examples of simple programs that
illustrate the use of MR-MPI.
</P>
<P>Source code for the library and OINK is freely available for download
from the <A HREF = "http://mapreduce.sandia.gov">MR-MPI web site</A> and is licensed under the modified
<A HREF = "http://en.wikipedia.org/wiki/BSD_license">Berkeley Software Distribution (BSD) License</A>.  This basically
means they can be used by anyone for any purpose.  See the LICENSE
file provided with the distribution for more details.
</P>
<P>The authors of the MR-MPI library are <A HREF = "http://www.sandia.gov/~sjplimp">Steve Plimpton</A> and <A HREF = "http://www.cs.sandia.gov/~kddevin">Karen
Devine</A> who can be contacted via email: sjplimp,kddevin at
sandia.gov.
</P>












<HR>

<P>The MR-MPI documentation is organized into the following sections.  If
you find errors or omissions in this manual or have suggestions for
useful information to add, please send an email to the developers so
we can improve the MR-MPI documentation.
</P>
<P>Once you are familiar with MR-MPI, you may want to bookmark <A HREF = "Interface_c++.html">this
page</A> at interface_c++.html, since it gives quick
access to documentation for all the MR-MPI library methods.
</P>
<P><A HREF = "Manual.pdf">PDF file</A> of the entire manual, generated by
<A HREF = "http://www.easysw.com/htmldoc">htmldoc</A>
</P>
<UL><LI><A HREF = "Background.html">Background</A> 

<LI><A HREF = "Whatis.html">What is a MapReduce?</A> 

<LI><A HREF = "Start.html">Getting Started</A> 

<LI><A HREF = "Program.html">Writing a MapReduce program</A> 

<LI><A HREF = "Interface_c++.html">C++ Interface to the MapReduce-MPI Library</A> 

<UL><LI>  <A HREF = "create.html">Create a MapReduce object</A> 

<LI>  <A HREF = "copy.html">Copy a MapReduce object</A> 

<LI>  <A HREF = "destroy.html">Destroy a MapReduce object</A> 

<LI>  <A HREF = "add.html">MapReduce::add()</A> 

<LI>  <A HREF = "aggregate.html">MapReduce::aggregate()</A> 

<LI>  <A HREF = "broadcast.html">MapReduce::broadcast()</A> 

<LI>  <A HREF = "clone.html">MapReduce::clone()</A> 

<LI>  <A HREF = "open.html">MapReduce::close()</A> 

<LI>  <A HREF = "collapse.html">MapReduce::collapse()</A> 

<LI>  <A HREF = "collate.html">MapReduce::collate()</A> 

<LI>  <A HREF = "compress.html">MapReduce::compress()</A> 

<UL><LI>    <A HREF = "compress.html">MapReduce::multivalue_blocks()</A> 

<LI>    <A HREF = "compress.html">MapReduce::multivalue_block()</A> 
</UL>
<LI>  <A HREF = "convert.html">MapReduce::convert()</A> 

<LI>  <A HREF = "gather.html">MapReduce::gather()</A> 

<LI>  <A HREF = "map.html">MapReduce::map()</A> 

<LI>  <A HREF = "open.html">MapReduce::open()</A> 

<LI>  <A HREF = "print.html">MapReduce::print()</A> 

<LI>  <A HREF = "reduce.html">MapReduce::reduce()</A> 

<UL><LI>    <A HREF = "reduce.html">MapReduce::multivalue_blocks()</A> 

<LI>    <A HREF = "reduce.html">MapReduce::multivalue_block()</A> 
</UL>
<LI>  <A HREF = "scan.html">MapReduce::scan()</A> 

<LI>  <A HREF = "scrunch.html">MapReduce::scrunch()</A> 

<LI>  <A HREF = "sort_keys.html">MapReduce::sort_keys()</A> 

<LI>  <A HREF = "sort_values.html">MapReduce::sort_values()</A> 

<LI>  <A HREF = "sort_multivalues.html">MapReduce::sort_multivalues()</A> 

<LI>  <A HREF = "stats.html">MapReduce::kv_stats()</A> 

<LI>  <A HREF = "stats.html">MapReduce::kmv_stats()</A> 

<LI>  <A HREF = "stats.html">MapReduce::cummulative_stats()</A> 

<LI>  <A HREF = "kv_add.html">KeyValue::add()</A> 

<LI>  <A HREF = "settings.html">Settings and defaults</A> 
</UL>
<LI><A HREF = "Interface_c.html">C interface to the MapReduce-MPI Library</A> 

<LI><A HREF = "Interface_python.html">Python interface to the MapReduce-MPI Library</A> 

<LI><A HREF = "Interface_oink.html">OINK interface to the MapReduce-MPI Library</A> 

<LI><A HREF = "Technical.html">Technical Details</A> 

<LI><A HREF = "Examples/html">Examples</A> 

<UL><LI>  <A HREF = "Examples.html#word">Word frequency</A> 

<LI>  <A HREF = "Examples.html#rmat">R-MAT matrices</A> 
</UL>

</UL>
</BODY>

</HTML>
mrmpi-doc 1.0~20140404-1build2 / usr / share / doc / mrmpi-doc / Manual.html
