jax_dna.energy.utils
====================

.. py:module:: jax_dna.energy.utils

.. autoapi-nested-parse::

   Utility functions for energy calculations.



Functions
---------

.. autoapisummary::

   jax_dna.energy.utils.q_to_back_base
   jax_dna.energy.utils.q_to_base_normal
   jax_dna.energy.utils.q_to_cross_prod
   jax_dna.energy.utils.get_pair_probs
   jax_dna.energy.utils.compute_seq_dep_weight


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

.. py:function:: q_to_back_base(q: jax_md.rigid_body.Quaternion) -> jax.numpy.ndarray

   Get the vector from the center to the base of the nucleotide.


.. py:function:: q_to_base_normal(q: jax_md.rigid_body.Quaternion) -> jax.numpy.ndarray

   Get the normal vector to the base of the nucleotide.


.. py:function:: q_to_cross_prod(q: jax_md.rigid_body.Quaternion) -> jax.numpy.ndarray

   Get the cross product vector of the nucleotide.


.. py:function:: get_pair_probs(seq: jax_dna.utils.types.Arr_Nucleotide_4, i: int, j: int) -> jax.numpy.ndarray

   Get the pair probabilities for a sequence.


.. py:function:: compute_seq_dep_weight(pseq: jax_dna.utils.types.Probabilistic_Sequence, nt1: int, nt2: int, weights_table: numpy.ndarray, is_unpaired: jax_dna.utils.types.Arr_Nucleotide_Int, idx_to_unpaired_idx: jax_dna.utils.types.Arr_Nucleotide_Int, idx_to_bp_idx: jax_dna.utils.types.Arr_Nucleotide_2_Int) -> float

   Computes the sequence-dependent weight for an interaction given a probabilistic sequence.