Add missing doc files

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

diff --git a/binaries/src/ViennaRNA/doc/latex/structpair__info.tex b/binaries/src/ViennaRNA/doc/latex/structpair__info.tex
new file mode 100644 (file)
index 0000000..651004e
--- /dev/null
+++ b/binaries/src/ViennaRNA/doc/latex/structpair__info.tex
@@ -0,0 +1,48 @@
+\hypertarget{structpair__info}{\section{pair\-\_\-info Struct Reference}
+\label{structpair__info}\index{pair\-\_\-info@{pair\-\_\-info}}
+}
+
+
+A base pair info structure.  
+
+
+\subsection*{Data Fields}
+\begin{DoxyCompactItemize}
+\item 
+\hypertarget{structpair__info_a7905e17da6a6cc48230ee6205628ed7f}{unsigned \hyperlink{structpair__info_a7905e17da6a6cc48230ee6205628ed7f}{i}}\label{structpair__info_a7905e17da6a6cc48230ee6205628ed7f}
+
+\begin{DoxyCompactList}\small\item\em nucleotide position i \end{DoxyCompactList}\item 
+\hypertarget{structpair__info_a35665817b5792703ff4325e1bcbe5e21}{unsigned \hyperlink{structpair__info_a35665817b5792703ff4325e1bcbe5e21}{j}}\label{structpair__info_a35665817b5792703ff4325e1bcbe5e21}
+
+\begin{DoxyCompactList}\small\item\em nucleotide position j \end{DoxyCompactList}\item 
+\hypertarget{structpair__info_af0895ea40ec0c23bfe8aa2c3babf0e80}{float \hyperlink{structpair__info_af0895ea40ec0c23bfe8aa2c3babf0e80}{p}}\label{structpair__info_af0895ea40ec0c23bfe8aa2c3babf0e80}
+
+\begin{DoxyCompactList}\small\item\em Probability. \end{DoxyCompactList}\item 
+\hypertarget{structpair__info_ab3aa7a54e6976f46e69c6ffcddd0e782}{float \hyperlink{structpair__info_ab3aa7a54e6976f46e69c6ffcddd0e782}{ent}}\label{structpair__info_ab3aa7a54e6976f46e69c6ffcddd0e782}
+
+\begin{DoxyCompactList}\small\item\em Pseudo entropy for $ p(i,j) = S_i + S_j - p_ij*ln(p_ij) $. \end{DoxyCompactList}\item 
+\hypertarget{structpair__info_a23fc316453d179474bed7f6ed2489723}{short \hyperlink{structpair__info_a23fc316453d179474bed7f6ed2489723}{bp} \mbox{[}8\mbox{]}}\label{structpair__info_a23fc316453d179474bed7f6ed2489723}
+
+\begin{DoxyCompactList}\small\item\em Frequencies of pair\-\_\-types. \end{DoxyCompactList}\item 
+\hypertarget{structpair__info_a4da3d6c9042500c16c4b06e0bbc48190}{char \hyperlink{structpair__info_a4da3d6c9042500c16c4b06e0bbc48190}{comp}}\label{structpair__info_a4da3d6c9042500c16c4b06e0bbc48190}
+
+\begin{DoxyCompactList}\small\item\em 1 iff pair is in mfe structure \end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+A base pair info structure. 
+
+For each base pair (i,j) with i,j in \mbox{[}0, n-\/1\mbox{]} the structure lists\-:
+\begin{DoxyItemize}
+\item its probability 'p'
+\item an entropy-\/like measure for its well-\/definedness 'ent'
+\item the frequency of each type of pair in 'bp\mbox{[}\mbox{]}'
+\begin{DoxyItemize}
+\item 'bp\mbox{[}0\mbox{]}' contains the number of non-\/compatible sequences
+\item 'bp\mbox{[}1\mbox{]}' the number of C\-G pairs, etc. 
+\end{DoxyItemize}
+\end{DoxyItemize}
+
+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}