Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / structpair__info.tex
1 \hypertarget{structpair__info}{\section{pair\-\_\-info Struct Reference}
2 \label{structpair__info}\index{pair\-\_\-info@{pair\-\_\-info}}
3 }
4
5
6 A base pair info structure.  
7
8
9 \subsection*{Data Fields}
10 \begin{DoxyCompactItemize}
11 \item 
12 \hypertarget{structpair__info_a7905e17da6a6cc48230ee6205628ed7f}{unsigned \hyperlink{structpair__info_a7905e17da6a6cc48230ee6205628ed7f}{i}}\label{structpair__info_a7905e17da6a6cc48230ee6205628ed7f}
13
14 \begin{DoxyCompactList}\small\item\em nucleotide position i \end{DoxyCompactList}\item 
15 \hypertarget{structpair__info_a35665817b5792703ff4325e1bcbe5e21}{unsigned \hyperlink{structpair__info_a35665817b5792703ff4325e1bcbe5e21}{j}}\label{structpair__info_a35665817b5792703ff4325e1bcbe5e21}
16
17 \begin{DoxyCompactList}\small\item\em nucleotide position j \end{DoxyCompactList}\item 
18 \hypertarget{structpair__info_af0895ea40ec0c23bfe8aa2c3babf0e80}{float \hyperlink{structpair__info_af0895ea40ec0c23bfe8aa2c3babf0e80}{p}}\label{structpair__info_af0895ea40ec0c23bfe8aa2c3babf0e80}
19
20 \begin{DoxyCompactList}\small\item\em Probability. \end{DoxyCompactList}\item 
21 \hypertarget{structpair__info_ab3aa7a54e6976f46e69c6ffcddd0e782}{float \hyperlink{structpair__info_ab3aa7a54e6976f46e69c6ffcddd0e782}{ent}}\label{structpair__info_ab3aa7a54e6976f46e69c6ffcddd0e782}
22
23 \begin{DoxyCompactList}\small\item\em Pseudo entropy for $ p(i,j) = S_i + S_j - p_ij*ln(p_ij) $. \end{DoxyCompactList}\item 
24 \hypertarget{structpair__info_a23fc316453d179474bed7f6ed2489723}{short \hyperlink{structpair__info_a23fc316453d179474bed7f6ed2489723}{bp} \mbox{[}8\mbox{]}}\label{structpair__info_a23fc316453d179474bed7f6ed2489723}
25
26 \begin{DoxyCompactList}\small\item\em Frequencies of pair\-\_\-types. \end{DoxyCompactList}\item 
27 \hypertarget{structpair__info_a4da3d6c9042500c16c4b06e0bbc48190}{char \hyperlink{structpair__info_a4da3d6c9042500c16c4b06e0bbc48190}{comp}}\label{structpair__info_a4da3d6c9042500c16c4b06e0bbc48190}
28
29 \begin{DoxyCompactList}\small\item\em 1 iff pair is in mfe structure \end{DoxyCompactList}\end{DoxyCompactItemize}
30
31
32 \subsection{Detailed Description}
33 A base pair info structure. 
34
35 For each base pair (i,j) with i,j in \mbox{[}0, n-\/1\mbox{]} the structure lists\-:
36 \begin{DoxyItemize}
37 \item its probability 'p'
38 \item an entropy-\/like measure for its well-\/definedness 'ent'
39 \item the frequency of each type of pair in 'bp\mbox{[}\mbox{]}'
40 \begin{DoxyItemize}
41 \item 'bp\mbox{[}0\mbox{]}' contains the number of non-\/compatible sequences
42 \item 'bp\mbox{[}1\mbox{]}' the number of C\-G pairs, etc. 
43 \end{DoxyItemize}
44 \end{DoxyItemize}
45
46 The documentation for this struct was generated from the following file\-:\begin{DoxyCompactItemize}
47 \item 
48 /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}