PageRenderTime 42ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/1.1.8/generated/cf.OF_FRACTION.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 221 lines | 177 code | 14 blank | 30 comment | 0 complexity | 9c3d365167f0c303d80bf10a30b3fc5d MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>cf.OF_FRACTION &mdash; Documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    13. 

  13.     
    14. 

  14.     <script type="text/javascript">
    15. 

  15.       var DOCUMENTATION_OPTIONS = {
    16. 

  16.         URL_ROOT:    '../',
    17. 

  17.         VERSION:     '1.1.8',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

  23.     <script type="text/javascript" src="../_static/jquery.js"></script>
    24. 

  24.     <script type="text/javascript" src="../_static/underscore.js"></script>
    25. 

  25.     <script type="text/javascript" src="../_static/doctools.js"></script>
    26. 

  26.     <script type="text/javascript" src="../_static/copybutton.js"></script>
    27. 

  27.     <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    28. 

  28.     <link rel="top" title="Documentation" href="../index.html" />
    29. 

  29.     <link rel="up" title="Functions of the cf module" href="../function.html" />
    30. 

  30.     <link rel="next" title="cf.REGRID_LOGGING" href="cf.REGRID_LOGGING.html" />
    31. 

  31.     <link rel="prev" title="cf.MINNCFM" href="cf.MINNCFM.html" /> 
    32. 

  32.   </head>
    33. 

  33.   <body role="document">
    34. 

  34.     <div class="related" role="navigation" aria-label="related navigation">
    35. 

  35.       <h3>Navigation</h3>
    36. 

  36.       <ul>
    37. 

  37.         <li class="right" style="margin-right: 10px">
    38. 

  38.           <a href="../genindex.html" title="General Index"
    39. 

  39.              accesskey="I">index</a></li>
    40. 

  40.         <li class="right" >
    41. 

  41.           <a href="cf.REGRID_LOGGING.html" title="cf.REGRID_LOGGING"
    42. 

  42.              accesskey="N">next</a> |</li>
    43. 

  43.         <li class="right" >
    44. 

  44.           <a href="cf.MINNCFM.html" title="cf.MINNCFM"
    45. 

  45.              accesskey="P">previous</a> |</li>
    46. 

  46.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1.8</a> &raquo;</li>
    47. 

  47. <!--
    48. 

  48.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python</a> &raquo;</li>
    49. 

  49.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    50. 

  50. 

  51.       <option value="../../1.0/index.html">1.0
    52. 

  52. 

  53.       <option value="../../0.9.9/index.html">0.9.9
    54. 

  54. 

  55.       <option value="../../0.9.8.3/index.html">0.9.8.3
    56. 

  56. 

  57.       <option value="../../archive.html">Archive
    58. 

  58. 

  59.       </select>
    60. 

  60.   </li>
    61. 

  61. -->
    62. 

  62.   
    63. 

  63.         <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> &raquo;</li>
    64. 

  64. 

  65.           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> &raquo;</li>
    66. 

  66.           <li class="nav-item nav-item-2"><a href="../function.html" accesskey="U">Functions of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> &raquo;</li> 
    67. 

  67.       </ul>
    68. 

  68.     </div>  
    69. 

  69. 

  70.     <div class="document">
    71. 

  71.       <div class="documentwrapper">
    72. 

  72.         <div class="bodywrapper">
    73. 

  73.           <div class="body" role="main">
    74. 

  74.             
    75. 

  75.   <div class="section" id="cf-of-fraction">
    76. 

  76. <h1>cf.OF_FRACTION<a class="headerlink" href="#cf-of-fraction" title="Permalink to this headline"></a></h1>
    77. 

  77. <dl class="function">
    78. 

  78. <dt id="cf.OF_FRACTION">
    79. 

  79. <code class="descclassname">cf.</code><code class="descname">OF_FRACTION</code><span class="sig-paren">(</span><em>*arg</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.1.8/cf/functions.py#functions.py-361"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.OF_FRACTION" title="Permalink to this definition"></a></dt>
    80. 

  80. <dd><p>The amount of concurrently open files above which files containing
    81. 

  81. data arrays may be automatically closed.</p>
    82. 

  82. <p>The amount is expressed as a fraction of the maximum possible number
    83. 

  83. of concurrently open files.</p>
    84. 

  84. <p>Note that closed files will be automatically reopened if subsequently
    85. 

  85. needed by a variable to access its data array.</p>
    86. 

  86. <table class="docutils field-list" frame="void" rules="none">
    87. 

  87. <col class="field-name" />
    88. 

  88. <col class="field-body" />
    89. 

  89. <tbody valign="top">
    90. 

  90. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
    91. 

  91. <dt>arg <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
    92. 

  92. <dd><p class="first last">The new fraction (between 0.0 and 1.0). The default is to not
    93. 

  93. change the current behaviour.</p>
    94. 

  94. </dd>
    95. 

  95. </dl>
    96. 

  96. </td>
    97. 

  97. </tr>
    98. 

  98. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
    99. 

  99. <dt>out <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
    100. 

  100. <dd><p class="first last">The value prior to the change, or the current value if no new
    101. 

  101. value was specified.</p>
    102. 

  102. </dd>
    103. 

  103. </dl>
    104. 

  104. </td>
    105. 

  105. </tr>
    106. 

  106. </tbody>
    107. 

  107. </table>
    108. 

  108. <div class="admonition seealso">
    109. 

  109. <p class="first admonition-title">See also</p>
    110. 

  110. <p class="last"><a class="reference internal" href="cf.close_files.html#cf.close_files" title="cf.close_files"><code class="xref py py-obj docutils literal"><span class="pre">cf.close_files</span></code></a>, <a class="reference internal" href="cf.close_one_file.html#cf.close_one_file" title="cf.close_one_file"><code class="xref py py-obj docutils literal"><span class="pre">cf.close_one_file</span></code></a>, <a class="reference internal" href="cf.open_files.html#cf.open_files" title="cf.open_files"><code class="xref py py-obj docutils literal"><span class="pre">cf.open_files</span></code></a>,
    111. 

  111. <a class="reference internal" href="cf.open_files_threshold_exceeded.html#cf.open_files_threshold_exceeded" title="cf.open_files_threshold_exceeded"><code class="xref py py-obj docutils literal"><span class="pre">cf.open_files_threshold_exceeded</span></code></a></p>
    112. 

  112. </div>
    113. 

  113. <table class="docutils field-list" frame="void" rules="none">
    114. 

  114. <col class="field-name" />
    115. 

  115. <col class="field-body" />
    116. 

  116. <tbody valign="top">
    117. 

  117. <tr class="field-odd field"><th class="field-name">Examples:</th><td class="field-body"></td>
    118. 

  118. </tr>
    119. 

  119. </tbody>
    120. 

  120. </table>
    121. 

  121. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">cf</span><span class="o">.</span><span class="n">OF_FRACTION</span><span class="p">()</span>
    122. 

  122. <span class="go">0.5</span>
    123. 

  123. <span class="gp">&gt;&gt;&gt; </span><span class="n">old</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">OF_FRACTION</span><span class="p">(</span><span class="mf">0.33</span><span class="p">)</span>
    124. 

  124. <span class="gp">&gt;&gt;&gt; </span><span class="n">cf</span><span class="o">.</span><span class="n">OF_FRACTION</span><span class="p">(</span><span class="n">old</span><span class="p">)</span>
    125. 

  125. <span class="go">0.33</span>
    126. 

  126. <span class="gp">&gt;&gt;&gt; </span><span class="n">cf</span><span class="o">.</span><span class="n">OF_FRACTION</span><span class="p">()</span>
    127. 

  127. <span class="go">0.5</span>
    128. 

  128. </pre></div>
    129. 

  129. </div>
    130. 

  130. <p>The fraction may be translated to an actual number of files as
    131. 

  131. follows:</p>
    132. 

  132. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">old</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">OF_FRACTION</span><span class="p">(</span><span class="mf">0.75</span><span class="p">)</span>
    133. 

  133. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">resource</span>
    134. 

  134. <span class="gp">&gt;&gt;&gt; </span><span class="n">max_open_files</span> <span class="o">=</span> <span class="n">resource</span><span class="o">.</span><span class="n">getrlimit</span><span class="p">(</span><span class="n">resource</span><span class="o">.</span><span class="n">RLIMIT_NOFILE</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
    135. 

  135. <span class="gp">&gt;&gt;&gt; </span><span class="n">threshold</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">max_open_files</span> <span class="o">*</span> <span class="n">cf</span><span class="o">.</span><span class="n">OF_FRACTION</span><span class="p">())</span>
    136. 

  136. <span class="gp">&gt;&gt;&gt; </span><span class="n">max_open_files</span><span class="p">,</span> <span class="n">threshold</span>
    137. 

  137. <span class="go">(1024, 768)</span>
    138. 

  138. </pre></div>
    139. 

  139. </div>
    140. 

  140. </dd></dl>
    141. 

  141. 

  142. </div>
    143. 

  143. 

  144. 

  145.           </div>
    146. 

  146.         </div>
    147. 

  147.       </div>
    148. 

  148.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    149. 

  149.         <div class="sphinxsidebarwrapper">
    150. 

  150.   <h4>Previous topic</h4>
    151. 

  151.   <p class="topless"><a href="cf.MINNCFM.html"
    152. 

  152.                         title="previous chapter">cf.MINNCFM</a></p>
    153. 

  153.   <h4>Next topic</h4>
    154. 

  154.   <p class="topless"><a href="cf.REGRID_LOGGING.html"
    155. 

  155.                         title="next chapter">cf.REGRID_LOGGING</a></p>
    156. 

  156.   <div role="note" aria-label="source link">
    157. 

  157.     <h3>This Page</h3>
    158. 

  158.     <ul class="this-page-menu">
    159. 

  159.       <li><a href="../_sources/generated/cf.OF_FRACTION.txt"
    160. 

  160.             rel="nofollow">Show Source</a></li>
    161. 

  161.     </ul>
    162. 

  162.    </div>
    163. 

  163. <div id="searchbox" style="display: none" role="search">
    164. 

  164.   <h3>Quick search</h3>
    165. 

  165.     <form class="search" action="../search.html" method="get">
    166. 

  166.       <input type="text" name="q" />
    167. 

  167.       <input type="submit" value="Go" />
    168. 

  168.       <input type="hidden" name="check_keywords" value="yes" />
    169. 

  169.       <input type="hidden" name="area" value="default" />
    170. 

  170.     </form>
    171. 

  171.     <p class="searchtip" style="font-size: 90%">
    172. 

  172.     Enter search terms or a module, class or function name.
    173. 

  173.     </p>
    174. 

  174. </div>
    175. 

  175. <script type="text/javascript">$('#searchbox').show(0);</script>
    176. 

  176.         </div>
    177. 

  177.       </div>
    178. 

  178.       <div class="clearer"></div>
    179. 

  179.     </div>
    180. 

  180.     <div class="related" role="navigation" aria-label="related navigation">
    181. 

  181.       <h3>Navigation</h3>
    182. 

  182.       <ul>
    183. 

  183.         <li class="right" style="margin-right: 10px">
    184. 

  184.           <a href="../genindex.html" title="General Index"
    185. 

  185.              >index</a></li>
    186. 

  186.         <li class="right" >
    187. 

  187.           <a href="cf.REGRID_LOGGING.html" title="cf.REGRID_LOGGING"
    188. 

  188.              >next</a> |</li>
    189. 

  189.         <li class="right" >
    190. 

  190.           <a href="cf.MINNCFM.html" title="cf.MINNCFM"
    191. 

  191.              >previous</a> |</li>
    192. 

  192.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1.8</a> &raquo;</li>
    193. 

  193. <!--
    194. 

  194.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python</a> &raquo;</li>
    195. 

  195.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    196. 

  196. 

  197.       <option value="../../1.0/index.html">1.0
    198. 

  198. 

  199.       <option value="../../0.9.9/index.html">0.9.9
    200. 

  200. 

  201.       <option value="../../0.9.8.3/index.html">0.9.8.3
    202. 

  202. 

  203.       <option value="../../archive.html">Archive
    204. 

  204. 

  205.       </select>
    206. 

  206.   </li>
    207. 

  207. -->
    208. 

  208.   
    209. 

  209.         <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> &raquo;</li>
    210. 

  210. 

  211.           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> &raquo;</li>
    212. 

  212.           <li class="nav-item nav-item-2"><a href="../function.html" >Functions of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> &raquo;</li> 
    213. 

  213.       </ul>
    214. 

  214.     </div>
    215. 

  215.     <div class="footer" role="contentinfo">
    216. 

  216.         &copy; Copyright 2016, David Hassell.
    217. 

  217.       Last updated on May 18, 2016.
    218. 

  218.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
    219. 

  219.     </div>
    220. 

  220.   </body>
    221. 

  221. </html>
    222.