binaries/src/ViennaRNA/doc/latex/findpath_8h.tex

   1 \hypertarget{findpath_8h}{\section{/home/asherstnev/\-Projects/\-Java.projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/findpath.h File Reference}
   2 \label{findpath_8h}\index{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/findpath.\-h@{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/findpath.\-h}}
   3 }
   4
   5
   6 Compute direct refolding paths between two secondary structures.
   7
   8
   9 Include dependency graph for findpath.\-h\-:
  10 \nopagebreak
  11 \begin{figure}[H]
  12 \begin{center}
  13 \leavevmode
  14 \includegraphics[width=250pt]{findpath_8h__incl}
  15 \end{center}
  16 \end{figure}
  17 \subsection*{Functions}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 int \hyperlink{findpath_8h_ad0e14268e309af773ecd1fce6244ee50}{find\-\_\-saddle} (const char $\ast$seq, const char $\ast$struc1, const char $\ast$struc2, int max)
  21 \begin{DoxyCompactList}\small\item\em Find energy of a saddle point between 2 structures (serch only direct path) \end{DoxyCompactList}\item
  22 \hyperlink{structpath__t}{path\-\_\-t} $\ast$ \hyperlink{findpath_8h_a0ff35d65c892a3403af937c00a867ef9}{get\-\_\-path} (const char $\ast$seq, const char $\ast$s1, const char $\ast$s2, int maxkeep)
  23 \begin{DoxyCompactList}\small\item\em Find refolding path between 2 structures (serch only direct path) \end{DoxyCompactList}\item
  24 void \hyperlink{findpath_8h_a326e6d1640bbfd035e3869f5f4c188f7}{free\-\_\-path} (\hyperlink{structpath__t}{path\-\_\-t} $\ast$path)
  25 \begin{DoxyCompactList}\small\item\em Free memory allocated by \hyperlink{findpath_8h_a0ff35d65c892a3403af937c00a867ef9}{get\-\_\-path()} function. \end{DoxyCompactList}\end{DoxyCompactItemize}
  26
  27
  28 \subsection{Detailed Description}
  29 Compute direct refolding paths between two secondary structures.
  30
  31 \subsection{Function Documentation}
  32 \hypertarget{findpath_8h_ad0e14268e309af773ecd1fce6244ee50}{\index{findpath.\-h@{findpath.\-h}!find\-\_\-saddle@{find\-\_\-saddle}}
  33 \index{find\-\_\-saddle@{find\-\_\-saddle}!findpath.h@{findpath.\-h}}
  34 \subsubsection[{find\-\_\-saddle}]{\setlength{\rightskip}{0pt plus 5cm}int find\-\_\-saddle (
  35 \begin{DoxyParamCaption}
  36 \item[{const char $\ast$}]{seq, }
  37 \item[{const char $\ast$}]{struc1, }
  38 \item[{const char $\ast$}]{struc2, }
  39 \item[{int}]{max}
  40 \end{DoxyParamCaption}
  41 )}}\label{findpath_8h_ad0e14268e309af773ecd1fce6244ee50}
  42
  43
  44 Find energy of a saddle point between 2 structures (serch only direct path)
  45
  46
  47 \begin{DoxyParams}{Parameters}
  48 {\em seq} & R\-N\-A sequence \\
  49 \hline
  50 {\em struc1} & A pointer to the character array where the first secondary structure in dot-\/bracket notation will be written to \\
  51 \hline
  52 {\em struc2} & A pointer to the character array where the second secondary structure in dot-\/bracket notation will be written to \\
  53 \hline
  54 {\em max} & integer how many strutures are being kept during the search \\
  55 \hline
  56 \end{DoxyParams}
  57 \begin{DoxyReturn}{Returns}
  58 the saddle energy in 10cal/mol
  59 \end{DoxyReturn}
  60 \hypertarget{findpath_8h_a0ff35d65c892a3403af937c00a867ef9}{\index{findpath.\-h@{findpath.\-h}!get\-\_\-path@{get\-\_\-path}}
  61 \index{get\-\_\-path@{get\-\_\-path}!findpath.h@{findpath.\-h}}
  62 \subsubsection[{get\-\_\-path}]{\setlength{\rightskip}{0pt plus 5cm}{\bf path\-\_\-t}$\ast$ get\-\_\-path (
  63 \begin{DoxyParamCaption}
  64 \item[{const char $\ast$}]{seq, }
  65 \item[{const char $\ast$}]{s1, }
  66 \item[{const char $\ast$}]{s2, }
  67 \item[{int}]{maxkeep}
  68 \end{DoxyParamCaption}
  69 )}}\label{findpath_8h_a0ff35d65c892a3403af937c00a867ef9}
  70
  71
  72 Find refolding path between 2 structures (serch only direct path)
  73
  74
  75 \begin{DoxyParams}{Parameters}
  76 {\em seq} & R\-N\-A sequence \\
  77 \hline
  78 {\em s1} & A pointer to the character array where the first secondary structure in dot-\/bracket notation will be written to \\
  79 \hline
  80 {\em s2} & A pointer to the character array where the second secondary structure in dot-\/bracket notation will be written to \\
  81 \hline
  82 {\em maxkeep} & integer how many strutures are being kept during the search \\
  83 \hline
  84 \end{DoxyParams}
  85 \begin{DoxyReturn}{Returns}
  86 direct refolding path between two structures
  87 \end{DoxyReturn}
  88 \hypertarget{findpath_8h_a326e6d1640bbfd035e3869f5f4c188f7}{\index{findpath.\-h@{findpath.\-h}!free\-\_\-path@{free\-\_\-path}}
  89 \index{free\-\_\-path@{free\-\_\-path}!findpath.h@{findpath.\-h}}
  90 \subsubsection[{free\-\_\-path}]{\setlength{\rightskip}{0pt plus 5cm}void free\-\_\-path (
  91 \begin{DoxyParamCaption}
  92 \item[{{\bf path\-\_\-t} $\ast$}]{path}
  93 \end{DoxyParamCaption}
  94 )}}\label{findpath_8h_a326e6d1640bbfd035e3869f5f4c188f7}
  95
  96
  97 Free memory allocated by \hyperlink{findpath_8h_a0ff35d65c892a3403af937c00a867ef9}{get\-\_\-path()} function.
  98
  99
 100 \begin{DoxyParams}{Parameters}
 101 {\em path} & pointer to memory to be freed \\
 102 \hline
 103 \end{DoxyParams}