binaries/src/ViennaRNA/doc/latex/group__energy__parameters.tex

   1 \hypertarget{group__energy__parameters}{\section{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}
   2 \label{group__energy__parameters}\index{Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}}
   3 }
   4
   5
   6 All relevant functions to retrieve and copy precalculated energy parameter sets as well as reading/writing the energy parameter set from/to file(s).
   7
   8
   9 Collaboration diagram for Change and Precalculate Energy Parameter Sets and Boltzmann Factors\-:
  10 \nopagebreak
  11 \begin{figure}[H]
  12 \begin{center}
  13 \leavevmode
  14 \includegraphics[width=350pt]{group__energy__parameters}
  15 \end{center}
  16 \end{figure}
  17 \subsection*{Modules}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 \hyperlink{group__energy__parameters__rw}{Reading/\-Writing energy parameter sets from/to File}
  21 \begin{DoxyCompactList}\small\item\em Read and Write energy parameter sets from and to text files. \end{DoxyCompactList}\end{DoxyCompactItemize}
  22 \subsection*{Files}
  23 \begin{DoxyCompactItemize}
  24 \item
  25 file \hyperlink{params_8h}{params.\-h}
  26 \end{DoxyCompactItemize}
  27 \subsection*{Functions}
  28 \begin{DoxyCompactItemize}
  29 \item
  30 \hyperlink{structparamT}{param\-T} $\ast$ \hyperlink{group__energy__parameters_ga527ef619cd8210b84d5d53be1e0e29b6}{scale\-\_\-parameters} (void)
  31 \begin{DoxyCompactList}\small\item\em Get precomputed energy contributions for all the known loop types. \end{DoxyCompactList}\item
  32 \hyperlink{structparamT}{param\-T} $\ast$ \hyperlink{group__energy__parameters_gac2f3ca440b7eaf4d999fb27da949fe72}{get\-\_\-scaled\-\_\-parameters} (double \hyperlink{fold__vars_8h_ab4b11c8d9c758430960896bc3fe82ead}{temperature}, \hyperlink{structmodel__detailsT}{model\-\_\-details\-T} md)
  33 \begin{DoxyCompactList}\small\item\em Get precomputed energy contributions for all the known loop types. \end{DoxyCompactList}\item
  34 \hyperlink{structpf__paramT}{pf\-\_\-param\-T} $\ast$ \hyperlink{group__energy__parameters_gab85f6b6da051f380371deb0d8921bdba}{get\-\_\-scaled\-\_\-pf\-\_\-parameters} (void)
  35 \item
  36 \hyperlink{structpf__paramT}{pf\-\_\-param\-T} $\ast$ \hyperlink{group__energy__parameters_ga6fc2f3eef5a3024d44963ac59a42e39d}{get\-\_\-boltzmann\-\_\-factors} (double \hyperlink{fold__vars_8h_ab4b11c8d9c758430960896bc3fe82ead}{temperature}, double beta\-Scale, \hyperlink{structmodel__detailsT}{model\-\_\-details\-T} md, double \hyperlink{fold__vars_8h_ad3b22044065acc6dee0af68931b52cfd}{pf\-\_\-scale})
  37 \begin{DoxyCompactList}\small\item\em Get precomputed Boltzmann factors of the loop type dependent energy contributions with independent thermodynamic temperature. \end{DoxyCompactList}\item
  38 \hyperlink{structpf__paramT}{pf\-\_\-param\-T} $\ast$ \hyperlink{group__energy__parameters_gacba212326a051734797e65987260fdd0}{get\-\_\-boltzmann\-\_\-factor\-\_\-copy} (\hyperlink{structpf__paramT}{pf\-\_\-param\-T} $\ast$parameters)
  39 \begin{DoxyCompactList}\small\item\em Get a copy of already precomputed Boltzmann factors. \end{DoxyCompactList}\item
  40 \hypertarget{group__energy__parameters_gaa6a4297a2b91d6f7ae47dd61ca1862a0}{\hyperlink{structpf__paramT}{pf\-\_\-param\-T} $\ast$ \hyperlink{group__energy__parameters_gaa6a4297a2b91d6f7ae47dd61ca1862a0}{get\-\_\-scaled\-\_\-alipf\-\_\-parameters} (unsigned int n\-\_\-seq)}\label{group__energy__parameters_gaa6a4297a2b91d6f7ae47dd61ca1862a0}
  41
  42 \begin{DoxyCompactList}\small\item\em Get precomputed Boltzmann factors of the loop type dependent energy contributions (alifold variant) \end{DoxyCompactList}\item
  43 \hypertarget{group__energy__parameters_gaaa049a8c9f1c2ed4398cb1b5a3d65a66}{P\-U\-B\-L\-I\-C \hyperlink{structpf__paramT}{pf\-\_\-param\-T} $\ast$ \hyperlink{group__energy__parameters_gaaa049a8c9f1c2ed4398cb1b5a3d65a66}{get\-\_\-boltzmann\-\_\-factors\-\_\-ali} (unsigned int n\-\_\-seq, double \hyperlink{fold__vars_8h_ab4b11c8d9c758430960896bc3fe82ead}{temperature}, double beta\-Scale, \hyperlink{structmodel__detailsT}{model\-\_\-details\-T} md, double \hyperlink{fold__vars_8h_ad3b22044065acc6dee0af68931b52cfd}{pf\-\_\-scale})}\label{group__energy__parameters_gaaa049a8c9f1c2ed4398cb1b5a3d65a66}
  44
  45 \begin{DoxyCompactList}\small\item\em Get precomputed Boltzmann factors of the loop type dependent energy contributions (alifold variant) with independent thermodynamic temperature. \end{DoxyCompactList}\end{DoxyCompactItemize}
  46
  47
  48 \subsection{Detailed Description}
  49 All relevant functions to retrieve and copy precalculated energy parameter sets as well as reading/writing the energy parameter set from/to file(s). This module covers all relevant functions for precalculation of the energy parameters necessary for the folding routines provided by R\-N\-Alib. Furthermore, the energy parameter set in the R\-N\-Alib can be easily exchanged by a user-\/defined one. It is also possible to write the current energy parameter set into a text file.
  50
  51 \subsection{Function Documentation}
  52 \hypertarget{group__energy__parameters_ga527ef619cd8210b84d5d53be1e0e29b6}{\index{Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}!scale\-\_\-parameters@{scale\-\_\-parameters}}
  53 \index{scale\-\_\-parameters@{scale\-\_\-parameters}!Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}}
  54 \subsubsection[{scale\-\_\-parameters}]{\setlength{\rightskip}{0pt plus 5cm}{\bf param\-T}$\ast$ scale\-\_\-parameters (
  55 \begin{DoxyParamCaption}
  56 \item[{void}]{}
  57 \end{DoxyParamCaption}
  58 )}}\label{group__energy__parameters_ga527ef619cd8210b84d5d53be1e0e29b6}
  59
  60
  61 Get precomputed energy contributions for all the known loop types.
  62
  63 \begin{DoxyNote}{Note}
  64 Open\-M\-P\-: This function relies on several global model settings variables and thus is not to be considered threadsafe. See \hyperlink{group__energy__parameters_gac2f3ca440b7eaf4d999fb27da949fe72}{get\-\_\-scaled\-\_\-parameters()} for a completely threadsafe implementation.
  65 \end{DoxyNote}
  66 \begin{DoxyReturn}{Returns}
  67 A set of precomputed energy contributions
  68 \end{DoxyReturn}
  69 \hypertarget{group__energy__parameters_gac2f3ca440b7eaf4d999fb27da949fe72}{\index{Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}!get\-\_\-scaled\-\_\-parameters@{get\-\_\-scaled\-\_\-parameters}}
  70 \index{get\-\_\-scaled\-\_\-parameters@{get\-\_\-scaled\-\_\-parameters}!Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}}
  71 \subsubsection[{get\-\_\-scaled\-\_\-parameters}]{\setlength{\rightskip}{0pt plus 5cm}{\bf param\-T}$\ast$ get\-\_\-scaled\-\_\-parameters (
  72 \begin{DoxyParamCaption}
  73 \item[{double}]{temperature, }
  74 \item[{{\bf model\-\_\-details\-T}}]{md}
  75 \end{DoxyParamCaption}
  76 )}}\label{group__energy__parameters_gac2f3ca440b7eaf4d999fb27da949fe72}
  77
  78
  79 Get precomputed energy contributions for all the known loop types.
  80
  81 Call this function to retrieve precomputed energy contributions, i.\-e. scaled according to the temperature passed. Furthermore, this function assumes a data structure that contains the model details as well, such that subsequent folding recursions are able to retrieve the correct model settings
  82
  83 \begin{DoxySeeAlso}{See Also}
  84 \hyperlink{structmodel__detailsT}{model\-\_\-details\-T}, \hyperlink{fold__vars_8h_a4c3257186a796182462f18a5480ac8b3}{set\-\_\-model\-\_\-details()}
  85 \end{DoxySeeAlso}
  86
  87 \begin{DoxyParams}{Parameters}
  88 {\em temperature} & The temperature in degrees Celcius \\
  89 \hline
  90 {\em md} & The model details \\
  91 \hline
  92 \end{DoxyParams}
  93 \begin{DoxyReturn}{Returns}
  94 precomputed energy contributions and model settings
  95 \end{DoxyReturn}
  96 \hypertarget{group__energy__parameters_gab85f6b6da051f380371deb0d8921bdba}{\index{Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}!get\-\_\-scaled\-\_\-pf\-\_\-parameters@{get\-\_\-scaled\-\_\-pf\-\_\-parameters}}
  97 \index{get\-\_\-scaled\-\_\-pf\-\_\-parameters@{get\-\_\-scaled\-\_\-pf\-\_\-parameters}!Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}}
  98 \subsubsection[{get\-\_\-scaled\-\_\-pf\-\_\-parameters}]{\setlength{\rightskip}{0pt plus 5cm}{\bf pf\-\_\-param\-T}$\ast$ get\-\_\-scaled\-\_\-pf\-\_\-parameters (
  99 \begin{DoxyParamCaption}
 100 \item[{void}]{}
 101 \end{DoxyParamCaption}
 102 )}}\label{group__energy__parameters_gab85f6b6da051f380371deb0d8921bdba}
 103 get a datastructure of type \hyperlink{structpf__paramT}{pf\-\_\-param\-T} which contains the Boltzmann weights of several energy parameters scaled according to the current temperature \begin{DoxyReturn}{Returns}
 104 The datastructure containing Boltzmann weights for use in partition function calculations
 105 \end{DoxyReturn}
 106 \hypertarget{group__energy__parameters_ga6fc2f3eef5a3024d44963ac59a42e39d}{\index{Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}!get\-\_\-boltzmann\-\_\-factors@{get\-\_\-boltzmann\-\_\-factors}}
 107 \index{get\-\_\-boltzmann\-\_\-factors@{get\-\_\-boltzmann\-\_\-factors}!Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}}
 108 \subsubsection[{get\-\_\-boltzmann\-\_\-factors}]{\setlength{\rightskip}{0pt plus 5cm}{\bf pf\-\_\-param\-T}$\ast$ get\-\_\-boltzmann\-\_\-factors (
 109 \begin{DoxyParamCaption}
 110 \item[{double}]{temperature, }
 111 \item[{double}]{beta\-Scale, }
 112 \item[{{\bf model\-\_\-details\-T}}]{md, }
 113 \item[{double}]{pf\-\_\-scale}
 114 \end{DoxyParamCaption}
 115 )}}\label{group__energy__parameters_ga6fc2f3eef5a3024d44963ac59a42e39d}
 116
 117
 118 Get precomputed Boltzmann factors of the loop type dependent energy contributions with independent thermodynamic temperature.
 119
 120 This function returns a data structure that contains all necessary precalculated Boltzmann factors for each loop type contribution.\par
 121  In contrast to \hyperlink{group__energy__parameters_gab85f6b6da051f380371deb0d8921bdba}{get\-\_\-scaled\-\_\-pf\-\_\-parameters()}, this function enables setting of independent temperatures for both, the individual energy contributions as well as the thermodynamic temperature used in $ exp(-\Delta G / kT) $
 122
 123 \begin{DoxySeeAlso}{See Also}
 124 \hyperlink{group__energy__parameters_gab85f6b6da051f380371deb0d8921bdba}{get\-\_\-scaled\-\_\-pf\-\_\-parameters()}, \hyperlink{group__energy__parameters_gacba212326a051734797e65987260fdd0}{get\-\_\-boltzmann\-\_\-factor\-\_\-copy()}
 125 \end{DoxySeeAlso}
 126
 127 \begin{DoxyParams}{Parameters}
 128 {\em temperature} & The temperature in degrees Celcius used for (re-\/)scaling the energy contributions \\
 129 \hline
 130 {\em beta\-Scale} & A scaling value that is used as a multiplication factor for the absolute temperature of the system \\
 131 \hline
 132 {\em md} & The model details to be used \\
 133 \hline
 134 {\em pf\-\_\-scale} & The scaling factor for the Boltzmann factors \\
 135 \hline
 136 \end{DoxyParams}
 137 \begin{DoxyReturn}{Returns}
 138 A set of precomputed Boltzmann factors
 139 \end{DoxyReturn}
 140 \hypertarget{group__energy__parameters_gacba212326a051734797e65987260fdd0}{\index{Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}!get\-\_\-boltzmann\-\_\-factor\-\_\-copy@{get\-\_\-boltzmann\-\_\-factor\-\_\-copy}}
 141 \index{get\-\_\-boltzmann\-\_\-factor\-\_\-copy@{get\-\_\-boltzmann\-\_\-factor\-\_\-copy}!Change and Precalculate Energy Parameter Sets and Boltzmann Factors@{Change and Precalculate Energy Parameter Sets and Boltzmann Factors}}
 142 \subsubsection[{get\-\_\-boltzmann\-\_\-factor\-\_\-copy}]{\setlength{\rightskip}{0pt plus 5cm}{\bf pf\-\_\-param\-T}$\ast$ get\-\_\-boltzmann\-\_\-factor\-\_\-copy (
 143 \begin{DoxyParamCaption}
 144 \item[{{\bf pf\-\_\-param\-T} $\ast$}]{parameters}
 145 \end{DoxyParamCaption}
 146 )}}\label{group__energy__parameters_gacba212326a051734797e65987260fdd0}
 147
 148
 149 Get a copy of already precomputed Boltzmann factors.
 150
 151 \begin{DoxySeeAlso}{See Also}
 152 \hyperlink{group__energy__parameters_ga6fc2f3eef5a3024d44963ac59a42e39d}{get\-\_\-boltzmann\-\_\-factors()}, \hyperlink{group__energy__parameters_gab85f6b6da051f380371deb0d8921bdba}{get\-\_\-scaled\-\_\-pf\-\_\-parameters()}
 153 \end{DoxySeeAlso}
 154
 155 \begin{DoxyParams}{Parameters}
 156 {\em parameters} & The input data structure that shall be copied \\
 157 \hline
 158 \end{DoxyParams}
 159 \begin{DoxyReturn}{Returns}
 160 A copy of the provided Boltzmann factor dataset
 161 \end{DoxyReturn}