Add missing doc files

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

diff --git a/binaries/src/ViennaRNA/doc/latex/structpf__paramT.tex b/binaries/src/ViennaRNA/doc/latex/structpf__paramT.tex
new file mode 100644 (file)
index 0000000..8d2562d
--- /dev/null
+++ b/binaries/src/ViennaRNA/doc/latex/structpf__paramT.tex
@@ -0,0 +1,50 @@
+\hypertarget{structpf__paramT}{\section{pf\-\_\-param\-T Struct Reference}
+\label{structpf__paramT}\index{pf\-\_\-param\-T@{pf\-\_\-param\-T}}
+}
+
+
+The datastructure that contains temperature scaled Boltzmann weights of the energy parameters.  
+
+
+
+
+Collaboration diagram for pf\-\_\-param\-T\-:
+\nopagebreak
+\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[width=183pt]{structpf__paramT__coll__graph}
+\end{center}
+\end{figure}
+\subsection*{Data Fields}
+\begin{DoxyCompactItemize}
+\item 
+\hypertarget{structpf__paramT_aef40322e7ca1adbd9b438aeda0352e8f}{double \hyperlink{structpf__paramT_aef40322e7ca1adbd9b438aeda0352e8f}{pf\-\_\-scale}}\label{structpf__paramT_aef40322e7ca1adbd9b438aeda0352e8f}
+
+\begin{DoxyCompactList}\small\item\em Scaling factor to avoid over-\//underflows. \end{DoxyCompactList}\item 
+\hypertarget{structpf__paramT_aa0e11e9f1f6e212640baf40d7195a014}{double \hyperlink{structpf__paramT_aa0e11e9f1f6e212640baf40d7195a014}{temperature}}\label{structpf__paramT_aa0e11e9f1f6e212640baf40d7195a014}
+
+\begin{DoxyCompactList}\small\item\em Temperature used for loop contribution scaling. \end{DoxyCompactList}\item 
+double \hyperlink{structpf__paramT_a3d2af9040acfa08295efb50f0219149d}{alpha}
+\begin{DoxyCompactList}\small\item\em Scaling factor for the thermodynamic temperature. \end{DoxyCompactList}\item 
+\hypertarget{structpf__paramT_a43ec875779c5e7c8bf5fa7e837ec6d09}{\hyperlink{structmodel__detailsT}{model\-\_\-details\-T} \hyperlink{structpf__paramT_a43ec875779c5e7c8bf5fa7e837ec6d09}{model\-\_\-details}}\label{structpf__paramT_a43ec875779c5e7c8bf5fa7e837ec6d09}
+
+\begin{DoxyCompactList}\small\item\em Model details to be used in the recursions. \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+The datastructure that contains temperature scaled Boltzmann weights of the energy parameters. 
+
+\subsection{Field Documentation}
+\hypertarget{structpf__paramT_a3d2af9040acfa08295efb50f0219149d}{\index{pf\-\_\-param\-T@{pf\-\_\-param\-T}!alpha@{alpha}}
+\index{alpha@{alpha}!pf_paramT@{pf\-\_\-param\-T}}
+\subsubsection[{alpha}]{\setlength{\rightskip}{0pt plus 5cm}double pf\-\_\-param\-T\-::alpha}}\label{structpf__paramT_a3d2af9040acfa08295efb50f0219149d}
+
+
+Scaling factor for the thermodynamic temperature. 
+
+This allows for temperature scaling in Boltzmann factors independently from the energy contributions. The resulting Boltzmann factors are then computed by $ e^{-E/(\alpha \cdot K \cdot T)} $ 
+
+The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
+\item 
+/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/\hyperlink{data__structures_8h}{data\-\_\-structures.\-h}\end{DoxyCompactItemize}