<?xml-stylesheet type="text/xsl" href="../styles/pmathml.xsl"?>
<!-- saved from url=(0014)about:internet -->
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:dsi="http://www.w3.org/1999/xlink" xmlns:m="http://www.w3.org/1998/Math/MathML" xml:space="preserve"><head><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><title>E04NMF/E04NMA : NAG Library, Mark 22</title><link rel="stylesheet" href="../styles/libdoc.css" type="text/css"/><script type="text/javascript">
   function showLevel(_levelId){
    var thisLevel = document.getElementById(_levelId);
    var thisplus = document.getElementById( _levelId.concat('plus'));
    var thisminus = document.getElementById( _levelId.concat('minus'));
    if(thisLevel.style.display != "block"){
     thisLevel.style.display = "block";
     thisplus.style.display = "none";
     thisminus.style.display = "inline";
     }
    else{
     thisLevel.style.display = "none";
     thisminus.style.display = "none";
     thisplus.style.display = "inline";
     }
    }
  </script></head><body><hr/><div><a class="rout" href="../../pdf/E04/e04nmf.pdf">E04NMF/E04NMA (PDF version)</a></div><div><a class="chap" href="e04conts.xml">E04 Chapter Contents</a></div><div><a class="chapint" href="e04intro.xml">E04 Chapter Introduction</a></div>
<div><a class="htmltoc" href="../FRONTMATTER/manconts.xml">NAG Library Manual</a></div><hr/><h1 class="libdoc">NAG Library Routine Document<br/><br/>E04NMF/E04NMA</h1><div class="paramtext"><div class="header"><b>Note:</b>&#160; before using this routine, please read the Users' Note for your implementation to check the interpretation of <span class="bitalic">bold italicised</span> terms and other implementation-dependent details.</div></div> 
<div class="htmltoc">
<h2 class="htmltoc"><span class="htmltochead" onclick="showLevel('htmltoc');"><span class="htmltocplus" id="htmltocplus">+</span><span class="htmltocminus" id="htmltocminus">&#8722;</span></span>&#160;Contents</h2>
<div class="htmltocitem" id="htmltoc">
<div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#purpose">1&#160;&#160;<b>Purpose</b></a>
</div><div class="htmltoc">
<span class="htmltoc" onclick="showLevel('tocspecification');"><span class="htmltocplus" id="tocspecificationplus">+</span><span class="htmltocminus" id="tocspecificationminus">&#8722;</span></span>
<a class="htmltoc" href="#specification">2&#160;&#160;<b>Specification</b></a>
<div class="htmltocitem" id="tocspecification">
<div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#routFspec">2.1&#160;&#160;<b>Specification for E04NMF</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#routAspec">2.2&#160;&#160;<b>Specification for E04NMA</b></a>
</div>
</div>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#description">3&#160;&#160;<b>Description</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#references">4&#160;&#160;<b>References</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#parameters">5&#160;&#160;<b>Parameters</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#errors">6&#160;&#160;<b>Error Indicators and Warnings</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#accuracy">7&#160;&#160;<b>Accuracy</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#fcomments">8&#160;&#160;<b>Further Comments</b></a>
</div><div class="htmltoc">
<span class="htmltocplus">&#160;&#160;&#160;</span>
<a class="htmltoc" href="#example">9&#160;&#160;<b>Example</b></a>
</div>
</div>
</div><h2 class="standard"><a class="sec" name="purpose" id="purpose"/>1&#160;&#160;Purpose</h2>
<div class="paramtext">To supply individual optional parameters to <a class="rout" href="../E04/e04nkf.xml">E04NKF/E04NKA</a>.  More precisely, E04NMF must be used to supply optional parameters to <a class="rout" href="../E04/e04nkf.xml">E04NKF</a> and E04NMA must be used to supply optional parameters to <a class="rout" href="../E04/e04nkf.xml">E04NKA</a>.</div>
<div class="paramtext">E04NMA is a version of E04NMF that has additional parameters in order to make it safe for use in multithreaded applications (see <a class="sec" href="#parameters">Section 5</a>).  The initialization routine <a class="rout" href="../E04/e04wbf.xml">E04WBF</a> <b>must</b> have been called before calling E04NMA.</div><h2 class="standard"><a class="sec" name="specification" id="specification"/>2&#160;&#160;Specification</h2><h3 class="standard"><a class="sec" name="routFspec" id="routFspec"/>2.1&#160;&#160;Specification for E04NMF</h3>
<table class="fspec"><tr><td class="tdfspec1">SUBROUTINE&#160;E04NMF&#160;(</td><td class="tdfspec2"><a class="arg" href="#STR">STR</a>)</td></tr><tr><td class="tdfspec1">CHARACTER*(*)</td><td class="tdfspec2">STR</td></tr></table><h3 class="standard"><a class="sec" name="routAspec" id="routAspec"/>2.2&#160;&#160;Specification for E04NMA</h3>
<table class="fspec"><tr><td class="tdfspec1">SUBROUTINE&#160;E04NMA&#160;(</td><td class="tdfspec2"><a class="arg" href="#STR">STR</a>, <a class="arg" href="#LWSAV">LWSAV</a>, <a class="arg" href="#IWSAV">IWSAV</a>, <a class="arg" href="#RWSAV">RWSAV</a>, <a class="arg" href="#INFORM">INFORM</a>)</td></tr><tr><td class="tdfspec1">INTEGER</td><td class="tdfspec2">IWSAV(380), INFORM</td></tr><tr><td class="tdfspec1"><b><i>double&#160;precision</i></b></td><td class="tdfspec2">RWSAV(285)</td></tr><tr><td class="tdfspec1">LOGICAL</td><td class="tdfspec2">LWSAV(20)</td></tr><tr><td class="tdfspec1">CHARACTER*(*)</td><td class="tdfspec2">STR</td></tr></table><h2 class="standard"><a class="sec" name="description" id="description"/>3&#160;&#160;Description</h2>
<div class="paramtext">E04NMF/E04NMA may be used to supply values for optional parameters to

<a class="rout" href="../E04/e04nkf.xml">E04NKF/E04NKA</a>.  It is only necessary to call E04NMF/E04NMA for those parameters whose values are to be different from their default values.  One call to E04NMF/E04NMA sets one parameter value.</div><div class="paramtext">
Each optional parameter is defined by a single character string, 
of up to <m:math><m:mn>72</m:mn></m:math>&#160;characters, 
consisting of one or more items.  The items associated with a given option must be separated by spaces, or equals signs <m:math><m:mfenced open="[" close="]" separators=""><m:mo>=</m:mo></m:mfenced></m:math>.  Alphabetic characters may be upper or lower case.  The string 
<pre class="verbatim">Print Level = 1</pre> 
is an example of a string used to set an optional parameter.  For each option the string contains one or more of the following items:
<table class="standard-100"><tr>
<td style="width:1.2em;" valign="baseline">&#8211;</td>
<td valign="top">a mandatory keyword;</td>
</tr><tr>
<td style="width:1.2em;" valign="baseline">&#8211;</td>
<td valign="top">a phrase that qualifies the keyword;</td>
</tr><tr>
<td style="width:1.2em;" valign="baseline">&#8211;</td>
<td valign="top">a number that specifies an INTEGER or <span class="bitalic">double precision</span> value.  Such numbers may be up to <m:math><m:mn>16</m:mn></m:math>&#160;contiguous characters 
in Fortran's I, F, E or D formats,

terminated by a space if this is not the last item on the line.</td>
</tr></table>
</div><div class="paramtext">Blank strings and comments are ignored.  A comment begins with an asterisk (*) and all subsequent characters in the string are regarded as part of the comment.</div>
<div class="paramtext">For E04NMF, each user-specified option is normally printed as it is defined, on the current advisory message unit (see <a class="rout" href="../X04/x04abf.xml">X04ABF</a>), but this printing may be suppressed using the keyword <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="../E04/e04nkf.xml#optparam_nolist"><m:mi mathcolor="#800080;" mathvariant="bold">Nolist</m:mi></m:maction></m:math>.  Thus the statement
<pre class="verbatim">
 CALL E04NMF ('Nolist')
</pre>

suppresses printing of this and subsequent options.  Printing will automatically be turned on again after a call to <a class="rout" href="../E04/e04nkf.xml">E04NKF</a> and may be turned on again at any time using the keyword <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="../E04/e04nkf.xml#optparam_list"><m:mi mathcolor="#800080;" mathvariant="bold">List</m:mi></m:maction></m:math>.</div><div class="paramtext">For E04NMA printing is turned off by default, but may be turned on at any time using the keyword <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="../E04/e04nkf.xml#optparam_list"><m:mi mathcolor="#800080;" mathvariant="bold">List</m:mi></m:maction></m:math>.</div>
<div class="paramtext">Optional parameter settings are preserved following a call to <a class="rout" href="../E04/e04nkf.xml">E04NKF/E04NKA</a> and so the keyword <m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="../E04/e04nkf.xml#optparam_defaults"><m:mi mathcolor="#800080;" mathvariant="bold">Defaults </m:mi></m:maction></m:math>&#160;is provided to allow you to reset all the optional parameters to their default values before a subsequent call to <a class="rout" href="../E04/e04nkf.xml">E04NKF/E04NKA</a>.</div><div class="paramtext">A complete list of optional parameters, their abbreviations, synonyms and default values is given in <a class="sec" href="../E04/e04nkf.xml#optparams">Section 11</a> in E04NKF/E04NKA.</div><h2 class="standard"><a class="sec" name="references" id="references"/>4&#160;&#160;References</h2>
<div class="paramtext">None.</div><h2 class="standard"><a class="sec" name="parameters" id="parameters"/>5&#160;&#160;Parameters</h2>
<dl><dt class="paramhead"><a name="STR" id="STR"/>1: &#160;&#160;&#8194; STR &#8211; CHARACTER*(*)<span class="pclass">Input</span></dt><dd><div class="paramtext"><i>On entry</i>: a single valid option string (as described in <a class="sec" href="#description">Section 3</a> and in <a class="sec" href="../E04/e04nkf.xml#optparams">Section 11</a> in E04NKF/E04NKA).</div></dd><dd class="note"><b>Note:</b> <span class="italic"> the following are additional parameters for specific use with E04NMA.  Users of E04NMF therefore need not read the remainder of this description</span>.</dd><dt class="paramhead"><a name="LWSAV" id="LWSAV"/>2: &#160;&#160;&#8194; LWSAV(<m:math><m:mn>20</m:mn></m:math>) &#8211; LOGICAL array<span class="pclass">Communication Array</span></dt><dt class="multi-paramhead"><a name="IWSAV" id="IWSAV"/>3: &#160;&#160;&#8194; IWSAV(<m:math><m:mn>380</m:mn></m:math>) &#8211; INTEGER array<span class="pclass">Communication Array</span></dt><dt class="multi-paramhead"><a name="RWSAV" id="RWSAV"/>4: &#160;&#160;&#8194; RWSAV(<m:math><m:mn>285</m:mn></m:math>) &#8211; <span class="bitalic">double precision</span> array<span class="pclass">Communication Array</span></dt><dd><div class="paramtext">The arrays <a class="arg" href="#LWSAV">LWSAV</a>, <a class="arg" href="#IWSAV">IWSAV</a> and <a class="arg" href="#RWSAV">RWSAV</a> <b>must not</b> be altered between calls to any of the routines E04NMA, <a class="rout" href="../E04/e04nkf.xml">E04NKA</a>, <a class="rout" href="../E04/e04nlf.xml">E04NLA</a> or <a class="rout" href="../E04/e04wbf.xml">E04WBF</a>.</div></dd><dt class="paramhead"><a name="INFORM" id="INFORM"/>5: &#160;&#160;&#8194; INFORM &#8211; INTEGER<span class="pclass">Output</span></dt><dd>
<div class="paramtext"><i>On exit</i>: contains zero if a valid option string has been supplied and a <m:math><m:mtext>value</m:mtext><m:mo>&gt;</m:mo><m:mn>0</m:mn></m:math>&#160;otherwise (see <a class="sec" href="#errors">Section 6</a>).</div></dd></dl><h2 class="standard"><a class="sec" name="errors" id="errors"/>6&#160;&#160;Error Indicators and Warnings</h2>
<div class="paramtext">Errors or warnings detected by the routine:</div>
<dl class="ifail"><dt class="errorhead"><a name="IMeq5" id="IMeq5"/><m:math><m:maction actiontype="link" dsi:type="simple" dsi:href="#INFORM"><m:mi mathcolor="#EE0000" mathvariant="bold">INFORM</m:mi></m:maction><m:mo>=</m:mo><m:mn>5</m:mn></m:math></dt><dd><div class="paramtext">The supplied option is invalid.  Check that the keywords are neither ambiguous nor misspelt.</div></dd></dl><h2 class="standard"><a class="sec" name="accuracy" id="accuracy"/>7&#160;&#160;Accuracy</h2>
<div class="paramtext">Not applicable.</div><h2 class="standard"><a class="sec" name="fcomments" id="fcomments"/>8&#160;&#160;Further Comments</h2>
<div class="paramtext"><a class="rout" href="../E04/e04nlf.xml">E04NLF/E04NLA</a> may also be used to supply optional parameters to

<a class="rout" href="../E04/e04nkf.xml">E04NKF/E04NKA</a>.</div><h2 class="standard"><a class="sec" name="example" id="example"/>9&#160;&#160;Example</h2>
<div class="paramtext">See <a class="sec" href="../E04/e04nlf.xml#example">Section 9</a> in E04NLF/E04NLA.</div>
<hr/><div><a class="rout" href="../../pdf/E04/e04nmf.pdf">E04NMF/E04NMA (PDF version)</a></div><div><a class="chap" href="e04conts.xml">E04 Chapter Contents</a></div><div><a class="chapint" href="e04intro.xml">E04 Chapter Introduction</a></div>
<div><a class="htmltoc" href="../FRONTMATTER/manconts.xml">NAG Library Manual</a></div>
<div><hr/><a class="genint" href="../FRONTMATTER/copyright.xml">&#169; The Numerical Algorithms Group Ltd, Oxford, UK. 2009</a></div></body></html>
