binaries/src/ViennaRNA/doc/html/group__up__cofold.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: Partition Function for two hybridized Sequences as a stepwise Process</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><a href="files.html"><span>Files</span></a></li>
  41     </ul>
  42   </div>
  43 </div><!-- top -->
  44 <div id="side-nav" class="ui-resizable side-nav-resizable">
  45   <div id="nav-tree">
  46     <div id="nav-tree-contents">
  47     </div>
  48   </div>
  49   <div id="splitbar" style="-moz-user-select:none;"
  50        class="ui-resizable-handle">
  51   </div>
  52 </div>
  53 <script type="text/javascript">
  54 $(document).ready(function(){initNavTree('group__up__cofold.html','');});
  55 </script>
  56 <div id="doc-content">
  57 <div class="header">
  58   <div class="summary">
  59 <a href="#files">Files</a> &#124;
  60 <a href="#func-members">Functions</a>  </div>
  61   <div class="headertitle">
  62 <div class="title">Partition Function for two hybridized Sequences as a stepwise Process</div>  </div>
  63 <div class="ingroups"><a class="el" href="group__cofold.html">Calculate Secondary Structures of two RNAs upon Dimerization</a> &#124; <a class="el" href="group__pf__fold.html">Calculating Partition Functions and Pair Probabilities</a></div></div><!--header-->
  64 <div class="contents">
  65
  66 <p>Partition Function Cofolding as a stepwise process.
  67 <a href="#details">More...</a></p>
  68 <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  69   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Partition Function for two hybridized Sequences as a stepwise Process:</div>
  70 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  71 </div>
  72 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  73 <center><table><tr><td><img src="group__up__cofold.png" border="0" alt="" usemap="#group____up____cofold"/>
  74 <map name="group____up____cofold" id="group____up____cofold">
  75 <area shape="rect" id="node2" href="group__pf__fold.html" title="This section provides information about all functions and variables related to the calculation of the..." alt="" coords="6,5,229,46"/><area shape="rect" id="node3" href="group__cofold.html" title="Predict structures formed by two molecules upon hybridization." alt="" coords="31,69,204,125"/></map>
  76 </td></tr></table></center>
  77 </div>
  78 <table class="memberdecls">
  79 <tr class="heading"><td colspan="2"><h2><a name="files"></a>
  80 Files</h2></td></tr>
  81 <tr class="memitem:part__func__up_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="part__func__up_8h.html">part_func_up.h</a></td></tr>
  82 <tr class="memdesc:part__func__up_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Partition Function Cofolding as stepwise process. <br/></td></tr>
  83 </table><table class="memberdecls">
  84 <tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
  85 Functions</h2></td></tr>
  86 <tr class="memitem:ga5b4ee40e190d2f633cd01cf0d2fe93cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpu__contrib.html">pu_contrib</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__up__cofold.html#ga5b4ee40e190d2f633cd01cf0d2fe93cf">pf_unstru</a> (char *sequence, int max_w)</td></tr>
  87 <tr class="memdesc:ga5b4ee40e190d2f633cd01cf0d2fe93cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the partition function over all unpaired regions of a maximal length.  <a href="#ga5b4ee40e190d2f633cd01cf0d2fe93cf"></a><br/></td></tr>
  88 <tr class="memitem:ga1aa0aa02bc3a724f87360c03097afd00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structinteract.html">interact</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__up__cofold.html#ga1aa0aa02bc3a724f87360c03097afd00">pf_interact</a> (const char *s1, const char *s2, <a class="el" href="structpu__contrib.html">pu_contrib</a> *p_c, <a class="el" href="structpu__contrib.html">pu_contrib</a> *p_c2, int max_w, char *cstruc, int incr3, int incr5)</td></tr>
  89 <tr class="memdesc:ga1aa0aa02bc3a724f87360c03097afd00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates the probability of a local interaction between two sequences.  <a href="#ga1aa0aa02bc3a724f87360c03097afd00"></a><br/></td></tr>
  90 <tr class="memitem:gadde308fd5f696dc271b1532aa96fd12f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadde308fd5f696dc271b1532aa96fd12f"></a>
  91 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__up__cofold.html#gadde308fd5f696dc271b1532aa96fd12f">free_interact</a> (<a class="el" href="structinteract.html">interact</a> *pin)</td></tr>
  92 <tr class="memdesc:gadde308fd5f696dc271b1532aa96fd12f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees the output of function <a class="el" href="group__up__cofold.html#ga1aa0aa02bc3a724f87360c03097afd00" title="Calculates the probability of a local interaction between two sequences.">pf_interact()</a>. <br/></td></tr>
  93 <tr class="memitem:gac20bd61824981d45ce0dc9934aa56df8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac20bd61824981d45ce0dc9934aa56df8"></a>
  94 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__up__cofold.html#gac20bd61824981d45ce0dc9934aa56df8">free_pu_contrib_struct</a> (<a class="el" href="structpu__contrib.html">pu_contrib</a> *pu)</td></tr>
  95 <tr class="memdesc:gac20bd61824981d45ce0dc9934aa56df8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees the output of function <a class="el" href="group__up__cofold.html#ga5b4ee40e190d2f633cd01cf0d2fe93cf" title="Calculate the partition function over all unpaired regions of a maximal length.">pf_unstru()</a>. <br/></td></tr>
  96 </table>
  97 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  98 <p>Partition Function Cofolding as a stepwise process. </p>
  99 <hr/><h2>Function Documentation</h2>
 100 <a class="anchor" id="ga5b4ee40e190d2f633cd01cf0d2fe93cf"></a>
 101 <div class="memitem">
 102 <div class="memproto">
 103       <table class="memname">
 104         <tr>
 105           <td class="memname"><a class="el" href="structpu__contrib.html">pu_contrib</a>* pf_unstru </td>
 106           <td>(</td>
 107           <td class="paramtype">char *&#160;</td>
 108           <td class="paramname"><em>sequence</em>, </td>
 109         </tr>
 110         <tr>
 111           <td class="paramkey"></td>
 112           <td></td>
 113           <td class="paramtype">int&#160;</td>
 114           <td class="paramname"><em>max_w</em>&#160;</td>
 115         </tr>
 116         <tr>
 117           <td></td>
 118           <td>)</td>
 119           <td></td><td></td>
 120         </tr>
 121       </table>
 122 </div><div class="memdoc">
 123
 124 <p>Calculate the partition function over all unpaired regions of a maximal length. </p>
 125 <p>You have to call function <a class="el" href="group__pf__fold.html#gadc3db3d98742427e7001a7fd36ef28c2" title="Compute the partition function  of an RNA sequence.">pf_fold()</a> providing the same sequence before calling <a class="el" href="group__up__cofold.html#ga5b4ee40e190d2f633cd01cf0d2fe93cf" title="Calculate the partition function over all unpaired regions of a maximal length.">pf_unstru()</a>. If you want to calculate unpaired regions for a constrained structure, set variable 'structure' in function '<a class="el" href="group__pf__fold.html#gadc3db3d98742427e7001a7fd36ef28c2" title="Compute the partition function  of an RNA sequence.">pf_fold()</a>' to the constrain string. It returns a <a class="el" href="structpu__contrib.html" title="contributions to p_u">pu_contrib</a> struct containing four arrays of dimension [i = 1 to length(sequence)][j = 0 to u-1] containing all possible contributions to the probabilities of unpaired regions of maximum length u. Each array in <a class="el" href="structpu__contrib.html" title="contributions to p_u">pu_contrib</a> contains one of the contributions to the total probability of being unpaired: The probability of being unpaired within an exterior loop is in array <a class="el" href="structpu__contrib.html" title="contributions to p_u">pu_contrib</a>-&gt;E, the probability of being unpaired within a hairpin loop is in array <a class="el" href="structpu__contrib.html" title="contributions to p_u">pu_contrib</a>-&gt;H, the probability of being unpaired within an interior loop is in array <a class="el" href="structpu__contrib.html" title="contributions to p_u">pu_contrib</a>-&gt;I and probability of being unpaired within a multi-loop is in array <a class="el" href="structpu__contrib.html" title="contributions to p_u">pu_contrib</a>-&gt;M. The total probability of being unpaired is the sum of the four arrays of <a class="el" href="structpu__contrib.html" title="contributions to p_u">pu_contrib</a>.</p>
 126 <p>This function frees everything allocated automatically. To free the output structure call free_pu_contrib().</p>
 127 <dl class="params"><dt>Parameters:</dt><dd>
 128   <table class="params">
 129     <tr><td class="paramname">sequence</td><td></td></tr>
 130     <tr><td class="paramname">max_w</td><td></td></tr>
 131   </table>
 132   </dd>
 133 </dl>
 134 <dl class="section return"><dt>Returns:</dt><dd></dd></dl>
 135
 136 </div>
 137 </div>
 138 <a class="anchor" id="ga1aa0aa02bc3a724f87360c03097afd00"></a>
 139 <div class="memitem">
 140 <div class="memproto">
 141       <table class="memname">
 142         <tr>
 143           <td class="memname"><a class="el" href="structinteract.html">interact</a>* pf_interact </td>
 144           <td>(</td>
 145           <td class="paramtype">const char *&#160;</td>
 146           <td class="paramname"><em>s1</em>, </td>
 147         </tr>
 148         <tr>
 149           <td class="paramkey"></td>
 150           <td></td>
 151           <td class="paramtype">const char *&#160;</td>
 152           <td class="paramname"><em>s2</em>, </td>
 153         </tr>
 154         <tr>
 155           <td class="paramkey"></td>
 156           <td></td>
 157           <td class="paramtype"><a class="el" href="structpu__contrib.html">pu_contrib</a> *&#160;</td>
 158           <td class="paramname"><em>p_c</em>, </td>
 159         </tr>
 160         <tr>
 161           <td class="paramkey"></td>
 162           <td></td>
 163           <td class="paramtype"><a class="el" href="structpu__contrib.html">pu_contrib</a> *&#160;</td>
 164           <td class="paramname"><em>p_c2</em>, </td>
 165         </tr>
 166         <tr>
 167           <td class="paramkey"></td>
 168           <td></td>
 169           <td class="paramtype">int&#160;</td>
 170           <td class="paramname"><em>max_w</em>, </td>
 171         </tr>
 172         <tr>
 173           <td class="paramkey"></td>
 174           <td></td>
 175           <td class="paramtype">char *&#160;</td>
 176           <td class="paramname"><em>cstruc</em>, </td>
 177         </tr>
 178         <tr>
 179           <td class="paramkey"></td>
 180           <td></td>
 181           <td class="paramtype">int&#160;</td>
 182           <td class="paramname"><em>incr3</em>, </td>
 183         </tr>
 184         <tr>
 185           <td class="paramkey"></td>
 186           <td></td>
 187           <td class="paramtype">int&#160;</td>
 188           <td class="paramname"><em>incr5</em>&#160;</td>
 189         </tr>
 190         <tr>
 191           <td></td>
 192           <td>)</td>
 193           <td></td><td></td>
 194         </tr>
 195       </table>
 196 </div><div class="memdoc">
 197
 198 <p>Calculates the probability of a local interaction between two sequences. </p>
 199 <p>The function considers the probability that the region of interaction is unpaired within 's1' and 's2'. The longer sequence has to be given as 's1'. The shorter sequence has to be given as 's2'. Function <a class="el" href="group__up__cofold.html#ga5b4ee40e190d2f633cd01cf0d2fe93cf" title="Calculate the partition function over all unpaired regions of a maximal length.">pf_unstru()</a> has to be called for 's1' and 's2', where the probabilities of being unpaired have to be given in 'p_c' and 'p_c2', respectively. If you do not want to include the probabilities of being unpaired for 's2' set 'p_c2' to NULL. If variable 'cstruc' is not NULL, constrained folding is done: The available constrains for intermolecular interaction are: '.' (no constrain), 'x' (the base has no intermolecular interaction) and '|' (the corresponding base has to be paired intermolecularily).<br/>
 200  The parameter 'w' determines the maximal length of the interaction. The parameters 'incr5' and 'incr3' allows inclusion of unpaired residues left ('incr5') and right ('incr3') of the region of interaction in 's1'. If the 'incr' options are used, function <a class="el" href="group__up__cofold.html#ga5b4ee40e190d2f633cd01cf0d2fe93cf" title="Calculate the partition function over all unpaired regions of a maximal length.">pf_unstru()</a> has to be called with w=w+incr5+incr3 for the longer sequence 's1'.</p>
 201 <p>It returns a structure of type <a class="el" href="structinteract.html">interact</a> which contains the probability of the best local interaction including residue i in Pi and the minimum free energy in Gi, where i is the position in sequence 's1'. The member Gikjl of structure <a class="el" href="structinteract.html">interact</a> is the best interaction between region [k,i] k&lt;i in longer sequence 's1' and region [j,l] j&lt;l in 's2'. Gikjl_wo is Gikjl without the probability of beeing unpaired.<br/>
 202  Use <a class="el" href="group__up__cofold.html#gadde308fd5f696dc271b1532aa96fd12f" title="Frees the output of function pf_interact().">free_interact()</a> to free the returned structure, all other stuff is freed inside <a class="el" href="group__up__cofold.html#ga1aa0aa02bc3a724f87360c03097afd00" title="Calculates the probability of a local interaction between two sequences.">pf_interact()</a>.</p>
 203 <dl class="params"><dt>Parameters:</dt><dd>
 204   <table class="params">
 205     <tr><td class="paramname">s1</td><td></td></tr>
 206     <tr><td class="paramname">s2</td><td></td></tr>
 207     <tr><td class="paramname">p_c</td><td></td></tr>
 208     <tr><td class="paramname">p_c2</td><td></td></tr>
 209     <tr><td class="paramname">max_w</td><td></td></tr>
 210     <tr><td class="paramname">cstruc</td><td></td></tr>
 211     <tr><td class="paramname">incr3</td><td></td></tr>
 212     <tr><td class="paramname">incr5</td><td></td></tr>
 213   </table>
 214   </dd>
 215 </dl>
 216 <dl class="section return"><dt>Returns:</dt><dd></dd></dl>
 217
 218 </div>
 219 </div>
 220 </div><!-- contents -->
 221 </div><!-- doc-content -->
 222 <!-- start footer part -->
 223 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 224   <ul>
 225     <li class="footer">Generated on Wed Jul 24 2013 13:38:59 for RNAlib-2.1.2 by
 226     <a href="http://www.doxygen.org/index.html">
 227     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
 228   </ul>
 229 </div>
 230 </body>
 231 </html>