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

   1 \hypertarget{group__mfe__cofold}{\section{M\-F\-E Structures of two hybridized Sequences}
   2 \label{group__mfe__cofold}\index{M\-F\-E Structures of two hybridized Sequences@{M\-F\-E Structures of two hybridized Sequences}}
   3 }
   4 Collaboration diagram for M\-F\-E Structures of two hybridized Sequences\-:
   5 \nopagebreak
   6 \begin{figure}[H]
   7 \begin{center}
   8 \leavevmode
   9 \includegraphics[width=350pt]{group__mfe__cofold}
  10 \end{center}
  11 \end{figure}
  12 \subsection*{Files}
  13 \begin{DoxyCompactItemize}
  14 \item
  15 file \hyperlink{cofold_8h}{cofold.\-h}
  16 \begin{DoxyCompactList}\small\item\em M\-F\-E version of cofolding routines. \end{DoxyCompactList}\end{DoxyCompactItemize}
  17 \subsection*{Functions}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 float \hyperlink{group__mfe__cofold_gabc8517f22cfe70595ee81fc837910d52}{cofold} (const char $\ast$sequence, char $\ast$structure)
  21 \begin{DoxyCompactList}\small\item\em Compute the minimum free energy of two interacting R\-N\-A molecules. \end{DoxyCompactList}\item
  22 \hypertarget{group__mfe__cofold_gafe430060533f14b11fc611f60b3f1f6f}{float \hyperlink{group__mfe__cofold_gafe430060533f14b11fc611f60b3f1f6f}{cofold\-\_\-par} (const char $\ast$string, char $\ast$structure, \hyperlink{structparamT}{param\-T} $\ast$parameters, int is\-\_\-constrained)}\label{group__mfe__cofold_gafe430060533f14b11fc611f60b3f1f6f}
  23
  24 \begin{DoxyCompactList}\small\item\em Compute the minimum free energy of two interacting R\-N\-A molecules. \end{DoxyCompactList}\item
  25 \hypertarget{group__mfe__cofold_gaafb33d7473eb9af9d1b168ca8761c41a}{void \hyperlink{group__mfe__cofold_gaafb33d7473eb9af9d1b168ca8761c41a}{free\-\_\-co\-\_\-arrays} (void)}\label{group__mfe__cofold_gaafb33d7473eb9af9d1b168ca8761c41a}
  26
  27 \begin{DoxyCompactList}\small\item\em Free memory occupied by \hyperlink{group__mfe__cofold_gabc8517f22cfe70595ee81fc837910d52}{cofold()} \end{DoxyCompactList}\item
  28 \hypertarget{group__mfe__cofold_ga4fcbf34e77b99bfbb2333d2ab0c41a57}{void \hyperlink{group__mfe__cofold_ga4fcbf34e77b99bfbb2333d2ab0c41a57}{update\-\_\-cofold\-\_\-params} (void)}\label{group__mfe__cofold_ga4fcbf34e77b99bfbb2333d2ab0c41a57}
  29
  30 \begin{DoxyCompactList}\small\item\em Recalculate parameters. \end{DoxyCompactList}\item
  31 void \hyperlink{group__mfe__cofold_ga5f5bf4df35d0554f6ace9579f8744c48}{export\-\_\-cofold\-\_\-arrays\-\_\-gq} (int $\ast$$\ast$f5\-\_\-p, int $\ast$$\ast$c\-\_\-p, int $\ast$$\ast$f\-M\-L\-\_\-p, int $\ast$$\ast$f\-M1\-\_\-p, int $\ast$$\ast$fc\-\_\-p, int $\ast$$\ast$ggg\-\_\-p, int $\ast$$\ast$indx\-\_\-p, char $\ast$$\ast$ptype\-\_\-p)
  32 \begin{DoxyCompactList}\small\item\em Export the arrays of partition function cofold (with gquadruplex support) \end{DoxyCompactList}\item
  33 void \hyperlink{group__mfe__cofold_ga5cb6b59983f1f74ccc00b9b9c4e84482}{export\-\_\-cofold\-\_\-arrays} (int $\ast$$\ast$f5\-\_\-p, int $\ast$$\ast$c\-\_\-p, int $\ast$$\ast$f\-M\-L\-\_\-p, int $\ast$$\ast$f\-M1\-\_\-p, int $\ast$$\ast$fc\-\_\-p, int $\ast$$\ast$indx\-\_\-p, char $\ast$$\ast$ptype\-\_\-p)
  34 \begin{DoxyCompactList}\small\item\em Export the arrays of partition function cofold. \end{DoxyCompactList}\end{DoxyCompactItemize}
  35
  36
  37 \subsection{Detailed Description}
  38
  39
  40 \subsection{Function Documentation}
  41 \hypertarget{group__mfe__cofold_gabc8517f22cfe70595ee81fc837910d52}{\index{M\-F\-E Structures of two hybridized Sequences@{M\-F\-E Structures of two hybridized Sequences}!cofold@{cofold}}
  42 \index{cofold@{cofold}!MFE Structures of two hybridized Sequences@{M\-F\-E Structures of two hybridized Sequences}}
  43 \subsubsection[{cofold}]{\setlength{\rightskip}{0pt plus 5cm}float cofold (
  44 \begin{DoxyParamCaption}
  45 \item[{const char $\ast$}]{sequence, }
  46 \item[{char $\ast$}]{structure}
  47 \end{DoxyParamCaption}
  48 )}}\label{group__mfe__cofold_gabc8517f22cfe70595ee81fc837910d52}
  49
  50
  51 Compute the minimum free energy of two interacting R\-N\-A molecules.
  52
  53 The code is analog to the \hyperlink{group__mfe__fold_gaadafcb0f140795ae62e5ca027e335a9b}{fold()} function. If \hyperlink{fold__vars_8h_ab9b2c3a37a5516614c06d0ab54b97cda}{cut\-\_\-point} ==-\/1 results should be the same as with \hyperlink{group__mfe__fold_gaadafcb0f140795ae62e5ca027e335a9b}{fold()}.
  54
  55
  56 \begin{DoxyParams}{Parameters}
  57 {\em sequence} & The two sequences concatenated \\
  58 \hline
  59 {\em structure} & Will hold the barcket dot structure of the dimer molecule \\
  60 \hline
  61 \end{DoxyParams}
  62 \begin{DoxyReturn}{Returns}
  63 minimum free energy of the structure
  64 \end{DoxyReturn}
  65 \hypertarget{group__mfe__cofold_ga5f5bf4df35d0554f6ace9579f8744c48}{\index{M\-F\-E Structures of two hybridized Sequences@{M\-F\-E Structures of two hybridized Sequences}!export\-\_\-cofold\-\_\-arrays\-\_\-gq@{export\-\_\-cofold\-\_\-arrays\-\_\-gq}}
  66 \index{export\-\_\-cofold\-\_\-arrays\-\_\-gq@{export\-\_\-cofold\-\_\-arrays\-\_\-gq}!MFE Structures of two hybridized Sequences@{M\-F\-E Structures of two hybridized Sequences}}
  67 \subsubsection[{export\-\_\-cofold\-\_\-arrays\-\_\-gq}]{\setlength{\rightskip}{0pt plus 5cm}void export\-\_\-cofold\-\_\-arrays\-\_\-gq (
  68 \begin{DoxyParamCaption}
  69 \item[{int $\ast$$\ast$}]{f5\-\_\-p, }
  70 \item[{int $\ast$$\ast$}]{c\-\_\-p, }
  71 \item[{int $\ast$$\ast$}]{f\-M\-L\-\_\-p, }
  72 \item[{int $\ast$$\ast$}]{f\-M1\-\_\-p, }
  73 \item[{int $\ast$$\ast$}]{fc\-\_\-p, }
  74 \item[{int $\ast$$\ast$}]{ggg\-\_\-p, }
  75 \item[{int $\ast$$\ast$}]{indx\-\_\-p, }
  76 \item[{char $\ast$$\ast$}]{ptype\-\_\-p}
  77 \end{DoxyParamCaption}
  78 )}}\label{group__mfe__cofold_ga5f5bf4df35d0554f6ace9579f8744c48}
  79
  80
  81 Export the arrays of partition function cofold (with gquadruplex support)
  82
  83 Export the cofold arrays for use e.\-g. in the concentration Computations or suboptimal secondary structure backtracking
  84
  85
  86 \begin{DoxyParams}{Parameters}
  87 {\em f5\-\_\-p} & A pointer to the 'f5' array, i.\-e. array conatining best free energy in interval \mbox{[}1,j\mbox{]} \\
  88 \hline
  89 {\em c\-\_\-p} & A pointer to the 'c' array, i.\-e. array containing best free energy in interval \mbox{[}i,j\mbox{]} given that i pairs with j \\
  90 \hline
  91 {\em f\-M\-L\-\_\-p} & A pointer to the 'M' array, i.\-e. array containing best free energy in interval \mbox{[}i,j\mbox{]} for any multiloop segment with at least one stem \\
  92 \hline
  93 {\em f\-M1\-\_\-p} & A pointer to the 'M1' array, i.\-e. array containing best free energy in interval \mbox{[}i,j\mbox{]} for multiloop segment with exactly one stem \\
  94 \hline
  95 {\em fc\-\_\-p} & A pointer to the 'fc' array, i.\-e. array ... \\
  96 \hline
  97 {\em ggg\-\_\-p} & A pointer to the 'ggg' array, i.\-e. array containing best free energy of a gquadruplex delimited by \mbox{[}i,j\mbox{]} \\
  98 \hline
  99 {\em indx\-\_\-p} & A pointer to the indexing array used for accessing the energy matrices \\
 100 \hline
 101 {\em ptype\-\_\-p} & A pointer to the ptype array containing the base pair types for each possibility (i,j) \\
 102 \hline
 103 \end{DoxyParams}
 104 \hypertarget{group__mfe__cofold_ga5cb6b59983f1f74ccc00b9b9c4e84482}{\index{M\-F\-E Structures of two hybridized Sequences@{M\-F\-E Structures of two hybridized Sequences}!export\-\_\-cofold\-\_\-arrays@{export\-\_\-cofold\-\_\-arrays}}
 105 \index{export\-\_\-cofold\-\_\-arrays@{export\-\_\-cofold\-\_\-arrays}!MFE Structures of two hybridized Sequences@{M\-F\-E Structures of two hybridized Sequences}}
 106 \subsubsection[{export\-\_\-cofold\-\_\-arrays}]{\setlength{\rightskip}{0pt plus 5cm}void export\-\_\-cofold\-\_\-arrays (
 107 \begin{DoxyParamCaption}
 108 \item[{int $\ast$$\ast$}]{f5\-\_\-p, }
 109 \item[{int $\ast$$\ast$}]{c\-\_\-p, }
 110 \item[{int $\ast$$\ast$}]{f\-M\-L\-\_\-p, }
 111 \item[{int $\ast$$\ast$}]{f\-M1\-\_\-p, }
 112 \item[{int $\ast$$\ast$}]{fc\-\_\-p, }
 113 \item[{int $\ast$$\ast$}]{indx\-\_\-p, }
 114 \item[{char $\ast$$\ast$}]{ptype\-\_\-p}
 115 \end{DoxyParamCaption}
 116 )}}\label{group__mfe__cofold_ga5cb6b59983f1f74ccc00b9b9c4e84482}
 117
 118
 119 Export the arrays of partition function cofold.
 120
 121 Export the cofold arrays for use e.\-g. in the concentration Computations or suboptimal secondary structure backtracking
 122
 123
 124 \begin{DoxyParams}{Parameters}
 125 {\em f5\-\_\-p} & A pointer to the 'f5' array, i.\-e. array conatining best free energy in interval \mbox{[}1,j\mbox{]} \\
 126 \hline
 127 {\em c\-\_\-p} & A pointer to the 'c' array, i.\-e. array containing best free energy in interval \mbox{[}i,j\mbox{]} given that i pairs with j \\
 128 \hline
 129 {\em f\-M\-L\-\_\-p} & A pointer to the 'M' array, i.\-e. array containing best free energy in interval \mbox{[}i,j\mbox{]} for any multiloop segment with at least one stem \\
 130 \hline
 131 {\em f\-M1\-\_\-p} & A pointer to the 'M1' array, i.\-e. array containing best free energy in interval \mbox{[}i,j\mbox{]} for multiloop segment with exactly one stem \\
 132 \hline
 133 {\em fc\-\_\-p} & A pointer to the 'fc' array, i.\-e. array ... \\
 134 \hline
 135 {\em indx\-\_\-p} & A pointer to the indexing array used for accessing the energy matrices \\
 136 \hline
 137 {\em ptype\-\_\-p} & A pointer to the ptype array containing the base pair types for each possibility (i,j) \\
 138 \hline
 139 \end{DoxyParams}