legendre_decomp.utils
=====================

.. py:module:: legendre_decomp.utils

.. autoapi-nested-parse::

   Utility functions



Functions
---------

.. autoapisummary::

   legendre_decomp.utils.default_B
   legendre_decomp.utils.ring_decomposition_B
   legendre_decomp.utils.index_channel_B


Module Contents
---------------

.. py:function:: default_B(shape, order, xp = np)

   Vectorized implementation of the default B tensor.

   :param shape: Shape of the corresponding X tensor.
   :param order: Order of the B tensor.
   :param xp: Array module, either numpy (CPU) or cupy (CUDA/GPU)
   :type xp: ModuleType

   :returns: Default B tensor of specified order.
   :rtype: array-like


.. py:function:: ring_decomposition_B(shape)

   Construct B tensor for ring decomposition.

   :param shape: Shape of the corresponding X tensor.

   :returns: B tensor for ring decomposition.


.. py:function:: index_channel_B(shape)

   ２次の近似から、index - channel 結合を切断する.

   :param shape: Shape of the corresponding X tensor.

   :returns: B tensor with broken index-channel bond for larger than 2D.