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

/docs/1.1.8/generated/cf.Field.equivalent_domain.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 199 lines | 155 code | 14 blank | 30 comment | 0 complexity | 5515b8dab42e8cc8c4623a425695e244 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.Field.equivalent_domain &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="cf.Field" href="../classes/cf.Field.html" />
    30. 

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

  31.     <link rel="prev" title="cf.Field.equivalent_data" href="cf.Field.equivalent_data.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.Field.close.html" title="cf.Field.close"
    42. 

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

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

  44.           <a href="cf.Field.equivalent_data.html" title="cf.Field.equivalent_data"
    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="../class.html" >Classes of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> &raquo;</li>
    67. 

  67.           <li class="nav-item nav-item-3"><a href="../classes/cf.Field.html" accesskey="U">cf.Field</a> &raquo;</li> 
    68. 

  68.       </ul>
    69. 

  69.     </div>  
    70. 

  70. 

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

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

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

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

  75.             
    76. 

  76.   <div class="section" id="cf-field-equivalent-domain">
    77. 

  77. <h1>cf.Field.equivalent_domain<a class="headerlink" href="#cf-field-equivalent-domain" title="Permalink to this headline">Âś</a></h1>
    78. 

  78. <dl class="method">
    79. 

  79. <dt id="cf.Field.equivalent_domain">
    80. 

  80. <code class="descclassname">Field.</code><code class="descname">equivalent_domain</code><span class="sig-paren">(</span><em>other</em>, <em>rtol=None</em>, <em>atol=None</em>, <em>traceback=False</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.1.8/cf/field.py#field.py-5653"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Field.equivalent_domain" title="Permalink to this definition">Âś</a></dt>
    81. 

  81. <dd><p>Return True if two fields have equivalent data domains.</p>
    82. 

  82. <table class="docutils field-list" frame="void" rules="none">
    83. 

  83. <col class="field-name" />
    84. 

  84. <col class="field-body" />
    85. 

  85. <tbody valign="top">
    86. 

  86. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first">other : cf.Field</p>
    87. 

  87. <dl class="docutils">
    88. 

  88. <dt>atol <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
    89. 

  89. <dd><p class="first last">The absolute tolerance for all numerical comparisons, By
    90. 

  90. default the value returned by the <a class="reference internal" href="cf.ATOL.html#cf.ATOL" title="cf.ATOL"><code class="xref py py-obj docutils literal"><span class="pre">cf.ATOL</span></code></a> function is used.</p>
    91. 

  91. </dd>
    92. 

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

  93. <dd><p class="first last">The relative tolerance for all numerical comparisons, By
    94. 

  94. default the value returned by the <a class="reference internal" href="cf.RTOL.html#cf.RTOL" title="cf.RTOL"><code class="xref py py-obj docutils literal"><span class="pre">cf.RTOL</span></code></a> function is used.</p>
    95. 

  95. </dd>
    96. 

  96. <dt>traceback <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
    97. 

  97. <dd><p class="first last">If True then print a traceback highlighting where the two
    98. 

  98. domains differ.</p>
    99. 

  99. </dd>
    100. 

  100. </dl>
    101. 

  101. </td>
    102. 

  102. </tr>
    103. 

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

  104. <dt>out <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
    105. 

  105. <dd><p class="first last">Whether or not the two fields&#8217; data arrays are equivalent.</p>
    106. 

  106. </dd>
    107. 

  107. </dl>
    108. 

  108. </td>
    109. 

  109. </tr>
    110. 

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

  111. </tr>
    112. 

  112. </tbody>
    113. 

  113. </table>
    114. 

  114. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">equivalent_domain</span><span class="p">(</span><span class="n">g</span><span class="p">)</span>
    115. 

  115. </pre></div>
    116. 

  116. </div>
    117. 

  117. </dd></dl>
    118. 

  118. 

  119. </div>
    120. 

  120. 

  121. 

  122.           </div>
    123. 

  123.         </div>
    124. 

  124.       </div>
    125. 

  125.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    126. 

  126.         <div class="sphinxsidebarwrapper">
    127. 

  127.   <h4>Previous topic</h4>
    128. 

  128.   <p class="topless"><a href="cf.Field.equivalent_data.html"
    129. 

  129.                         title="previous chapter">cf.Field.equivalent_data</a></p>
    130. 

  130.   <h4>Next topic</h4>
    131. 

  131.   <p class="topless"><a href="cf.Field.close.html"
    132. 

  132.                         title="next chapter">cf.Field.close</a></p>
    133. 

  133.   <div role="note" aria-label="source link">
    134. 

  134.     <h3>This Page</h3>
    135. 

  135.     <ul class="this-page-menu">
    136. 

  136.       <li><a href="../_sources/generated/cf.Field.equivalent_domain.txt"
    137. 

  137.             rel="nofollow">Show Source</a></li>
    138. 

  138.     </ul>
    139. 

  139.    </div>
    140. 

  140. <div id="searchbox" style="display: none" role="search">
    141. 

  141.   <h3>Quick search</h3>
    142. 

  142.     <form class="search" action="../search.html" method="get">
    143. 

  143.       <input type="text" name="q" />
    144. 

  144.       <input type="submit" value="Go" />
    145. 

  145.       <input type="hidden" name="check_keywords" value="yes" />
    146. 

  146.       <input type="hidden" name="area" value="default" />
    147. 

  147.     </form>
    148. 

  148.     <p class="searchtip" style="font-size: 90%">
    149. 

  149.     Enter search terms or a module, class or function name.
    150. 

  150.     </p>
    151. 

  151. </div>
    152. 

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

  153.         </div>
    154. 

  154.       </div>
    155. 

  155.       <div class="clearer"></div>
    156. 

  156.     </div>
    157. 

  157.     <div class="related" role="navigation" aria-label="related navigation">
    158. 

  158.       <h3>Navigation</h3>
    159. 

  159.       <ul>
    160. 

  160.         <li class="right" style="margin-right: 10px">
    161. 

  161.           <a href="../genindex.html" title="General Index"
    162. 

  162.              >index</a></li>
    163. 

  163.         <li class="right" >
    164. 

  164.           <a href="cf.Field.close.html" title="cf.Field.close"
    165. 

  165.              >next</a> |</li>
    166. 

  166.         <li class="right" >
    167. 

  167.           <a href="cf.Field.equivalent_data.html" title="cf.Field.equivalent_data"
    168. 

  168.              >previous</a> |</li>
    169. 

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

  170. <!--
    171. 

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

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

  173. 

  174.       <option value="../../1.0/index.html">1.0
    175. 

  175. 

  176.       <option value="../../0.9.9/index.html">0.9.9
    177. 

  177. 

  178.       <option value="../../0.9.8.3/index.html">0.9.8.3
    179. 

  179. 

  180.       <option value="../../archive.html">Archive
    181. 

  181. 

  182.       </select>
    183. 

  183.   </li>
    184. 

  184. -->
    185. 

  185.   
    186. 

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

  187. 

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

  189.           <li class="nav-item nav-item-2"><a href="../class.html" >Classes of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> &raquo;</li>
    190. 

  190.           <li class="nav-item nav-item-3"><a href="../classes/cf.Field.html" >cf.Field</a> &raquo;</li> 
    191. 

  191.       </ul>
    192. 

  192.     </div>
    193. 

  193.     <div class="footer" role="contentinfo">
    194. 

  194.         &copy; Copyright 2016, David Hassell.
    195. 

  195.       Last updated on May 18, 2016.
    196. 

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

  197.     </div>
    198. 

  198.   </body>
    199. 

  199. </html>
    200.