Add missing doc files

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

diff --git a/binaries/src/ViennaRNA/doc/latex/group__energy__parameters__rw.tex b/binaries/src/ViennaRNA/doc/latex/group__energy__parameters__rw.tex
new file mode 100644 (file)
index 0000000..4d437cf
--- /dev/null
+++ b/binaries/src/ViennaRNA/doc/latex/group__energy__parameters__rw.tex
@@ -0,0 +1,71 @@
+\hypertarget{group__energy__parameters__rw}{\section{Reading/\-Writing energy parameter sets from/to File}
+\label{group__energy__parameters__rw}\index{Reading/\-Writing energy parameter sets from/to File@{Reading/\-Writing energy parameter sets from/to File}}
+}
+
+
+Read and Write energy parameter sets from and to text files.  
+
+
+Collaboration diagram for Reading/\-Writing energy parameter sets from/to File\-:
+\nopagebreak
+\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[width=350pt]{group__energy__parameters__rw}
+\end{center}
+\end{figure}
+\subsection*{Modules}
+\begin{DoxyCompactItemize}
+\item 
+\hyperlink{group__energy__parameters__convert}{Converting energy parameter files}
+\begin{DoxyCompactList}\small\item\em Convert energy parameter files into the latest format. \end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{Files}
+\begin{DoxyCompactItemize}
+\item 
+file \hyperlink{read__epars_8h}{read\-\_\-epars.\-h}
+\end{DoxyCompactItemize}
+\subsection*{Functions}
+\begin{DoxyCompactItemize}
+\item 
+void \hyperlink{group__energy__parameters__rw_ga165a142a3c68fb6655c69ef4ab7cd749}{read\-\_\-parameter\-\_\-file} (const char fname\mbox{[}$\,$\mbox{]})
+\begin{DoxyCompactList}\small\item\em Read energy parameters from a file. \end{DoxyCompactList}\item 
+void \hyperlink{group__energy__parameters__rw_ga8a43459be386a7489feeab68dc2c6c76}{write\-\_\-parameter\-\_\-file} (const char fname\mbox{[}$\,$\mbox{]})
+\begin{DoxyCompactList}\small\item\em Write energy parameters to a file. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+Read and Write energy parameter sets from and to text files. A default set of parameters, identical to the one described in \cite{mathews:2004} and\cite{turner:2010}, is compiled into the library. 
+
+\subsection{Function Documentation}
+\hypertarget{group__energy__parameters__rw_ga165a142a3c68fb6655c69ef4ab7cd749}{\index{Reading/\-Writing energy parameter sets from/to File@{Reading/\-Writing energy parameter sets from/to File}!read\-\_\-parameter\-\_\-file@{read\-\_\-parameter\-\_\-file}}
+\index{read\-\_\-parameter\-\_\-file@{read\-\_\-parameter\-\_\-file}!Reading/Writing energy parameter sets from/to File@{Reading/\-Writing energy parameter sets from/to File}}
+\subsubsection[{read\-\_\-parameter\-\_\-file}]{\setlength{\rightskip}{0pt plus 5cm}void read\-\_\-parameter\-\_\-file (
+\begin{DoxyParamCaption}
+\item[{const char}]{fname\mbox{[}$\,$\mbox{]}}
+\end{DoxyParamCaption}
+)}}\label{group__energy__parameters__rw_ga165a142a3c68fb6655c69ef4ab7cd749}
+
+
+Read energy parameters from a file. 
+
+
+\begin{DoxyParams}{Parameters}
+{\em fname} & The path to the file containing the energy parameters \\
+\hline
+\end{DoxyParams}
+\hypertarget{group__energy__parameters__rw_ga8a43459be386a7489feeab68dc2c6c76}{\index{Reading/\-Writing energy parameter sets from/to File@{Reading/\-Writing energy parameter sets from/to File}!write\-\_\-parameter\-\_\-file@{write\-\_\-parameter\-\_\-file}}
+\index{write\-\_\-parameter\-\_\-file@{write\-\_\-parameter\-\_\-file}!Reading/Writing energy parameter sets from/to File@{Reading/\-Writing energy parameter sets from/to File}}
+\subsubsection[{write\-\_\-parameter\-\_\-file}]{\setlength{\rightskip}{0pt plus 5cm}void write\-\_\-parameter\-\_\-file (
+\begin{DoxyParamCaption}
+\item[{const char}]{fname\mbox{[}$\,$\mbox{]}}
+\end{DoxyParamCaption}
+)}}\label{group__energy__parameters__rw_ga8a43459be386a7489feeab68dc2c6c76}
+
+
+Write energy parameters to a file. 
+
+
+\begin{DoxyParams}{Parameters}
+{\em fname} & A filename (path) for the file where the current energy parameters will be written to \\
+\hline
+\end{DoxyParams}