Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / energy__const_8h.tex
1 \hypertarget{energy__const_8h}{\section{/home/asherstnev/\-Projects/\-Java.projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/energy\-\_\-const.h File Reference}
2 \label{energy__const_8h}\index{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/energy\-\_\-const.\-h@{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/energy\-\_\-const.\-h}}
3 }
4 Include dependency graph for energy\-\_\-const.\-h\-:
5 \nopagebreak
6 \begin{figure}[H]
7 \begin{center}
8 \leavevmode
9 \includegraphics[width=250pt]{energy__const_8h__incl}
10 \end{center}
11 \end{figure}
12 This graph shows which files directly or indirectly include this file\-:
13 \nopagebreak
14 \begin{figure}[H]
15 \begin{center}
16 \leavevmode
17 \includegraphics[width=350pt]{energy__const_8h__dep__incl}
18 \end{center}
19 \end{figure}
20 \subsection*{Macros}
21 \begin{DoxyCompactItemize}
22 \item 
23 \#define \hyperlink{energy__const_8h_ab1e4a8d82f24ed5db01dde5f25269cf1}{G\-A\-S\-C\-O\-N\-S\-T}~1.\-98717  /$\ast$ in \mbox{[}cal/K\mbox{]} $\ast$/
24 \item 
25 \#define \hyperlink{energy__const_8h_a307c72605e3713972b4f4fb2d53ea20e}{K0}~273.\-15
26 \item 
27 \#define \hyperlink{energy__const_8h_a12c2040f25d8e3a7b9e1c2024c618cb6}{I\-N\-F}~10000000 /$\ast$ (I\-N\-T\-\_\-\-M\-A\-X/10) $\ast$/
28 \item 
29 \#define \hyperlink{energy__const_8h_a5064c29ab2d1e20c2304b3c67562774d}{F\-O\-R\-B\-I\-D\-D\-E\-N}~9999
30 \item 
31 \#define \hyperlink{energy__const_8h_a96a9822fa134450197dd454b1478a193}{B\-O\-N\-U\-S}~10000
32 \item 
33 \#define \hyperlink{energy__const_8h_a5e75221c779d618eab81e096f37e32ce}{N\-B\-P\-A\-I\-R\-S}~7
34 \item 
35 \#define \hyperlink{energy__const_8h_ae646250fd59311356c7e5722a81c3a96}{T\-U\-R\-N}~3
36 \item 
37 \#define \hyperlink{energy__const_8h_ad1bd6eabac419670ddd3c9ed82145988}{M\-A\-X\-L\-O\-O\-P}~30
38 \end{DoxyCompactItemize}
39
40
41 \subsection{Detailed Description}
42 energy constants 
43
44 \subsection{Macro Definition Documentation}
45 \hypertarget{energy__const_8h_ab1e4a8d82f24ed5db01dde5f25269cf1}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!G\-A\-S\-C\-O\-N\-S\-T@{G\-A\-S\-C\-O\-N\-S\-T}}
46 \index{G\-A\-S\-C\-O\-N\-S\-T@{G\-A\-S\-C\-O\-N\-S\-T}!energy_const.h@{energy\-\_\-const.\-h}}
47 \subsubsection[{G\-A\-S\-C\-O\-N\-S\-T}]{\setlength{\rightskip}{0pt plus 5cm}\#define G\-A\-S\-C\-O\-N\-S\-T~1.\-98717  /$\ast$ in \mbox{[}cal/K\mbox{]} $\ast$/}}\label{energy__const_8h_ab1e4a8d82f24ed5db01dde5f25269cf1}
48 The gas constant \hypertarget{energy__const_8h_a307c72605e3713972b4f4fb2d53ea20e}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!K0@{K0}}
49 \index{K0@{K0}!energy_const.h@{energy\-\_\-const.\-h}}
50 \subsubsection[{K0}]{\setlength{\rightskip}{0pt plus 5cm}\#define K0~273.\-15}}\label{energy__const_8h_a307c72605e3713972b4f4fb2d53ea20e}
51 0 deg Celsius in Kelvin \hypertarget{energy__const_8h_a12c2040f25d8e3a7b9e1c2024c618cb6}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!I\-N\-F@{I\-N\-F}}
52 \index{I\-N\-F@{I\-N\-F}!energy_const.h@{energy\-\_\-const.\-h}}
53 \subsubsection[{I\-N\-F}]{\setlength{\rightskip}{0pt plus 5cm}\#define I\-N\-F~10000000 /$\ast$ (I\-N\-T\-\_\-\-M\-A\-X/10) $\ast$/}}\label{energy__const_8h_a12c2040f25d8e3a7b9e1c2024c618cb6}
54 Infinity as used in minimization routines \hypertarget{energy__const_8h_a5064c29ab2d1e20c2304b3c67562774d}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!F\-O\-R\-B\-I\-D\-D\-E\-N@{F\-O\-R\-B\-I\-D\-D\-E\-N}}
55 \index{F\-O\-R\-B\-I\-D\-D\-E\-N@{F\-O\-R\-B\-I\-D\-D\-E\-N}!energy_const.h@{energy\-\_\-const.\-h}}
56 \subsubsection[{F\-O\-R\-B\-I\-D\-D\-E\-N}]{\setlength{\rightskip}{0pt plus 5cm}\#define F\-O\-R\-B\-I\-D\-D\-E\-N~9999}}\label{energy__const_8h_a5064c29ab2d1e20c2304b3c67562774d}
57 forbidden \hypertarget{energy__const_8h_a96a9822fa134450197dd454b1478a193}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!B\-O\-N\-U\-S@{B\-O\-N\-U\-S}}
58 \index{B\-O\-N\-U\-S@{B\-O\-N\-U\-S}!energy_const.h@{energy\-\_\-const.\-h}}
59 \subsubsection[{B\-O\-N\-U\-S}]{\setlength{\rightskip}{0pt plus 5cm}\#define B\-O\-N\-U\-S~10000}}\label{energy__const_8h_a96a9822fa134450197dd454b1478a193}
60 bonus contribution \hypertarget{energy__const_8h_a5e75221c779d618eab81e096f37e32ce}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!N\-B\-P\-A\-I\-R\-S@{N\-B\-P\-A\-I\-R\-S}}
61 \index{N\-B\-P\-A\-I\-R\-S@{N\-B\-P\-A\-I\-R\-S}!energy_const.h@{energy\-\_\-const.\-h}}
62 \subsubsection[{N\-B\-P\-A\-I\-R\-S}]{\setlength{\rightskip}{0pt plus 5cm}\#define N\-B\-P\-A\-I\-R\-S~7}}\label{energy__const_8h_a5e75221c779d618eab81e096f37e32ce}
63 The number of distinguishable base pairs \hypertarget{energy__const_8h_ae646250fd59311356c7e5722a81c3a96}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!T\-U\-R\-N@{T\-U\-R\-N}}
64 \index{T\-U\-R\-N@{T\-U\-R\-N}!energy_const.h@{energy\-\_\-const.\-h}}
65 \subsubsection[{T\-U\-R\-N}]{\setlength{\rightskip}{0pt plus 5cm}\#define T\-U\-R\-N~3}}\label{energy__const_8h_ae646250fd59311356c7e5722a81c3a96}
66 The minimum loop length \hypertarget{energy__const_8h_ad1bd6eabac419670ddd3c9ed82145988}{\index{energy\-\_\-const.\-h@{energy\-\_\-const.\-h}!M\-A\-X\-L\-O\-O\-P@{M\-A\-X\-L\-O\-O\-P}}
67 \index{M\-A\-X\-L\-O\-O\-P@{M\-A\-X\-L\-O\-O\-P}!energy_const.h@{energy\-\_\-const.\-h}}
68 \subsubsection[{M\-A\-X\-L\-O\-O\-P}]{\setlength{\rightskip}{0pt plus 5cm}\#define M\-A\-X\-L\-O\-O\-P~30}}\label{energy__const_8h_ad1bd6eabac419670ddd3c9ed82145988}
69 The maximum loop length