binaries/src/ViennaRNA/doc/html/group__local__mfe__fold.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: Local MFE structure Prediction and Z-scores</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__local__mfe__fold.html','');});
  55 </script>
  56 <div id="doc-content">
  57 <div class="header">
  58   <div class="summary">
  59 <a href="#func-members">Functions</a>  </div>
  60   <div class="headertitle">
  61 <div class="title">Local MFE structure Prediction and Z-scores</div>  </div>
  62 <div class="ingroups"><a class="el" href="group__local__fold.html">Predicting Locally stable structures of large sequences</a> &#124; <a class="el" href="group__mfe__fold.html">Calculating Minimum Free Energy (MFE) Structures</a></div></div><!--header-->
  63 <div class="contents">
  64 <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  65   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Local MFE structure Prediction and Z-scores:</div>
  66 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  67 </div>
  68 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  69 <center><table><tr><td><img src="group__local__mfe__fold.png" border="0" alt="" usemap="#group____local____mfe____fold"/>
  70 <map name="group____local____mfe____fold" id="group____local____mfe____fold">
  71 <area shape="rect" id="node2" href="group__local__fold.html" title="Predicting Locally\l stable structures of\l large sequences" alt="" coords="37,5,187,61"/><area shape="rect" id="node3" href="group__mfe__fold.html" title="This module contains all functions and variables related to the calculation of global minimum free en..." alt="" coords="6,85,218,126"/></map>
  72 </td></tr></table></center>
  73 </div>
  74 <table class="memberdecls">
  75 <tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
  76 Functions</h2></td></tr>
  77 <tr class="memitem:ga16e5a70e60835bb969eaecbe6482f1be"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__local__mfe__fold.html#ga16e5a70e60835bb969eaecbe6482f1be">Lfold</a> (const char *string, char *structure, int maxdist)</td></tr>
  78 <tr class="memdesc:ga16e5a70e60835bb969eaecbe6482f1be"><td class="mdescLeft">&#160;</td><td class="mdescRight">The local analog to <a class="el" href="group__mfe__fold.html#gaadafcb0f140795ae62e5ca027e335a9b" title="Compute minimum free energy and an appropriate secondary structure of an RNA sequence.">fold()</a>.  <a href="#ga16e5a70e60835bb969eaecbe6482f1be"></a><br/></td></tr>
  79 <tr class="memitem:gab6d79eecc180f586679f7b85cce5cbe9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__local__mfe__fold.html#gab6d79eecc180f586679f7b85cce5cbe9">Lfoldz</a> (const char *string, char *structure, int maxdist, int zsc, double min_z)</td></tr>
  80 </table>
  81 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  82 <hr/><h2>Function Documentation</h2>
  83 <a class="anchor" id="ga16e5a70e60835bb969eaecbe6482f1be"></a>
  84 <div class="memitem">
  85 <div class="memproto">
  86       <table class="memname">
  87         <tr>
  88           <td class="memname">float Lfold </td>
  89           <td>(</td>
  90           <td class="paramtype">const char *&#160;</td>
  91           <td class="paramname"><em>string</em>, </td>
  92         </tr>
  93         <tr>
  94           <td class="paramkey"></td>
  95           <td></td>
  96           <td class="paramtype">char *&#160;</td>
  97           <td class="paramname"><em>structure</em>, </td>
  98         </tr>
  99         <tr>
 100           <td class="paramkey"></td>
 101           <td></td>
 102           <td class="paramtype">int&#160;</td>
 103           <td class="paramname"><em>maxdist</em>&#160;</td>
 104         </tr>
 105         <tr>
 106           <td></td>
 107           <td>)</td>
 108           <td></td><td></td>
 109         </tr>
 110       </table>
 111 </div><div class="memdoc">
 112
 113 <p>The local analog to <a class="el" href="group__mfe__fold.html#gaadafcb0f140795ae62e5ca027e335a9b" title="Compute minimum free energy and an appropriate secondary structure of an RNA sequence.">fold()</a>. </p>
 114 <p>Computes the minimum free energy structure including only base pairs with a span smaller than 'maxdist'</p>
 115 <dl class="params"><dt>Parameters:</dt><dd>
 116   <table class="params">
 117     <tr><td class="paramname">string</td><td></td></tr>
 118     <tr><td class="paramname">structure</td><td></td></tr>
 119     <tr><td class="paramname">maxdist</td><td></td></tr>
 120   </table>
 121   </dd>
 122 </dl>
 123
 124 </div>
 125 </div>
 126 <a class="anchor" id="gab6d79eecc180f586679f7b85cce5cbe9"></a>
 127 <div class="memitem">
 128 <div class="memproto">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname">float Lfoldz </td>
 132           <td>(</td>
 133           <td class="paramtype">const char *&#160;</td>
 134           <td class="paramname"><em>string</em>, </td>
 135         </tr>
 136         <tr>
 137           <td class="paramkey"></td>
 138           <td></td>
 139           <td class="paramtype">char *&#160;</td>
 140           <td class="paramname"><em>structure</em>, </td>
 141         </tr>
 142         <tr>
 143           <td class="paramkey"></td>
 144           <td></td>
 145           <td class="paramtype">int&#160;</td>
 146           <td class="paramname"><em>maxdist</em>, </td>
 147         </tr>
 148         <tr>
 149           <td class="paramkey"></td>
 150           <td></td>
 151           <td class="paramtype">int&#160;</td>
 152           <td class="paramname"><em>zsc</em>, </td>
 153         </tr>
 154         <tr>
 155           <td class="paramkey"></td>
 156           <td></td>
 157           <td class="paramtype">double&#160;</td>
 158           <td class="paramname"><em>min_z</em>&#160;</td>
 159         </tr>
 160         <tr>
 161           <td></td>
 162           <td>)</td>
 163           <td></td><td></td>
 164         </tr>
 165       </table>
 166 </div><div class="memdoc">
 167 <dl class="params"><dt>Parameters:</dt><dd>
 168   <table class="params">
 169     <tr><td class="paramname">string</td><td></td></tr>
 170     <tr><td class="paramname">structure</td><td></td></tr>
 171     <tr><td class="paramname">maxdist</td><td></td></tr>
 172     <tr><td class="paramname">zsc</td><td></td></tr>
 173     <tr><td class="paramname">min_z</td><td></td></tr>
 174   </table>
 175   </dd>
 176 </dl>
 177
 178 </div>
 179 </div>
 180 </div><!-- contents -->
 181 </div><!-- doc-content -->
 182 <!-- start footer part -->
 183 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 184   <ul>
 185     <li class="footer">Generated on Wed Jul 24 2013 13:38:59 for RNAlib-2.1.2 by
 186     <a href="http://www.doxygen.org/index.html">
 187     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
 188   </ul>
 189 </div>
 190 </body>
 191 </html>