Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / group__subopt__zuker.tex
diff --git a/binaries/src/ViennaRNA/doc/latex/group__subopt__zuker.tex b/binaries/src/ViennaRNA/doc/latex/group__subopt__zuker.tex
new file mode 100644 (file)
index 0000000..78e5b55
--- /dev/null
@@ -0,0 +1,46 @@
+\hypertarget{group__subopt__zuker}{\section{Suboptimal structures according to Zuker et al. 1989}
+\label{group__subopt__zuker}\index{Suboptimal structures according to Zuker et al. 1989@{Suboptimal structures according to Zuker et al. 1989}}
+}
+Collaboration diagram for Suboptimal structures according to Zuker et al. 1989\-:
+\nopagebreak
+\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[width=348pt]{group__subopt__zuker}
+\end{center}
+\end{figure}
+\subsection*{Functions}
+\begin{DoxyCompactItemize}
+\item 
+\hyperlink{structSOLUTION}{S\-O\-L\-U\-T\-I\-O\-N} $\ast$ \hyperlink{group__subopt__zuker_ga0d5104e3ecf119d8eabd40aa5fe47f90}{zukersubopt} (const char $\ast$string)
+\begin{DoxyCompactList}\small\item\em Compute Zuker type suboptimal structures. \end{DoxyCompactList}\item 
+\hypertarget{group__subopt__zuker_ga6d98a9450d1affadf144ac79f543da8c}{\hyperlink{structSOLUTION}{S\-O\-L\-U\-T\-I\-O\-N} $\ast$ \hyperlink{group__subopt__zuker_ga6d98a9450d1affadf144ac79f543da8c}{zukersubopt\-\_\-par} (const char $\ast$string, \hyperlink{structparamT}{param\-T} $\ast$parameters)}\label{group__subopt__zuker_ga6d98a9450d1affadf144ac79f543da8c}
+
+\begin{DoxyCompactList}\small\item\em Compute Zuker type suboptimal structures. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+
+
+\subsection{Function Documentation}
+\hypertarget{group__subopt__zuker_ga0d5104e3ecf119d8eabd40aa5fe47f90}{\index{Suboptimal structures according to Zuker et al. 1989@{Suboptimal structures according to Zuker et al. 1989}!zukersubopt@{zukersubopt}}
+\index{zukersubopt@{zukersubopt}!Suboptimal structures according to Zuker et al. 1989@{Suboptimal structures according to Zuker et al. 1989}}
+\subsubsection[{zukersubopt}]{\setlength{\rightskip}{0pt plus 5cm}{\bf S\-O\-L\-U\-T\-I\-O\-N}$\ast$ zukersubopt (
+\begin{DoxyParamCaption}
+\item[{const char $\ast$}]{string}
+\end{DoxyParamCaption}
+)}}\label{group__subopt__zuker_ga0d5104e3ecf119d8eabd40aa5fe47f90}
+
+
+Compute Zuker type suboptimal structures. 
+
+Compute Suboptimal structures according to M. Zuker, i.\-e. for every possible base pair the minimum energy structure containing the resp. base pair. Returns a list of these structures and their energies.
+
+
+\begin{DoxyParams}{Parameters}
+{\em string} & R\-N\-A sequence \\
+\hline
+\end{DoxyParams}
+\begin{DoxyReturn}{Returns}
+List of zuker suboptimal structures 
+\end{DoxyReturn}