PageRenderTime 49ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/1.1.4/generated/cf.Field.equivalent.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 239 lines | 195 code | 14 blank | 30 comment | 0 complexity | 4af20e93b87be9a91b81fdf7b47f3752 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 &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.4',
    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.equivalent_data" href="cf.Field.equivalent_data.html" />
    31. 

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

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

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

  44.           <a href="cf.Field.equals.html" title="cf.Field.equals"
    45. 

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

  46.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1.4</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">
    77. 

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

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

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

  80. <code class="descclassname">Field.</code><code class="descname">equivalent</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 internal" href="../_modules/cf/field.html#Field.equivalent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Field.equivalent" title="Permalink to this definition">Âś</a></dt>
    81. 

  81. <dd><p>True if two fields are equivalent, False otherwise</p>
    82. 

  82. <p>two fields are equivalent if:</p>
    83. 

  83. <blockquote>
    84. 

  84. <div><ul class="simple">
    85. 

  85. <li>They have the same identity, as defined by their
    86. 

  86. <a class="reference internal" href="cf.Field.identity.html#cf.Field.identity" title="cf.Field.identity"><code class="xref py py-obj docutils literal"><span class="pre">identity</span></code></a> methods.</li>
    87. 

  87. <li>The same rank, as given by their <a class="reference internal" href="cf.Field.rank.html#cf.Field.rank" title="cf.Field.rank"><code class="xref py py-obj docutils literal"><span class="pre">rank</span></code></a> attributes.</li>
    88. 

  88. <li>Their data arrays are the same after accounting for different but
    89. 

  89. equivalent:<ul>
    90. 

  90. <li>Units</li>
    91. 

  91. <li>Number of size one dimensions (if <em>squeeze</em> is True),</li>
    92. 

  92. <li>Dimension directions (if <em>use_directions</em> is True)</li>
    93. 

  93. <li>Dimension orders (if <em>transpose</em> is set to a dictionary).</li>
    94. 

  94. </ul>
    95. 

  95. </li>
    96. 

  96. <li>Both fields&#8217; domains must have the same rankdimensionality and where a
    97. 

  97. dimension in one field has an identity inferred a 1-d coordinate,
    98. 

  98. the other field has a matching dimension whose identity inferred
    99. 

  99. is inferred from a 1-d coordinate with an equivalent data array.<ul>
    100. 

  100. <li>The rank, as given by their <a href="#id1"><span class="problematic" id="id2">`</span></a>~cf.Field.rank</li>
    101. 

  101. </ul>
    102. 

  102. </li>
    103. 

  103. </ul>
    104. 

  104. </div></blockquote>
    105. 

  105. <div class="admonition seealso">
    106. 

  106. <p class="first admonition-title">See also</p>
    107. 

  107. <p class="last"><a class="reference internal" href="cf.Field.equals.html#cf.Field.equals" title="cf.Field.equals"><code class="xref py py-obj docutils literal"><span class="pre">equals</span></code></a>, <code class="xref py py-obj docutils literal"><span class="pre">set_equals</span></code></p>
    108. 

  108. </div>
    109. 

  109. <table class="docutils field-list" frame="void" rules="none">
    110. 

  110. <col class="field-name" />
    111. 

  111. <col class="field-body" />
    112. 

  112. <tbody valign="top">
    113. 

  113. <tr class="field-odd field"><th class="field-name">Examples 1:</th><td class="field-body"></td>
    114. 

  114. </tr>
    115. 

  115. </tbody>
    116. 

  116. </table>
    117. 

  117. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">b</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">equivalent</span><span class="p">(</span><span class="n">g</span><span class="p">)</span>
    118. 

  118. </pre></div>
    119. 

  119. </div>
    120. 

  120. <table class="docutils field-list" frame="void" rules="none">
    121. 

  121. <col class="field-name" />
    122. 

  122. <col class="field-body" />
    123. 

  123. <tbody valign="top">
    124. 

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

  125. <dt>other <span class="classifier-delimiter">:</span> <span class="classifier">object</span></dt>
    126. 

  126. <dd><p class="first last">The object to compare for equivalence.</p>
    127. 

  127. </dd>
    128. 

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

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

  130. 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>
    131. 

  131. </dd>
    132. 

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

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

  134. 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>
    135. 

  135. </dd>
    136. 

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

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

  138. fields differ.</p>
    139. 

  139. </dd>
    140. 

  140. </dl>
    141. 

  141. </td>
    142. 

  142. </tr>
    143. 

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

  144. <dt>out <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
    145. 

  145. <dd><p class="first last">Whether or not the two fields are equivalent.</p>
    146. 

  146. </dd>
    147. 

  147. </dl>
    148. 

  148. </td>
    149. 

  149. </tr>
    150. 

  150. <tr class="field-odd field"><th class="field-name">Examples 2:</th><td class="field-body"></td>
    151. 

  151. </tr>
    152. 

  152. </tbody>
    153. 

  153. </table>
    154. 

  154. <div class="highlight-python"><div class="highlight"><pre><span class="go">&gt;&gt;&gt;</span>
    155. 

  155. </pre></div>
    156. 

  156. </div>
    157. 

  157. </dd></dl>
    158. 

    159. 

  159. </div>
    160. 

    161. 

    162. 

  162.           </div>
    163. 

  163.         </div>
    164. 

  164.       </div>
    165. 

  165.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    166. 

  166.         <div class="sphinxsidebarwrapper">
    167. 

  167.   <h4>Previous topic</h4>
    168. 

  168.   <p class="topless"><a href="cf.Field.equals.html"
    169. 

  169.                         title="previous chapter">cf.Field.equals</a></p>
    170. 

  170.   <h4>Next topic</h4>
    171. 

  171.   <p class="topless"><a href="cf.Field.equivalent_data.html"
    172. 

  172.                         title="next chapter">cf.Field.equivalent_data</a></p>
    173. 

  173.   <div role="note" aria-label="source link">
    174. 

  174.     <h3>This Page</h3>
    175. 

  175.     <ul class="this-page-menu">
    176. 

  176.       <li><a href="../_sources/generated/cf.Field.equivalent.txt"
    177. 

  177.             rel="nofollow">Show Source</a></li>
    178. 

  178.     </ul>
    179. 

  179.    </div>
    180. 

  180. <div id="searchbox" style="display: none" role="search">
    181. 

  181.   <h3>Quick search</h3>
    182. 

  182.     <form class="search" action="../search.html" method="get">
    183. 

  183.       <input type="text" name="q" />
    184. 

  184.       <input type="submit" value="Go" />
    185. 

  185.       <input type="hidden" name="check_keywords" value="yes" />
    186. 

  186.       <input type="hidden" name="area" value="default" />
    187. 

  187.     </form>
    188. 

  188.     <p class="searchtip" style="font-size: 90%">
    189. 

  189.     Enter search terms or a module, class or function name.
    190. 

  190.     </p>
    191. 

  191. </div>
    192. 

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

  193.         </div>
    194. 

  194.       </div>
    195. 

  195.       <div class="clearer"></div>
    196. 

  196.     </div>
    197. 

  197.     <div class="related" role="navigation" aria-label="related navigation">
    198. 

  198.       <h3>Navigation</h3>
    199. 

  199.       <ul>
    200. 

  200.         <li class="right" style="margin-right: 10px">
    201. 

  201.           <a href="../genindex.html" title="General Index"
    202. 

  202.              >index</a></li>
    203. 

  203.         <li class="right" >
    204. 

  204.           <a href="cf.Field.equivalent_data.html" title="cf.Field.equivalent_data"
    205. 

  205.              >next</a> |</li>
    206. 

  206.         <li class="right" >
    207. 

  207.           <a href="cf.Field.equals.html" title="cf.Field.equals"
    208. 

  208.              >previous</a> |</li>
    209. 

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

  210. <!--
    211. 

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

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

    214. 

  214.       <option value="../../1.0/index.html">1.0
    215. 

    216. 

  216.       <option value="../../0.9.9/index.html">0.9.9
    217. 

    218. 

  218.       <option value="../../0.9.8.3/index.html">0.9.8.3
    219. 

    220. 

  220.       <option value="../../archive.html">Archive
    221. 

    222. 

  222.       </select>
    223. 

  223.   </li>
    224. 

  224. -->
    225. 

  225.   
    226. 

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

    228. 

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

  229.           <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>
    230. 

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

  231.       </ul>
    232. 

  232.     </div>
    233. 

  233.     <div class="footer" role="contentinfo">
    234. 

  234.         &copy; Copyright 2015, David Hassell.
    235. 

  235.       Last updated on Feb 18, 2016.
    236. 

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

  237.     </div>
    238. 

  238.   </body>
    239. 

  239. </html>
    240.