Tree
====

.. currentmodule:: PlasmaCalcs.tools.trees

.. autoclass:: Tree
   :members:
   :show-inheritance:
   :inherited-members:

   
   
   .. rubric:: Methods

   .. autosummary::

   
   
     
       ~Tree.__getitem__
     
     
       ~Tree.__iter__
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     

   
   
     
     
     
     
     
     
     
     
     
       ~Tree.add_child
     
     
       ~Tree.display
     
     
       ~Tree.enumerate_flat
     
     
       ~Tree.flat
     
     
       ~Tree.flat_branches_until
     
     
       ~Tree.has_node_where
     
     
       ~Tree.html
     
     
       ~Tree.make_child
     
     
       ~Tree.make_children
     
     
       ~Tree.set_parent
     

   
   
     
     
     
       ~Tree._on_added_child
     
     
       ~Tree._on_added_descendant
     
     
       ~Tree._on_adding_ancestor
     
     
       ~Tree._on_setting_parent
     
     
       ~Tree._repr_html_
     
     
       ~Tree._shorthand_repr
     
     
     
     
     
     
     
     
     
     
     

   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~Tree.DEFAULT_TREE_SHORTHAND
      ~Tree.DEFAULT_TREE_SHOW_DEPTH
      ~Tree.DEFAULT_TREE_SHOW_MAX_DEPTH
      ~Tree.depth
      ~Tree.height
      ~Tree.parent
      ~Tree.parent_ref
      ~Tree.size