Add missing doc files

[jabaws.git] / binaries / src / ViennaRNA / doc / latex / group__local__mfe__fold.tex

diff --git a/binaries/src/ViennaRNA/doc/latex/group__local__mfe__fold.tex b/binaries/src/ViennaRNA/doc/latex/group__local__mfe__fold.tex
new file mode 100644 (file)
index 0000000..3d55879
--- /dev/null
+++ b/binaries/src/ViennaRNA/doc/latex/group__local__mfe__fold.tex
@@ -0,0 +1,72 @@
+\hypertarget{group__local__mfe__fold}{\section{Local M\-F\-E structure Prediction and Z-\/scores}
+\label{group__local__mfe__fold}\index{Local M\-F\-E structure Prediction and Z-\/scores@{Local M\-F\-E structure Prediction and Z-\/scores}}
+}
+Collaboration diagram for Local M\-F\-E structure Prediction and Z-\/scores\-:
+\nopagebreak
+\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[width=350pt]{group__local__mfe__fold}
+\end{center}
+\end{figure}
+\subsection*{Functions}
+\begin{DoxyCompactItemize}
+\item 
+float \hyperlink{group__local__mfe__fold_ga16e5a70e60835bb969eaecbe6482f1be}{Lfold} (const char $\ast$string, char $\ast$structure, int maxdist)
+\begin{DoxyCompactList}\small\item\em The local analog to \hyperlink{group__mfe__fold_gaadafcb0f140795ae62e5ca027e335a9b}{fold()}. \end{DoxyCompactList}\item 
+float \hyperlink{group__local__mfe__fold_gab6d79eecc180f586679f7b85cce5cbe9}{Lfoldz} (const char $\ast$string, char $\ast$structure, int maxdist, int zsc, double min\-\_\-z)
+\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+
+
+\subsection{Function Documentation}
+\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}}
+\index{Lfold@{Lfold}!Local MFE structure Prediction and Z-scores@{Local M\-F\-E structure Prediction and Z-\/scores}}
+\subsubsection[{Lfold}]{\setlength{\rightskip}{0pt plus 5cm}float Lfold (
+\begin{DoxyParamCaption}
+\item[{const char $\ast$}]{string, }
+\item[{char $\ast$}]{structure, }
+\item[{int}]{maxdist}
+\end{DoxyParamCaption}
+)}}\label{group__local__mfe__fold_ga16e5a70e60835bb969eaecbe6482f1be}
+
+
+The local analog to \hyperlink{group__mfe__fold_gaadafcb0f140795ae62e5ca027e335a9b}{fold()}. 
+
+Computes the minimum free energy structure including only base pairs with a span smaller than 'maxdist'
+
+
+\begin{DoxyParams}{Parameters}
+{\em string} & \\
+\hline
+{\em structure} & \\
+\hline
+{\em maxdist} & \\
+\hline
+\end{DoxyParams}
+\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}}
+\index{Lfoldz@{Lfoldz}!Local MFE structure Prediction and Z-scores@{Local M\-F\-E structure Prediction and Z-\/scores}}
+\subsubsection[{Lfoldz}]{\setlength{\rightskip}{0pt plus 5cm}float Lfoldz (
+\begin{DoxyParamCaption}
+\item[{const char $\ast$}]{string, }
+\item[{char $\ast$}]{structure, }
+\item[{int}]{maxdist, }
+\item[{int}]{zsc, }
+\item[{double}]{min\-\_\-z}
+\end{DoxyParamCaption}
+)}}\label{group__local__mfe__fold_gab6d79eecc180f586679f7b85cce5cbe9}
+
+\begin{DoxyParams}{Parameters}
+{\em string} & \\
+\hline
+{\em structure} & \\
+\hline
+{\em maxdist} & \\
+\hline
+{\em zsc} & \\
+\hline
+{\em min\-\_\-z} & \\
+\hline
+\end{DoxyParams}