stacking
========


.. py:module:: t3toolbox.backend.stacking

.. autoapi-nested-parse::

   Convert a Python tree of separate objects <-> one stacked object.

   ``stack``/``unstack``, ``tree_zip``, ``apply_func_to_leaf_subtrees``, and the basic
   ragged/uniform twins. This is one of three distinct meanings of "stacking" in the library --
   distinct from leading ``stack_shape`` batch axes on one object's cores, and from the uniform
   supercore representation (``docs/batching_and_stacking.md``).



Functions
---------

.. toctree::
   :hidden:

   /autoapi/t3toolbox/backend/stacking/tree_depth
   /autoapi/t3toolbox/backend/stacking/get_first_leaf
   /autoapi/t3toolbox/backend/stacking/trees_have_same_structure
   /autoapi/t3toolbox/backend/stacking/apply_func_to_leaf_subtrees
   /autoapi/t3toolbox/backend/stacking/stack
   /autoapi/t3toolbox/backend/stacking/unstack
   /autoapi/t3toolbox/backend/stacking/sum_leafs_along_axes
   /autoapi/t3toolbox/backend/stacking/basic_ragged_unstack
   /autoapi/t3toolbox/backend/stacking/basic_ragged_stack
   /autoapi/t3toolbox/backend/stacking/basic_uniform_unstack
   /autoapi/t3toolbox/backend/stacking/basic_uniform_stack
   /autoapi/t3toolbox/backend/stacking/tree_zip

.. autoapisummary::

   t3toolbox.backend.stacking.tree_depth
   t3toolbox.backend.stacking.get_first_leaf
   t3toolbox.backend.stacking.trees_have_same_structure
   t3toolbox.backend.stacking.apply_func_to_leaf_subtrees
   t3toolbox.backend.stacking.stack
   t3toolbox.backend.stacking.unstack
   t3toolbox.backend.stacking.sum_leafs_along_axes
   t3toolbox.backend.stacking.basic_ragged_unstack
   t3toolbox.backend.stacking.basic_ragged_stack
   t3toolbox.backend.stacking.basic_uniform_unstack
   t3toolbox.backend.stacking.basic_uniform_stack
   t3toolbox.backend.stacking.tree_zip