<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>RNAlib-2.1.2: Compute the centroid structure</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="jquery.js"></script>
-<script type="text/javascript" src="dynsections.js"></script>
-<link href="navtree.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="resize.js"></script>
-<script type="text/javascript" src="navtree.js"></script>
-<script type="text/javascript">
- $(document).ready(initResizable);
-</script>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">RNAlib-2.1.2
- </div>
- </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.1.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
+<!-- Generated by Doxygen 1.6.1 -->
+<script type="text/javascript">
+<!--
+function changeDisplayState (e){
+ var num=this.id.replace(/[^[0-9]/g,'');
+ var button=this.firstChild;
+ var sectionDiv=document.getElementById('dynsection'+num);
+ if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
+ sectionDiv.style.display='block';
+ button.src='open.gif';
+ }else{
+ sectionDiv.style.display='none';
+ button.src='closed.gif';
+ }
+}
+function initDynSections(){
+ var divs=document.getElementsByTagName('div');
+ var sectionCounter=1;
+ for(var i=0;i<divs.length-1;i++){
+ if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
+ var header=divs[i];
+ var section=divs[i+1];
+ var button=header.firstChild;
+ if (button!='IMG'){
+ divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
+ button=document.createElement('img');
+ divs[i].insertBefore(button,divs[i].firstChild);
+ }
+ header.style.cursor='pointer';
+ header.onclick=changeDisplayState;
+ header.id='dynheader'+sectionCounter;
+ button.src='closed.gif';
+ section.id='dynsection'+sectionCounter;
+ section.style.display='none';
+ section.style.marginLeft='14px';
+ sectionCounter++;
+ }
+ }
+}
+window.onload = initDynSections;
+-->
+</script>
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="main.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
-</div><!-- top -->
-<div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
</div>
-<script type="text/javascript">
-$(document).ready(function(){initNavTree('group__centroid__fold.html','');});
-</script>
-<div id="doc-content">
-<div class="header">
- <div class="summary">
-<a href="#func-members">Functions</a> </div>
- <div class="headertitle">
-<div class="title">Compute the centroid structure</div> </div>
-<div class="ingroups"><a class="el" href="group__pf__fold.html">Calculating Partition Functions and Pair Probabilities</a></div></div><!--header-->
<div class="contents">
-<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
- <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Compute the centroid structure:</div>
-<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
+<h1>Compute the centroid structure<br/>
+<small>
+[<a class="el" href="group__pf__fold.html">Calculating Partition Functions and Pair Probabilities</a>]</small>
+</h1>
+<p><div class="dynheader">
+Collaboration diagram for Compute the centroid structure:</div>
+<div class="dynsection">
+<center><table><tr><td><img src="group__centroid__fold.png" border="0" alt="" usemap="#group____centroid____fold_map"/>
+<map name="group____centroid____fold_map" id="group____centroid____fold">
+<area shape="rect" id="node1" href="group__pf__fold.html" title="This section provides information about all functions and variables related to the..." alt="" coords="5,5,336,35"/></map></td></tr></table></center>
</div>
-<div id="dynsection-0-content" class="dyncontent" style="display:none;">
-<center><table><tr><td><img src="group__centroid__fold.png" border="0" alt="" usemap="#group____centroid____fold"/>
-<map name="group____centroid____fold" id="group____centroid____fold">
-<area shape="rect" id="node1" 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"/></map>
-</td></tr></table></center>
-</div>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
-Functions</h2></td></tr>
-<tr class="memitem:ga9aba0ba1433a6d259331e0fe9fc4a9a6"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__centroid__fold.html#ga9aba0ba1433a6d259331e0fe9fc4a9a6">get_centroid_struct_pl</a> (int length, double *dist, <a class="el" href="structplist.html">plist</a> *pl)</td></tr>
-<tr class="memdesc:ga9aba0ba1433a6d259331e0fe9fc4a9a6"><td class="mdescLeft"> </td><td class="mdescRight">Get the centroid structure of the ensemble. <a href="#ga9aba0ba1433a6d259331e0fe9fc4a9a6"></a><br/></td></tr>
-<tr class="memitem:gacdabece4aa1e20c9eaa97acb4c4dcc38"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__centroid__fold.html#gacdabece4aa1e20c9eaa97acb4c4dcc38">get_centroid_struct_pr</a> (int length, double *dist, double *<a class="el" href="fold__vars_8h.html#a0f5757427fd5f2f79d6fca0081cd5a52">pr</a>)</td></tr>
-<tr class="memdesc:gacdabece4aa1e20c9eaa97acb4c4dcc38"><td class="mdescLeft"> </td><td class="mdescRight">Get the centroid structure of the ensemble. <a href="#gacdabece4aa1e20c9eaa97acb4c4dcc38"></a><br/></td></tr>
+</p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__centroid__fold.html#ga9aba0ba1433a6d259331e0fe9fc4a9a6">get_centroid_struct_pl</a> (int length, double *dist, <a class="el" href="structplist.html">plist</a> *pl)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the centroid structure of the ensemble. <a href="#ga9aba0ba1433a6d259331e0fe9fc4a9a6"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__centroid__fold.html#gacdabece4aa1e20c9eaa97acb4c4dcc38">get_centroid_struct_pr</a> (int length, double *dist, double *<a class="el" href="fold__vars_8h.html#a0f5757427fd5f2f79d6fca0081cd5a52">pr</a>)</td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the centroid structure of the ensemble. <a href="#gacdabece4aa1e20c9eaa97acb4c4dcc38"></a><br/></td></tr>
</table>
-<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<hr/><h2>Function Documentation</h2>
-<a class="anchor" id="ga9aba0ba1433a6d259331e0fe9fc4a9a6"></a>
+<a class="anchor" id="ga9aba0ba1433a6d259331e0fe9fc4a9a6"></a><!-- doxytag: member="part_func.h::get_centroid_struct_pl" ref="ga9aba0ba1433a6d259331e0fe9fc4a9a6" args="(int length, double *dist, plist *pl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* get_centroid_struct_pl </td>
<td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>length</em>, </td>
+ <td class="paramtype">int </td>
+ <td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype">double * </td>
- <td class="paramname"><em>dist</em>, </td>
+ <td class="paramtype">double * </td>
+ <td class="paramname"> <em>dist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype"><a class="el" href="structplist.html">plist</a> * </td>
- <td class="paramname"><em>pl</em> </td>
+ <td class="paramtype"><a class="el" href="structplist.html">plist</a> * </td>
+ <td class="paramname"> <em>pl</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
- <td></td><td></td>
+ <td></td><td></td><td></td>
</tr>
</table>
-</div><div class="memdoc">
+</div>
+<div class="memdoc">
<p>Get the centroid structure of the ensemble. </p>
<p>This function is a threadsafe replacement for <a class="el" href="part__func_8h.html#ae89a63bd83e75a80b2ba36d20b31ce81">centroid()</a> with a 'plist' input</p>
<p>The centroid is the structure with the minimal average distance to all other structures <br/>
<img class="formulaInl" alt="$ <d(S)> = \sum_{(i,j) \in S} (1-p_{ij}) + \sum_{(i,j) \notin S} p_{ij} $" src="form_20.png"/> <br/>
Thus, the centroid is simply the structure containing all pairs with <img class="formulaInl" alt="$p_ij>0.5$" src="form_21.png"/> The distance of the centroid to the ensemble is written to the memory adressed by <em>dist</em>.</p>
-<pre class="fragment">\param[in] length The length of the sequence
-\param[out] dist A pointer to the distance variable where the centroid distance will be written to
-\param[in] pl A pair list containing base pair probability information about the ensemble
-\return The centroid structure of the ensemble in dot-bracket notation</pre>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>length</em> </td><td>The length of the sequence </td></tr>
+ <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>dist</em> </td><td>A pointer to the distance variable where the centroid distance will be written to </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pl</em> </td><td>A pair list containing base pair probability information about the ensemble </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>The centroid structure of the ensemble in dot-bracket notation </dd></dl>
+
</div>
</div>
-<a class="anchor" id="gacdabece4aa1e20c9eaa97acb4c4dcc38"></a>
+<a class="anchor" id="gacdabece4aa1e20c9eaa97acb4c4dcc38"></a><!-- doxytag: member="part_func.h::get_centroid_struct_pr" ref="gacdabece4aa1e20c9eaa97acb4c4dcc38" args="(int length, double *dist, double *pr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* get_centroid_struct_pr </td>
<td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>length</em>, </td>
+ <td class="paramtype">int </td>
+ <td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype">double * </td>
- <td class="paramname"><em>dist</em>, </td>
+ <td class="paramtype">double * </td>
+ <td class="paramname"> <em>dist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
- <td class="paramtype">double * </td>
- <td class="paramname"><em>pr</em> </td>
+ <td class="paramtype">double * </td>
+ <td class="paramname"> <em>pr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
- <td></td><td></td>
+ <td></td><td></td><td></td>
</tr>
</table>
-</div><div class="memdoc">
+</div>
+<div class="memdoc">
<p>Get the centroid structure of the ensemble. </p>
<p>This function is a threadsafe replacement for <a class="el" href="part__func_8h.html#ae89a63bd83e75a80b2ba36d20b31ce81">centroid()</a> with a probability array input</p>
<p>The centroid is the structure with the minimal average distance to all other structures <br/>
<img class="formulaInl" alt="$ <d(S)> = \sum_{(i,j) \in S} (1-p_{ij}) + \sum_{(i,j) \notin S} p_{ij} $" src="form_20.png"/> <br/>
Thus, the centroid is simply the structure containing all pairs with <img class="formulaInl" alt="$p_ij>0.5$" src="form_21.png"/> The distance of the centroid to the ensemble is written to the memory adressed by <em>dist</em>.</p>
-<pre class="fragment">\param[in] length The length of the sequence
-\param[out] dist A pointer to the distance variable where the centroid distance will be written to
-\param[in] pr A upper triangular matrix containing base pair probabilities (access via iindx \ref get_iindx() )
-\return The centroid structure of the ensemble in dot-bracket notation</pre>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>length</em> </td><td>The length of the sequence </td></tr>
+ <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>dist</em> </td><td>A pointer to the distance variable where the centroid distance will be written to </td></tr>
+ <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>pr</em> </td><td>A upper triangular matrix containing base pair probabilities (access via iindx <a class="el" href="utils_8h.html#a55c0f6b3b07b6adf2ee235ba901fe397">get_iindx()</a> ) </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>The centroid structure of the ensemble in dot-bracket notation </dd></dl>
+
</div>
</div>
-</div><!-- contents -->
-</div><!-- doc-content -->
-<!-- start footer part -->
-<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="footer">Generated on Wed Jul 24 2013 13:38:59 for RNAlib-2.1.2 by
- <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
- </ul>
</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated on 11 Apr 2017 for RNAlib-2.1.2 by
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>