Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / group__local__mfe__fold.tex
1 \hypertarget{group__local__mfe__fold}{\section{Local M\-F\-E structure Prediction and Z-\/scores}
2 \label{group__local__mfe__fold}\index{Local M\-F\-E structure Prediction and Z-\/scores@{Local M\-F\-E structure Prediction and Z-\/scores}}
3 }
4 Collaboration diagram for Local M\-F\-E structure Prediction and Z-\/scores\-:
5 \nopagebreak
6 \begin{figure}[H]
7 \begin{center}
8 \leavevmode
9 \includegraphics[width=350pt]{group__local__mfe__fold}
10 \end{center}
11 \end{figure}
12 \subsection*{Functions}
13 \begin{DoxyCompactItemize}
14 \item 
15 float \hyperlink{group__local__mfe__fold_ga16e5a70e60835bb969eaecbe6482f1be}{Lfold} (const char $\ast$string, char $\ast$structure, int maxdist)
16 \begin{DoxyCompactList}\small\item\em The local analog to \hyperlink{group__mfe__fold_gaadafcb0f140795ae62e5ca027e335a9b}{fold()}. \end{DoxyCompactList}\item 
17 float \hyperlink{group__local__mfe__fold_gab6d79eecc180f586679f7b85cce5cbe9}{Lfoldz} (const char $\ast$string, char $\ast$structure, int maxdist, int zsc, double min\-\_\-z)
18 \end{DoxyCompactItemize}
19
20
21 \subsection{Detailed Description}
22
23
24 \subsection{Function Documentation}
25 \hypertarget{group__local__mfe__fold_ga16e5a70e60835bb969eaecbe6482f1be}{\index{Local M\-F\-E structure Prediction and Z-\/scores@{Local M\-F\-E structure Prediction and Z-\/scores}!Lfold@{Lfold}}
26 \index{Lfold@{Lfold}!Local MFE structure Prediction and Z-scores@{Local M\-F\-E structure Prediction and Z-\/scores}}
27 \subsubsection[{Lfold}]{\setlength{\rightskip}{0pt plus 5cm}float Lfold (
28 \begin{DoxyParamCaption}
29 \item[{const char $\ast$}]{string, }
30 \item[{char $\ast$}]{structure, }
31 \item[{int}]{maxdist}
32 \end{DoxyParamCaption}
33 )}}\label{group__local__mfe__fold_ga16e5a70e60835bb969eaecbe6482f1be}
34
35
36 The local analog to \hyperlink{group__mfe__fold_gaadafcb0f140795ae62e5ca027e335a9b}{fold()}. 
37
38 Computes the minimum free energy structure including only base pairs with a span smaller than 'maxdist'
39
40
41 \begin{DoxyParams}{Parameters}
42 {\em string} & \\
43 \hline
44 {\em structure} & \\
45 \hline
46 {\em maxdist} & \\
47 \hline
48 \end{DoxyParams}
49 \hypertarget{group__local__mfe__fold_gab6d79eecc180f586679f7b85cce5cbe9}{\index{Local M\-F\-E structure Prediction and Z-\/scores@{Local M\-F\-E structure Prediction and Z-\/scores}!Lfoldz@{Lfoldz}}
50 \index{Lfoldz@{Lfoldz}!Local MFE structure Prediction and Z-scores@{Local M\-F\-E structure Prediction and Z-\/scores}}
51 \subsubsection[{Lfoldz}]{\setlength{\rightskip}{0pt plus 5cm}float Lfoldz (
52 \begin{DoxyParamCaption}
53 \item[{const char $\ast$}]{string, }
54 \item[{char $\ast$}]{structure, }
55 \item[{int}]{maxdist, }
56 \item[{int}]{zsc, }
57 \item[{double}]{min\-\_\-z}
58 \end{DoxyParamCaption}
59 )}}\label{group__local__mfe__fold_gab6d79eecc180f586679f7b85cce5cbe9}
60
61 \begin{DoxyParams}{Parameters}
62 {\em string} & \\
63 \hline
64 {\em structure} & \\
65 \hline
66 {\em maxdist} & \\
67 \hline
68 {\em zsc} & \\
69 \hline
70 {\em min\-\_\-z} & \\
71 \hline
72 \end{DoxyParams}