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

   1 \hypertarget{gquad_8h}{\section{/home/asherstnev/\-Projects/\-Java.projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/gquad.h File Reference}
   2 \label{gquad_8h}\index{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/gquad.\-h@{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/gquad.\-h}}
   3 }
   4
   5
   6 Various functions related to G-\/quadruplex computations.
   7
   8
   9 Include dependency graph for gquad.\-h\-:
  10 \nopagebreak
  11 \begin{figure}[H]
  12 \begin{center}
  13 \leavevmode
  14 \includegraphics[width=250pt]{gquad_8h__incl}
  15 \end{center}
  16 \end{figure}
  17 \subsection*{Functions}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 int $\ast$ \hyperlink{gquad_8h_a8b0784c14fa1208d0aebbebdc1318b7a}{get\-\_\-gquad\-\_\-matrix} (short $\ast$S, \hyperlink{structparamT}{param\-T} $\ast$P)
  21 \begin{DoxyCompactList}\small\item\em Get a triangular matrix prefilled with minimum free energy contributions of G-\/quadruplexes. \end{DoxyCompactList}\item
  22 int \hyperlink{gquad_8h_ae41763215b9c64d2a7b67f0df8a28078}{parse\-\_\-gquad} (const char $\ast$struc, int $\ast$L, int l\mbox{[}3\mbox{]})
  23 \item
  24 P\-R\-I\-V\-A\-T\-E int \hyperlink{gquad_8h_a54475a8eb898fa1e8af8ab5f5375f3be}{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop} (int c, int i, int j, int type, short $\ast$S, int $\ast$ggg, int $\ast$index, int $\ast$p, int $\ast$q, \hyperlink{structparamT}{param\-T} $\ast$P)
  25 \item
  26 P\-R\-I\-V\-A\-T\-E int \hyperlink{gquad_8h_a118ec7289f1936bd810be7fe50b98212}{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop\-\_\-\-L} (int c, int i, int j, int type, short $\ast$S, int $\ast$$\ast$ggg, int maxdist, int $\ast$p, int $\ast$q, \hyperlink{structparamT}{param\-T} $\ast$P)
  27 \end{DoxyCompactItemize}
  28
  29
  30 \subsection{Detailed Description}
  31 Various functions related to G-\/quadruplex computations.
  32
  33 \subsection{Function Documentation}
  34 \hypertarget{gquad_8h_a8b0784c14fa1208d0aebbebdc1318b7a}{\index{gquad.\-h@{gquad.\-h}!get\-\_\-gquad\-\_\-matrix@{get\-\_\-gquad\-\_\-matrix}}
  35 \index{get\-\_\-gquad\-\_\-matrix@{get\-\_\-gquad\-\_\-matrix}!gquad.h@{gquad.\-h}}
  36 \subsubsection[{get\-\_\-gquad\-\_\-matrix}]{\setlength{\rightskip}{0pt plus 5cm}int$\ast$ get\-\_\-gquad\-\_\-matrix (
  37 \begin{DoxyParamCaption}
  38 \item[{short $\ast$}]{S, }
  39 \item[{{\bf param\-T} $\ast$}]{P}
  40 \end{DoxyParamCaption}
  41 )}}\label{gquad_8h_a8b0784c14fa1208d0aebbebdc1318b7a}
  42
  43
  44 Get a triangular matrix prefilled with minimum free energy contributions of G-\/quadruplexes.
  45
  46 At each position ij in the matrix, the minimum free energy of any G-\/quadruplex delimited by i and j is stored. If no G-\/quadruplex formation is possible, the matrix element is set to I\-N\-F. Access the elements in the matrix via matrix\mbox{[}indx\mbox{[}j\mbox{]}+i\mbox{]}. To get the integer array indx see get\-\_\-jindx().
  47
  48 \begin{DoxySeeAlso}{See Also}
  49 get\-\_\-jindx(), encode\-\_\-sequence()
  50 \end{DoxySeeAlso}
  51
  52 \begin{DoxyParams}{Parameters}
  53 {\em S} & The encoded sequence \\
  54 \hline
  55 {\em P} & A pointer to the data structure containing the precomputed energy contributions \\
  56 \hline
  57 \end{DoxyParams}
  58 \begin{DoxyReturn}{Returns}
  59 A pointer to the G-\/quadruplex contribution matrix
  60 \end{DoxyReturn}
  61 \hypertarget{gquad_8h_ae41763215b9c64d2a7b67f0df8a28078}{\index{gquad.\-h@{gquad.\-h}!parse\-\_\-gquad@{parse\-\_\-gquad}}
  62 \index{parse\-\_\-gquad@{parse\-\_\-gquad}!gquad.h@{gquad.\-h}}
  63 \subsubsection[{parse\-\_\-gquad}]{\setlength{\rightskip}{0pt plus 5cm}int parse\-\_\-gquad (
  64 \begin{DoxyParamCaption}
  65 \item[{const char $\ast$}]{struc, }
  66 \item[{int $\ast$}]{L, }
  67 \item[{int}]{l\mbox{[}3\mbox{]}}
  68 \end{DoxyParamCaption}
  69 )}}\label{gquad_8h_ae41763215b9c64d2a7b67f0df8a28078}
  70 given a dot-\/bracket structure (possibly) containing gquads encoded by '+' signs, find first gquad, return end position or 0 if none found Upon return L and l\mbox{[}\mbox{]} contain the number of stacked layers, as well as the lengths of the linker regions. To parse a string with many gquads, call parse\-\_\-gquad repeatedly e.\-g. end1 = parse\-\_\-gquad(struc, \&\-L, l); ... ; end2 = parse\-\_\-gquad(struc+end1, \&L, l); end2+=end1; ... ; end3 = parse\-\_\-gquad(struc+end2, \&L, l); end3+=end2; ... ; \hypertarget{gquad_8h_a54475a8eb898fa1e8af8ab5f5375f3be}{\index{gquad.\-h@{gquad.\-h}!backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop@{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop}}
  71 \index{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop@{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop}!gquad.h@{gquad.\-h}}
  72 \subsubsection[{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop}]{\setlength{\rightskip}{0pt plus 5cm}P\-R\-I\-V\-A\-T\-E int backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop (
  73 \begin{DoxyParamCaption}
  74 \item[{int}]{c, }
  75 \item[{int}]{i, }
  76 \item[{int}]{j, }
  77 \item[{int}]{type, }
  78 \item[{short $\ast$}]{S, }
  79 \item[{int $\ast$}]{ggg, }
  80 \item[{int $\ast$}]{index, }
  81 \item[{int $\ast$}]{p, }
  82 \item[{int $\ast$}]{q, }
  83 \item[{{\bf param\-T} $\ast$}]{P}
  84 \end{DoxyParamCaption}
  85 )}}\label{gquad_8h_a54475a8eb898fa1e8af8ab5f5375f3be}
  86 backtrack an interior loop like enclosed g-\/quadruplex with closing pair (i,j)
  87
  88
  89 \begin{DoxyParams}{Parameters}
  90 {\em c} & The total contribution the loop should resemble \\
  91 \hline
  92 {\em i} & position i of enclosing pair \\
  93 \hline
  94 {\em j} & position j of enclosing pair \\
  95 \hline
  96 {\em type} & base pair type of enclosing pair (must be reverse type) \\
  97 \hline
  98 {\em S} & integer encoded sequence \\
  99 \hline
 100 {\em ggg} & triangular matrix containing g-\/quadruplex contributions \\
 101 \hline
 102 {\em index} & the index for accessing the triangular matrix \\
 103 \hline
 104 {\em p} & here the 5' position of the gquad is stored \\
 105 \hline
 106 {\em q} & here the 3' position of the gquad is stored \\
 107 \hline
 108 {\em P} & the datastructure containing the precalculated contibutions\\
 109 \hline
 110 \end{DoxyParams}
 111 \begin{DoxyReturn}{Returns}
 112 1 on success, 0 if no gquad found
 113 \end{DoxyReturn}
 114 \hypertarget{gquad_8h_a118ec7289f1936bd810be7fe50b98212}{\index{gquad.\-h@{gquad.\-h}!backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop\-\_\-\-L@{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop\-\_\-\-L}}
 115 \index{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop\-\_\-\-L@{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop\-\_\-\-L}!gquad.h@{gquad.\-h}}
 116 \subsubsection[{backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop\-\_\-\-L}]{\setlength{\rightskip}{0pt plus 5cm}P\-R\-I\-V\-A\-T\-E int backtrack\-\_\-\-G\-Quad\-\_\-\-Int\-Loop\-\_\-\-L (
 117 \begin{DoxyParamCaption}
 118 \item[{int}]{c, }
 119 \item[{int}]{i, }
 120 \item[{int}]{j, }
 121 \item[{int}]{type, }
 122 \item[{short $\ast$}]{S, }
 123 \item[{int $\ast$$\ast$}]{ggg, }
 124 \item[{int}]{maxdist, }
 125 \item[{int $\ast$}]{p, }
 126 \item[{int $\ast$}]{q, }
 127 \item[{{\bf param\-T} $\ast$}]{P}
 128 \end{DoxyParamCaption}
 129 )}}\label{gquad_8h_a118ec7289f1936bd810be7fe50b98212}
 130 backtrack an interior loop like enclosed g-\/quadruplex with closing pair (i,j) with underlying Lfold matrix
 131
 132
 133 \begin{DoxyParams}{Parameters}
 134 {\em c} & The total contribution the loop should resemble \\
 135 \hline
 136 {\em i} & position i of enclosing pair \\
 137 \hline
 138 {\em j} & position j of enclosing pair \\
 139 \hline
 140 {\em type} & base pair type of enclosing pair (must be reverse type) \\
 141 \hline
 142 {\em S} & integer encoded sequence \\
 143 \hline
 144 {\em ggg} & triangular matrix containing g-\/quadruplex contributions \\
 145 \hline
 146 {\em p} & here the 5' position of the gquad is stored \\
 147 \hline
 148 {\em q} & here the 3' position of the gquad is stored \\
 149 \hline
 150 {\em P} & the datastructure containing the precalculated contibutions\\
 151 \hline
 152 \end{DoxyParams}
 153 \begin{DoxyReturn}{Returns}
 154 1 on success, 0 if no gquad found
 155 \end{DoxyReturn}