Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / move__set_8h_source.tex
1 \hypertarget{move__set_8h}{\section{move\-\_\-set.\-h}
2 \label{move__set_8h}\index{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/move\-\_\-set.\-h@{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/move\-\_\-set.\-h}}
3 }
4
5 \begin{DoxyCode}
6 00001 \textcolor{preprocessor}{#ifndef \_\_MOVE\_SET\_H}
7 00002 \textcolor{preprocessor}{}\textcolor{preprocessor}{#define \_\_MOVE\_SET\_H}
8 00003 \textcolor{preprocessor}{}
9 00004 \textcolor{comment}{/* used data structure*/}
10 \hypertarget{move__set_8h_source_l00005}{}\hyperlink{structstruct__en}{00005} \textcolor{keyword}{typedef} \textcolor{keyword}{struct }\_struct\_en\{
11 00006   \textcolor{keywordtype}{int} energy;        \textcolor{comment}{/* energy in 10kcal/mol*/}
12 00007   \textcolor{keywordtype}{short} *structure;  \textcolor{comment}{/* structure in energy\_of\_move format*/}
13 00008 \} \hyperlink{structstruct__en}{struct\_en};
14 00009 
15 00010 \textcolor{comment}{/* prints structure*/}
16 00011 \textcolor{keywordtype}{void} print\_stren(FILE *out, \hyperlink{structstruct__en}{struct\_en} *str);
17 00012 \textcolor{keywordtype}{void} print\_str(FILE *out, \textcolor{keywordtype}{short} *str);
18 00013 
19 00014 \textcolor{comment}{/* copying functions*/}
20 00015 \textcolor{keywordtype}{void} copy\_arr(\textcolor{keywordtype}{short} *dest, \textcolor{keywordtype}{short} *src); \textcolor{comment}{/*just copy*/}
21 00016 \textcolor{keywordtype}{short} *allocopy(\textcolor{keywordtype}{short} *src);            \textcolor{comment}{/*copy and make space*/}
22 00017 
23 00018 \textcolor{comment}{/* walking methods (verbose\_lvl 0-2, shifts = use shift moves? noLP = no lone pairs? (not compatible with
24        shifts))}
25 00019 \textcolor{comment}{    input:    seq - sequence}
26 00020 \textcolor{comment}{              ptable - structure encoded with make\_pair\_table() from pair\_mat.h}
27 00021 \textcolor{comment}{              s, s1 - sequence encoded with encode\_sequence from pair\_mat.h}
28 00022 \textcolor{comment}{    methods:  deepest - lowest energy structure is used}
29 00023 \textcolor{comment}{              first - first found lower energy structure is used}
30 00024 \textcolor{comment}{              rand - random lower energy structure is used}
31 00025 \textcolor{comment}{    returns local minima structure in ptable and its energy in 10kcal/mol as output */}
32 00026 
33 00027 \textcolor{keywordtype}{int} move\_deepest( \textcolor{keywordtype}{char} *seq,
34 00028                   \textcolor{keywordtype}{short} *ptable,
35 00029                   \textcolor{keywordtype}{short} *s,
36 00030                   \textcolor{keywordtype}{short} *s1,
37 00031                   \textcolor{keywordtype}{int} verbosity\_level,
38 00032                   \textcolor{keywordtype}{int} shifts,
39 00033                   \textcolor{keywordtype}{int} noLP);
40 00034 \textcolor{keywordtype}{int} move\_first( \textcolor{keywordtype}{char} *seq,
41 00035                 \textcolor{keywordtype}{short} *ptable,
42 00036                 \textcolor{keywordtype}{short} *s,
43 00037                 \textcolor{keywordtype}{short} *s1,
44 00038                 \textcolor{keywordtype}{int} verbosity\_level,
45 00039                 \textcolor{keywordtype}{int} shifts,
46 00040                 \textcolor{keywordtype}{int} noLP);
47 00041 \textcolor{keywordtype}{int} move\_rand(  \textcolor{keywordtype}{char} *seq,
48 00042                 \textcolor{keywordtype}{short} *ptable,
49 00043                 \textcolor{keywordtype}{short} *s,
50 00044                 \textcolor{keywordtype}{short} *s1,
51 00045                 \textcolor{keywordtype}{int} verbosity\_level);
52 00046 
53 00047 
54 00048 \textcolor{comment}{/* browse\_neighbours and do funct function on each of them (used mainly for user specified flooding)}
55 00049 \textcolor{comment}{    input:    seq - sequence}
56 00050 \textcolor{comment}{              ptable - structure encoded with make\_pair\_table() from pair\_mat.h}
57 00051 \textcolor{comment}{              s, s1 - sequence encoded with encode\_sequence from pair\_mat.h}
58 00052 \textcolor{comment}{              funct - function (moved structure, current structure (or altered by funct)) to do with every
59        structure in neigbourhood}
60 00053 \textcolor{comment}{    returns energy of the structure funct sets as second argument*/}
61 00054 \textcolor{keywordtype}{int} browse\_neighs( \textcolor{keywordtype}{char} *seq,
62 00055                    \textcolor{keywordtype}{short} *ptable,
63 00056                    \textcolor{keywordtype}{short} *s,
64 00057                    \textcolor{keywordtype}{short} *s1,
65 00058                    \textcolor{keywordtype}{int} verbosity\_level,
66 00059                    \textcolor{keywordtype}{int} shifts,
67 00060                    \textcolor{keywordtype}{int} noLP,
68 00061                    \textcolor{keywordtype}{int} (*funct) (\hyperlink{structstruct__en}{struct\_en}*, \hyperlink{structstruct__en}{struct\_en}*));
69 00062 
70 00063 \textcolor{preprocessor}{#endif}
71 \end{DoxyCode}