binaries/src/ViennaRNA/doc/html/part__func__co_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>RNAlib-2.1.2: /home/mescalin/ronny/public_html/programs/ViennaRNA/H/part_func_co.h File Reference</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javascript" src="jquery.js"></script>
   9 <script type="text/javascript" src="dynsections.js"></script>
  10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="resize.js"></script>
  12 <script type="text/javascript" src="navtree.js"></script>
  13 <script type="text/javascript">
  14   $(document).ready(initResizable);
  15 </script>
  16 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17 </head>
  18 <body>
  19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20 <div id="titlearea">
  21 <table cellspacing="0" cellpadding="0">
  22  <tbody>
  23  <tr style="height: 56px;">
  24   <td style="padding-left: 0.5em;">
  25    <div id="projectname">RNAlib-2.1.2
  26    </div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.1.1 -->
  34   <div id="navrow1" class="tabs">
  35     <ul class="tablist">
  36       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  37       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  38       <li><a href="modules.html"><span>Modules</span></a></li>
  39       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  40       <li class="current"><a href="files.html"><span>Files</span></a></li>
  41     </ul>
  42   </div>
  43   <div id="navrow2" class="tabs2">
  44     <ul class="tablist">
  45       <li><a href="files.html"><span>File&#160;List</span></a></li>
  46       <li><a href="globals.html"><span>Globals</span></a></li>
  47     </ul>
  48   </div>
  49 </div><!-- top -->
  50 <div id="side-nav" class="ui-resizable side-nav-resizable">
  51   <div id="nav-tree">
  52     <div id="nav-tree-contents">
  53     </div>
  54   </div>
  55   <div id="splitbar" style="-moz-user-select:none;"
  56        class="ui-resizable-handle">
  57   </div>
  58 </div>
  59 <script type="text/javascript">
  60 $(document).ready(function(){initNavTree('part__func__co_8h.html','');});
  61 </script>
  62 <div id="doc-content">
  63 <div class="header">
  64   <div class="summary">
  65 <a href="#func-members">Functions</a> &#124;
  66 <a href="#var-members">Variables</a>  </div>
  67   <div class="headertitle">
  68 <div class="title">part_func_co.h File Reference<div class="ingroups"><a class="el" href="group__pf__cofold.html">Partition Function for two hybridized Sequences</a></div></div>  </div>
  69 </div><!--header-->
  70 <div class="contents">
  71
  72 <p>Partition function for two RNA sequences.
  73 <a href="#details">More...</a></p>
  74 <div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  75   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for part_func_co.h:</div>
  76 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  77 </div>
  78 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  79 <div class="center"><img src="part__func__co_8h__incl.png" border="0" usemap="#_2home_2mescalin_2ronny_2public__html_2programs_2ViennaRNA_2H_2part__func__co_8h" alt=""/></div>
  80 <map name="_2home_2mescalin_2ronny_2public__html_2programs_2ViennaRNA_2H_2part__func__co_8h" id="_2home_2mescalin_2ronny_2public__html_2programs_2ViennaRNA_2H_2part__func__co_8h">
  81 <area shape="rect" id="node3" href="data__structures_8h.html" title="All datastructures and typedefs shared among the Vienna RNA Package can be found here." alt="" coords="42,109,176,136"/><area shape="rect" id="node5" href="energy__const_8h.html" title="energy_const.h" alt="" coords="49,184,169,211"/></map>
  82 </div>
  83 </div>
  84 <p><a href="part__func__co_8h_source.html">Go to the source code of this file.</a></p>
  85 <table class="memberdecls">
  86 <tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
  87 Functions</h2></td></tr>
  88 <tr class="memitem:gaa86a5f998789ed71813d23d7307a791b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcofoldF.html">cofoldF</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#gaa86a5f998789ed71813d23d7307a791b">co_pf_fold</a> (char *sequence, char *structure)</td></tr>
  89 <tr class="memdesc:gaa86a5f998789ed71813d23d7307a791b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate partition function and base pair probabilities.  <a href="group__pf__cofold.html#gaa86a5f998789ed71813d23d7307a791b"></a><br/></td></tr>
  90 <tr class="memitem:gabd873b450832ab5f21101fc5ab354d21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcofoldF.html">cofoldF</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#gabd873b450832ab5f21101fc5ab354d21">co_pf_fold_par</a> (char *sequence, char *structure, <a class="el" href="structpf__paramT.html">pf_paramT</a> *parameters, int calculate_bppm, int is_constrained)</td></tr>
  91 <tr class="memdesc:gabd873b450832ab5f21101fc5ab354d21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate partition function and base pair probabilities.  <a href="group__pf__cofold.html#gabd873b450832ab5f21101fc5ab354d21"></a><br/></td></tr>
  92 <tr class="memitem:ga11f0252c1d2c4697253ff4b5bd392d3c"><td class="memItemLeft" align="right" valign="top">double *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#ga11f0252c1d2c4697253ff4b5bd392d3c">export_co_bppm</a> (void)</td></tr>
  93 <tr class="memdesc:ga11f0252c1d2c4697253ff4b5bd392d3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the base pair probability array.  <a href="group__pf__cofold.html#ga11f0252c1d2c4697253ff4b5bd392d3c"></a><br/></td></tr>
  94 <tr class="memitem:gade3ce34ae8214811374b1d28a40dc247"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gade3ce34ae8214811374b1d28a40dc247"></a>
  95 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#gade3ce34ae8214811374b1d28a40dc247">free_co_pf_arrays</a> (void)</td></tr>
  96 <tr class="memdesc:gade3ce34ae8214811374b1d28a40dc247"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the memory occupied by <a class="el" href="group__pf__cofold.html#gaa86a5f998789ed71813d23d7307a791b" title="Calculate partition function and base pair probabilities.">co_pf_fold()</a> <br/></td></tr>
  97 <tr class="memitem:ga6e0f36c1f9b7d9dd4bfbad914c1119e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#ga6e0f36c1f9b7d9dd4bfbad914c1119e5">update_co_pf_params</a> (int length)</td></tr>
  98 <tr class="memdesc:ga6e0f36c1f9b7d9dd4bfbad914c1119e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recalculate energy parameters.  <a href="group__pf__cofold.html#ga6e0f36c1f9b7d9dd4bfbad914c1119e5"></a><br/></td></tr>
  99 <tr class="memitem:ga117d880df45bef444d5e2785ffa40a53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#ga117d880df45bef444d5e2785ffa40a53">update_co_pf_params_par</a> (int length, <a class="el" href="structpf__paramT.html">pf_paramT</a> *parameters)</td></tr>
 100 <tr class="memdesc:ga117d880df45bef444d5e2785ffa40a53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recalculate energy parameters.  <a href="group__pf__cofold.html#ga117d880df45bef444d5e2785ffa40a53"></a><br/></td></tr>
 101 <tr class="memitem:ga15ae04ac5ab84e876dcf0093120cb617"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#ga15ae04ac5ab84e876dcf0093120cb617">compute_probabilities</a> (double FAB, double FEA, double FEB, struct <a class="el" href="structplist.html">plist</a> *prAB, struct <a class="el" href="structplist.html">plist</a> *prA, struct <a class="el" href="structplist.html">plist</a> *prB, int Alength)</td></tr>
 102 <tr class="memdesc:ga15ae04ac5ab84e876dcf0093120cb617"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute Boltzmann probabilities of dimerization without homodimers.  <a href="group__pf__cofold.html#ga15ae04ac5ab84e876dcf0093120cb617"></a><br/></td></tr>
 103 <tr class="memitem:ga5545cb936ac4ff93c7d699d46e72e8c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structConcEnt.html">ConcEnt</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#ga5545cb936ac4ff93c7d699d46e72e8c7">get_concentrations</a> (double FEAB, double FEAA, double FEBB, double FEA, double FEB, double *startconc)</td></tr>
 104 <tr class="memdesc:ga5545cb936ac4ff93c7d699d46e72e8c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given two start monomer concentrations a and b, compute the concentrations in thermodynamic equilibrium of all dimers and the monomers.  <a href="group__pf__cofold.html#ga5545cb936ac4ff93c7d699d46e72e8c7"></a><br/></td></tr>
 105 <tr class="memitem:a334de3c96e2186abfbdc0eaea6d08b14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structplist.html">plist</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="part__func__co_8h.html#a334de3c96e2186abfbdc0eaea6d08b14">get_plist</a> (struct <a class="el" href="structplist.html">plist</a> *pl, int length, double cut_off)</td></tr>
 106 <tr class="memitem:aa12dda9dd6179cdd22bcce87c0682c07"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="part__func__co_8h.html#aa12dda9dd6179cdd22bcce87c0682c07">init_co_pf_fold</a> (int length)</td></tr>
 107 </table><table class="memberdecls">
 108 <tr class="heading"><td colspan="2"><h2><a name="var-members"></a>
 109 Variables</h2></td></tr>
 110 <tr class="memitem:gaff27888c4088cc1f60fd59cbd589474c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaff27888c4088cc1f60fd59cbd589474c"></a>
 111 int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#gaff27888c4088cc1f60fd59cbd589474c">mirnatog</a></td></tr>
 112 <tr class="memdesc:gaff27888c4088cc1f60fd59cbd589474c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Toggles no intrabp in 2nd mol. <br/></td></tr>
 113 <tr class="memitem:gac2d1851a710a8561390861155ca988fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac2d1851a710a8561390861155ca988fe"></a>
 114 double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pf__cofold.html#gac2d1851a710a8561390861155ca988fe">F_monomer</a> [2]</td></tr>
 115 <tr class="memdesc:gac2d1851a710a8561390861155ca988fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free energies of the two monomers. <br/></td></tr>
 116 </table>
 117 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 118 <div class="textblock"><p>Partition function for two RNA sequences. </p>
 119 <p>As for folding one RNA molecule, this computes the partition function of all possible structures and the base pair probabilities. Uses the same global <a class="el" href="fold__vars_8h.html#ad3b22044065acc6dee0af68931b52cfd" title="A scaling factor used by pf_fold() to avoid overflows.">pf_scale</a> variable to avoid overflows.</p>
 120 <p>To simplify the implementation the partition function computation is done internally in a null model that does not include the duplex initiation energy, i.e. the entropic penalty for producing a dimer from two monomers). The resulting free energies and pair probabilities are initially relative to that null model. In a second step the free energies can be corrected to include the dimerization penalty, and the pair probabilities can be divided into the conditional pair probabilities given that a re dimer is formed or not formed.</p>
 121 <p>After computing the partition functions of all possible dimeres one can compute the probabilities of base pairs, the concentrations out of start concentrations and sofar and soaway.</p>
 122 <p>Dimer formation is inherently concentration dependent. Given the free energies of the monomers A and B and dimers AB, AA, and BB one can compute the equilibrium concentrations, given input concentrations of A and B, see e.g. Dimitrov &amp; Zuker (2004) </p>
 123 </div><hr/><h2>Function Documentation</h2>
 124 <a class="anchor" id="a334de3c96e2186abfbdc0eaea6d08b14"></a>
 125 <div class="memitem">
 126 <div class="memproto">
 127       <table class="memname">
 128         <tr>
 129           <td class="memname"><a class="el" href="structplist.html">plist</a>* get_plist </td>
 130           <td>(</td>
 131           <td class="paramtype">struct <a class="el" href="structplist.html">plist</a> *&#160;</td>
 132           <td class="paramname"><em>pl</em>, </td>
 133         </tr>
 134         <tr>
 135           <td class="paramkey"></td>
 136           <td></td>
 137           <td class="paramtype">int&#160;</td>
 138           <td class="paramname"><em>length</em>, </td>
 139         </tr>
 140         <tr>
 141           <td class="paramkey"></td>
 142           <td></td>
 143           <td class="paramtype">double&#160;</td>
 144           <td class="paramname"><em>cut_off</em>&#160;</td>
 145         </tr>
 146         <tr>
 147           <td></td>
 148           <td>)</td>
 149           <td></td><td></td>
 150         </tr>
 151       </table>
 152 </div><div class="memdoc">
 153 <p>DO NOT USE THIS FUNCTION ANYMORE </p>
 154 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>{ This function is deprecated and will be removed soon!} use <a class="el" href="group__pf__fold.html#ga03e15e831a31b1154855ab47edbdb019">assign_plist_from_pr()</a> instead! </dd></dl>
 155
 156 </div>
 157 </div>
 158 <a class="anchor" id="aa12dda9dd6179cdd22bcce87c0682c07"></a>
 159 <div class="memitem">
 160 <div class="memproto">
 161       <table class="memname">
 162         <tr>
 163           <td class="memname">void init_co_pf_fold </td>
 164           <td>(</td>
 165           <td class="paramtype">int&#160;</td>
 166           <td class="paramname"><em>length</em></td><td>)</td>
 167           <td></td>
 168         </tr>
 169       </table>
 170 </div><div class="memdoc">
 171 <p>DO NOT USE THIS FUNCTION ANYMORE </p>
 172 <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>{ This function is deprecated and will be removed soon!} </dd></dl>
 173
 174 </div>
 175 </div>
 176 </div><!-- contents -->
 177 </div><!-- doc-content -->
 178 <!-- start footer part -->
 179 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 180   <ul>
 181     <li class="navelem"><a class="el" href="dir_d72344b28b4f2089ce25682c4e6eba22.html">H</a></li><li class="navelem"><a class="el" href="part__func__co_8h.html">part_func_co.h</a></li>
 182     <li class="footer">Generated on Wed Jul 24 2013 13:38:58 for RNAlib-2.1.2 by
 183     <a href="http://www.doxygen.org/index.html">
 184     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
 185   </ul>
 186 </div>
 187 </body>
 188 </html>