Uni/MPIonCell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
master
MPIonCell/documentation/enduser/html/d8/d8f/group__environment__information.html
T
matzman 9ce8b5485d Initial commit.
2017-10-26 19:57:24 +02:00

151 lines
8.1 KiB
HTML
Executable File
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPI On Cell (Documentation): Implementation Information</title>
<link href="../../doxygen.css" rel="stylesheet" type="text/css">
<link href="../../tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="../../main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="../../modules.html"><span>Modules</span></a></li>
<li><a href="../../annotated.html"><span>Data&nbsp;Structures</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Implementation Information<br>
<small>
[<a class="el" href="../../de/d1b/group__environment__main.html">Environmental Management</a>]</small>
</h1>
<p>
<div class="dynheader">
Collaboration diagram for Implementation Information:</div>
<div class="dynsection">
<center><table><tr><td><img src="../../d8/d8f/group__environment__information.png" border="0" alt="" usemap="#d6/daa/d8_2d8f_2group____environment____information_map">
<map name="d6/daa/d8_2d8f_2group____environment____information_map">
<area shape="rect" href="../../de/d1b/group__environment__main.html" title="This chapter discusses routines for getting and, where appropriate, setting various..." alt="" coords="5,5,187,32"></map></td></tr></table></center>
</div>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Functions to return some information about the execution environment and the MOC-implementation.
<p>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g872c24341022407f606e48c7987f1d40"></a><!-- doxytag: member="environment_information::MOC_VERSION" ref="g872c24341022407f606e48c7987f1d40" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8f/group__environment__information.html#g872c24341022407f606e48c7987f1d40">MOC_VERSION</a>&nbsp;&nbsp;&nbsp;0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Major version-number of this MOC-Implementation. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd51bfe8de83ee5b0dad9f61c855ae666"></a><!-- doxytag: member="environment_information::MOC_SUBVERSION" ref="gd51bfe8de83ee5b0dad9f61c855ae666" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8f/group__environment__information.html#gd51bfe8de83ee5b0dad9f61c855ae666">MOC_SUBVERSION</a>&nbsp;&nbsp;&nbsp;9</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minor version-number of this MOC-Implementation. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g58f559d6df810dbe1c633b3d68e9624f"></a><!-- doxytag: member="environment_information::MOC_MAX_PROCESSOR_NAME" ref="g58f559d6df810dbe1c633b3d68e9624f" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8f/group__environment__information.html#g58f559d6df810dbe1c633b3d68e9624f">MOC_MAX_PROCESSOR_NAME</a>&nbsp;&nbsp;&nbsp;4</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum length of the string returned by MOC_Get_processor_name. <br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8f/group__environment__information.html#gf69e7617a61a2eaa2783e718f2df5270">MOC_Get_processor_name</a> (char *name, int *resultlen)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the name of the processor. <a href="#gf69e7617a61a2eaa2783e718f2df5270"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d8f/group__environment__information.html#g9a54df3ad074f8fc91abddf7666474ea">MOC_Get_version</a> (int *version, int *subversion)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the major and minor version of this MOC-implementation. <a href="#g9a54df3ad074f8fc91abddf7666474ea"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gf69e7617a61a2eaa2783e718f2df5270"></a><!-- doxytag: member="moc.h::MOC_Get_processor_name" ref="gf69e7617a61a2eaa2783e718f2df5270" args="(char *name, int *resultlen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MOC_Get_processor_name </td>
<td>(</td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&nbsp;</td>
<td class="paramname"> <em>resultlen</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the name of the processor.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This function returns "SPU" if the calling process is running on a SPU otherwise it's running on the "PPU".</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td><b>out</b> Specifies the processor-type the calling process is runnning on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultlen</em>&nbsp;</td><td><b>out</b> Length (in characters) of the name </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>MOC_SUCCESS</em>&nbsp;</td><td>No error; MPI routine completed successfully. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g9a54df3ad074f8fc91abddf7666474ea"></a><!-- doxytag: member="moc.h::MOC_Get_version" ref="g9a54df3ad074f8fc91abddf7666474ea" args="(int *version, int *subversion)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MOC_Get_version </td>
<td>(</td>
<td class="paramtype">int *&nbsp;</td>
<td class="paramname"> <em>version</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&nbsp;</td>
<td class="paramname"> <em>subversion</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the major and minor version of this MOC-implementation.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Can be called before MOC_Init and after MOC_Finalize.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>version</em>&nbsp;</td><td><b>out</b> Major version of this MOC-implementation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subversion</em>&nbsp;</td><td><b>out</b> Minor version of this MOC-implementation </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>MOC_SUCCESS</em>&nbsp;</td><td>Function returned successfully </td></tr>
</table>
</dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 12 13:48:17 2009 for MPI On Cell (Documentation) by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="../../doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink