LocalHamGen_config_coupling
===========================

.. py:module:: LocalHamGen_config_coupling

.. autoapi-nested-parse::

   Config coupling method directly for a LocalHamGen object.



Functions
---------

.. autoapisummary::

   LocalHamGen_config_coupling.config_coupling


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

.. py:function:: config_coupling(self, config, atol=1e-12)

   Take the configuration ``config`` and return the list of other
   configurations this Hamiltonian couples it to and the corresponding
   coefficients.

   :param config: A mapping of each site to a integer value, ``[0, 1]``.
   :type config: dict[hashable, int]
   :param atol: Absolute tolerance for the skipping couplings.
   :type atol: float, optional

   :returns: * **coupled_configs** (*list[dict[hashable, int]]*) -- List of configurations ``config`` is coupled to.
             * **coupling_coeffs** (*list[float]*) -- List of coupling coefficients.