trees.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>treetensor.common.trees &mdash; DI-treetensor 0.3.0 documentation</title>
  

  <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/underscore.js"></script>
        <script src="../../_static/doctools.js"></script>
        <script src="../../_static/language_data.js"></script>
        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../../_static/js/theme.js"></script>

    
  <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="treetensor.common.wrappers" href="wrappers.html" />
    <link rel="prev" title="treetensor.common.object" href="object.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

            <a href="../../index.html" class="icon icon-home"> DI-treetensor
          

          </a>

          
              <div class="version">
                0.3.0
              </div>
            
          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <p><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/installation/index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/quick_start/index.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/plugins/index.html">Plugins</a></li>
</ul>
<p><span class="caption-text">Best Practice</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../best_practice/stack/index.html">Stack Structured Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../best_practice/operation/index.html">Customized Operations For Different Fields</a></li>
</ul>
<p><span class="caption-text">API Documentation</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">treetensor.common</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="object.html">treetensor.common.object</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">treetensor.common.trees</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#print-tree">print_tree</a></li>
<li class="toctree-l3"><a class="reference internal" href="#basetreestruct">BaseTreeStruct</a></li>
<li class="toctree-l3"><a class="reference internal" href="#clsmeta">clsmeta</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="wrappers.html">treetensor.common.wrappers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../config/index.html">treetensor.config</a></li>
<li class="toctree-l1"><a class="reference internal" href="../numpy/index.html">treetensor.numpy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../torch/index.html">treetensor.torch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../utils/index.html">treetensor.utils</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../index.html">DI-treetensor</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          
<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="index.html">treetensor.common</a> &raquo;</li>
        
      <li>treetensor.common.trees</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../../_sources/api_doc/common/trees.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
    
  <section id="treetensor-common-trees">
<h1>treetensor.common.trees<a class="headerlink" href="#treetensor-common-trees" title="Permalink to this headline">¶</a></h1>
<section id="print-tree">
<h2>print_tree<a class="headerlink" href="#print-tree" title="Permalink to this headline">¶</a></h2>
</section>
<section id="basetreestruct">
<h2>BaseTreeStruct<a class="headerlink" href="#basetreestruct" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="treetensor.common.trees.BaseTreeStruct">
<em class="property">class </em><code class="sig-prename descclassname">treetensor.common.trees.</code><code class="sig-name descname">BaseTreeStruct</code><a class="reference internal" href="../../_modules/treetensor/common/trees.html#BaseTreeStruct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.common.trees.BaseTreeStruct" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Overview:</dt><dd><p>Base structure of all the trees in <code class="docutils literal notranslate"><span class="pre">treetensor</span></code>.</p>
</dd>
</dl>
<dl class="py method">
<dt id="treetensor.common.trees.BaseTreeStruct.__repr__">
<code class="sig-name descname">__repr__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#treetensor.common.trees.BaseTreeStruct.__repr__" title="Permalink to this definition">¶</a></dt>
<dd><p>Get representation format of tree value.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Represenation string.</p>
</dd>
</dl>
<dl>
<dt>Example:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">t</span> <span class="o">=</span> <span class="n">TreeValue</span><span class="p">({</span><span class="s1">&#39;a&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">&#39;x&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;c&#39;</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">:</span> <span class="mi">4</span><span class="p">}})</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">t</span>
<span class="go">&lt;TreeValue 0x7f672fc53320&gt;</span>
<span class="go">├── &#39;a&#39; --&gt; 1</span>
<span class="go">├── &#39;b&#39; --&gt; 2</span>
<span class="go">└── &#39;x&#39; --&gt; &lt;TreeValue 0x7f672fc53390&gt;</span>
<span class="go">    ├── &#39;c&#39; --&gt; 3</span>
<span class="go">    └── &#39;d&#39; --&gt; 4</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="treetensor.common.trees.BaseTreeStruct.__str__">
<code class="sig-name descname">__str__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#treetensor.common.trees.BaseTreeStruct.__str__" title="Permalink to this definition">¶</a></dt>
<dd><p>Return str(self).</p>
</dd></dl>

</dd></dl>

</section>
<section id="clsmeta">
<h2>clsmeta<a class="headerlink" href="#clsmeta" title="Permalink to this headline">¶</a></h2>
<dl class="py function">
<dt id="treetensor.common.trees.clsmeta">
<code class="sig-prename descclassname">treetensor.common.trees.</code><code class="sig-name descname">clsmeta</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">func</span></em>, <em class="sig-param"><span class="n">allow_dict</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em><span class="sig-paren">)</span> &#x2192; Type<span class="p">[</span>type<span class="p">]</span><a class="reference internal" href="../../_modules/treetensor/common/trees.html#clsmeta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#treetensor.common.trees.clsmeta" title="Permalink to this definition">¶</a></dt>
<dd><dl>
<dt>Overview:</dt><dd><p>Create a metaclass based on generating function.</p>
<p>Used in <a class="reference internal" href="object.html#treetensor.common.Object" title="treetensor.common.Object"><code class="xref py py-class docutils literal notranslate"><span class="pre">treetensor.common.Object</span></code></a>,
<a class="reference internal" href="../torch/trees.Tensor.where.auto.html#treetensor.torch.Tensor" title="treetensor.torch.Tensor"><code class="xref py py-class docutils literal notranslate"><span class="pre">treetensor.torch.Tensor</span></code></a> and <a class="reference internal" href="../torch/trees.Size.numel.auto.html#treetensor.torch.Size" title="treetensor.torch.Size"><code class="xref py py-class docutils literal notranslate"><span class="pre">treetensor.torch.Size</span></code></a>.
Can do modify onto the constructor function of the classes.</p>
</dd>
<dt>Arguments:</dt><dd><ul class="simple">
<li><p>func: Generating function.</p></li>
<li><p>allow_dict (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>): Auto transform dictionary to <code class="xref py py-class docutils literal notranslate"><span class="pre">treevalue.TreeValue</span></code> class,                                     default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
</ul>
</dd>
<dt>Returns:</dt><dd><ul class="simple">
<li><p>metaclass (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Type[type]</span></code>): Metaclass for creating a new class.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</section>
</section>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="wrappers.html" class="btn btn-neutral float-right" title="treetensor.common.wrappers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="object.html" class="btn btn-neutral float-left" title="treetensor.common.object" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2022, HansBug, DI-engine&#39;s Contributors

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  
    <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
  <span class="rst-current-version" data-toggle="rst-current-version">
    <span class="fa fa-book"> Other Versions</span>
    v: dev/stream
    <span class="fa fa-caret-down"></span>
  </span>
        <div class="rst-other-versions">
                <dl>
                    <dt>Tags</dt>
                        <dd><a href="../../../../v0.2.1/api_doc/common/trees.html">v0.2.1</a></dd>
                        <dd><a href="../../../../v0.3.0/api_doc/common/trees.html">v0.3.0</a></dd>
                </dl>
                <dl>
                    <dt>Branches</dt>
                        <dd><a href="../../../../test/os/api_doc/common/trees.html">test/os</a></dd>
                        <dd><a href="trees.html">dev/stream</a></dd>
                        <dd><a href="../../../../main/api_doc/common/trees.html">main</a></dd>
                        <dd><a href="../../../../run/xdemos/api_doc/common/trees.html">run/xdemos</a></dd>
                </dl>
        </div>
    </div>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>