jax_dna.energy.dna1.expected_hydrogen_bonding
=============================================

.. py:module:: jax_dna.energy.dna1.expected_hydrogen_bonding

.. autoapi-nested-parse::

   Expected hydrogen bonding energy function for DNA1 model.



Classes
-------

.. autoapisummary::

   jax_dna.energy.dna1.expected_hydrogen_bonding.ExpectedHydrogenBondingConfiguration
   jax_dna.energy.dna1.expected_hydrogen_bonding.ExpectedHydrogenBonding


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

.. py:class:: ExpectedHydrogenBondingConfiguration

   Bases: :py:obj:`jax_dna.energy.dna1.hydrogen_bonding.HydrogenBondingConfiguration`


   Configuration for the expected hydrogen bonding energy function.


   .. py:attribute:: sequence_constraints
      :type:  jax_dna.input.sequence_constraints.SequenceConstraints | None
      :value: None



   .. py:attribute:: required_params
      :type:  tuple[str]
      :value: ('eps_hb', 'a_hb', 'dr0_hb', 'dr_c_hb', 'dr_low_hb', 'dr_high_hb', 'a_hb_1', 'theta0_hb_1',...



.. py:class:: ExpectedHydrogenBonding

   Bases: :py:obj:`jax_dna.energy.dna1.hydrogen_bonding.HydrogenBonding`


   Expected hydrogen bonding energy function for DNA1 model.


   .. py:attribute:: params
      :type:  ExpectedHydrogenBondingConfiguration


   .. py:method:: weight(i: int, j: int, seq: jax_dna.utils.types.Probabilistic_Sequence) -> float

      Computes the sequence-dependent weight for an unbonded pair.



   .. py:method:: __call__(body: jax_dna.energy.base.BaseNucleotide, seq: jax_dna.utils.types.Probabilistic_Sequence, bonded_neighbors: jax_dna.utils.types.Arr_Bonded_Neighbors_2, unbonded_neighbors: jax_dna.utils.types.Arr_Unbonded_Neighbors_2) -> jax_dna.utils.types.Scalar

      Calculate the energy of the system.